Download the PHP package vormkracht10/wefact-php without Composer
On this page you can find all versions of the php package vormkracht10/wefact-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vormkracht10/wefact-php
More information about vormkracht10/wefact-php
Files in vormkracht10/wefact-php
Package wefact-php
Short Description PHP package to provide a fluent interface to communicate with WeFact
License MIT
Homepage https://github.com/vormkracht10/wefact-php
Informations about the package wefact-php
PHP package for WeFact
This package provides a fluent interface to communicate with the WeFact API. For the full documentation of the WeFact API, please visit https://www.wefact.nl/api/.
Table of Contents
- [Minimum requirements](#minimum-requirements) - [Installation](#installation) - [Usage](#usage) - [Available methods](#available-methods) - [Creditor](#creditor) - [List creditors](#list-creditors) - [Create creditor](#create-creditor) - [Update creditor](#update-creditor) - [Show creditor](#show-creditor) - [Delete creditor](#delete-creditor) - [Credit Invoice](#credit-invoice) - [List credit invoices](#list-credit-invoices) - [Create credit invoice](#create-credit-invoice) - [Update credit invoice](#update-credit-invoice) - [Show credit invoice](#show-credit-invoice) - [Delete credit invoice](#delete-credit-invoice) - [Debtor](#debtor) - [List debtors](#list-debtors) - [Create debtor](#create-debtor) - [Update debtor](#update-debtor) - [Show debtor](#show-debtor) - [Group](#group) - [List groups](#list-groups) - [Create group](#create-group) - [Update group](#update-group) - [Show group](#show-group) - [Delete group](#delete-group) - [Invoice](#invoice) - [List invoices](#list-invoices) - [Create invoice](#create-invoice) - [Update invoice](#update-invoice) - [Show invoice](#show-invoice) - [Delete invoice](#delete-invoice) - [Credit](#credit) - [Part payment](#part-payment) - [Mark as paid](#mark-as-paid) - [Mark as unpaid](#mark-as-unpaid) - [Send by email](#send-by-email) - [Send reminder by email](#send-reminder-by-email) - [Send summation by email](#send-summation-by-email) - [Download](#download) - [Block](#block) - [Unblock](#unblock) - [Schedule](#schedule) - [Cancel schedule](#cancel-schedule) - [Pause payment process](#pause-payment-process) - [Reactivate payment process](#reactivate-payment-process) - [Sort lines](#sort-lines) - [Add invoice line](#add-invoice-line) - [Delete invoice line](#delete-invoice-line) - [Add attachment](#add-attachment) - [Delete attachment](#delete-attachment) - [Download attachment](#download-attachment) - [Product](#product) - [List products](#list-products) - [Create product](#create-product) - [Update product](#update-product) - [Show product](#show-product) - [Delete product](#delete-product) - [Settings](#settings) - [List settings](#list-settings) - [Settings - Cost Category](#settings---cost-category) - [List cost categories](#list-cost-categories) - [Create cost category](#create-cost-category) - [Update cost category](#update-cost-category) - [Show cost category](#show-cost-category) - [Delete cost category](#delete-cost-category) - [Subscription](#subscription) - [List subscriptions](#list-subscriptions) - [Create subscription](#create-subscription) - [Update subscription](#update-subscription) - [Show subscription](#show-subscription) - [Terminate subscription](#terminate-subscription) - [Testing](#testing) - [Changelog](#changelog) - [Contributing](#contributing) - [Security Vulnerabilities](#security-vulnerabilities) - [Credits](#credits) - [License](#license)Minimum requirements
- PHP 8.1 or higher
- Guzzle 7.0 or higher
Installation
You can install the package via composer:
Usage
Then you can use the package like this:
Available methods
Creditor
List creditors
Create creditor
Required parameters: CompanyName
or SurName
.
Update creditor
Required parameter: Identifier
or CreditorCode
.
Show creditor
Required parameter: Identifier
or CreditorCode
.
Delete creditor
Required parameter: Identifier
or CreditorCode
.
Credit Invoice
List credit invoices
Create credit invoice
Required parameters: InvoiceCode
, Creditor
or CreditorCode
and InvoiceLines
.
Update credit invoice
Required parameter: Identifier
or CreditInvoiceCode
.
Show credit invoice
Required parameter: Identifier
or CreditInvoiceCode
.
Delete credit invoice
Required parameter: Identifier
or CreditInvoiceCode
.
Debtor
List debtors
You can also search for debtors:
Create debtor
Required parameters: CompanyName
or SurName
.
Update debtor
Required parameter: Identifier
or DebtorCode
, CompanyName
or SurName
.
Show debtor
Required parameter: Identifier
or DebtorCode
.
Group
List groups
Required parameter: Type
.
Create group
Required parameters: Type
and GroupName
.
Update group
Required parameter: Identifier
.
Show group
Required parameter: Identifier
.
Delete group
Required parameter: Identifier
.
Invoice
List invoices
Create invoice
Required parameters: DebtorCode
or DebtorCode
and InvoiceLines
.
Update invoice
Required parameter: Identifier
or InvoiceCode
.
Show invoice
Required parameter: Identifier
or InvoiceCode
.
Delete invoice
Required parameter: Identifier
or InvoiceCode
.
Credit
Required parameter: Identifier
or InvoiceCode
.
Part payment
Required parameter: Identifier
or InvoiceCode
.
Mark invoice as paid
Required parameter: Identifier
or InvoiceCode
.
Mark invoice as unpaid
Required parameter: Identifier
or InvoiceCode
.
Send by email
Required parameter: Identifier
or InvoiceCode
.
Send reminder by email
Required parameter: Identifier
or InvoiceCode
.
Download
Required parameter: Identifier
or InvoiceCode
.
Block
Required parameter: Identifier
or InvoiceCode
.
Unblock
Required parameter: Identifier
or InvoiceCode
.
Schedule
Required parameter: Identifier
or InvoiceCode
and ScheduledAt
.
Cancel schedule
Required parameter: Identifier
or InvoiceCode
.
Pause payment process
Required parameter: Identifier
or InvoiceCode
.
Reactivate payment process
Required parameter: Identifier
or InvoiceCode
.
Sort lines
Required parameter: Identifier
or InvoiceCode
and InvoiceLines Identifier
.
Add invoice line
Required parameter: Identifier
or InvoiceCode
and InvoiceLines
.
Delete invoice line
Required parameter: Identifier
or InvoiceCode
and InvoiceLines Identifier
.
Add attachment
Required parameter: ReferenceIdentifier
or InvoiceCode
, Tyoe
, Filename
and Base64
.
Delete attachment
Required parameter: Identifier
or Filename
, ReferenceIdentifier
or InvoiceCode
and Type
.
Download attachment
Required parameter: Identifier
or Filename
, ReferenceIdentifier
or InvoiceCode
and Type
.
Product
List products
Create product
Required parameters: ProductName
, ProductKeyPhrase
and PriceExcl
.
Update product
Required parameter: Identifier
or ProductCode
.
Show product
Required parameter: Identifier
Delete product
Required parameter: Identifier
or ProductCode
.
Settings
List settings
Settings - Cost Category
List cost categories
Create cost category
Required parameters: Title
.
Update cost category
Required parameter: Identifier
.
Show cost category
Required parameter: Identifier
.
Delete cost category
Required parameter: Identifier
.
Subscription
List subscriptions
Create subscription
Required parameters: Debtor
or DebtorCode
and ProductCode
. When ProductCode
is empty, Description
, PriceExcl
and Periodic
are required.
Please note: You can pass either the
TerminateAfter
or theTerminationDate
, not both. TheTerminateAfter
includes the number of times the subscription has been billed in the past.
Update subscription
Required parameter: Identifier
.
Please note: You can pass either the
TerminateAfter
or theTerminationDate
, not both. TheTerminateAfter
includes the number of times the subscription has been billed in the past.
Show subscription
Required parameter: Identifier
.
Terminate subscription
Required parameter: Identifier
.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Bas van Dinther
- All Contributors
License
The MIT License (MIT). Please see License File for more information.