https://github.com/vormkracht10/wefact-php
PHP package to provide a fluent interface to communicate with WeFact
https://github.com/vormkracht10/wefact-php
api php wefact
Last synced: about 1 month ago
JSON representation
PHP package to provide a fluent interface to communicate with WeFact
- Host: GitHub
- URL: https://github.com/vormkracht10/wefact-php
- Owner: vormkracht10
- License: mit
- Created: 2023-06-07T07:54:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T00:01:44.000Z (4 months ago)
- Last Synced: 2025-04-06T01:41:19.551Z (about 2 months ago)
- Topics: api, php, wefact
- Language: PHP
- Homepage: https://vormkracht10.nl
- Size: 84 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# PHP package for WeFact
[](https://github.com/vormkracht10/wefact-php/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/vormkracht10/wefact-php)
[](https://packagist.org/packages/vormkracht10/wefact-php)
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/](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:
```bash
composer require vormkracht10/wefact-php
```
## Usage
Then you can use the package like this:
```php
$weFact = new \Vormkracht10\WeFact\WeFact('your-api-key');
$response = $weFact->invoices()->list();
// or use listAll to call the show method for each item
$response = $weFact->invoices()->listAll();
if (isset($response['invoices'])) {
print_r($response['invoices']);
}
```
## Available methods
### Creditor
#### List creditors
```php
$response = $weFact->creditors()->list();
// or use listAll to call the show method for each item
$response = $weFact->creditors()->listAll();
if (isset($response['creditors'])) {
print_r($response['creditors']);
}
```
#### Create creditor
Required parameters: `CompanyName` or `SurName`.
```php
$response = $weFact->creditors()->create([
'CompanyName' => 'Your company name',
]);
if ($result['status'] == 'success') {
print_r($response['company']);
}
```
#### Update creditor
Required parameter: `Identifier` or `CreditorCode`.
```php
$result = $weFact->creditors()->edit([
'Identifier' => $creditorId,
'CompanyName' => 'Your company name',
]);
if ($result['status'] == 'error') {
// Something went wrong
print_r($result['errors']);
}
```
#### Show creditor
Required parameter: `Identifier` or `CreditorCode`.
```php
$weFact->creditors()->show(['Identifier' => $creditorId]);
// or
$weFact->creditors()->show(['CreditorCode' => $creditorCode]);
```
#### Delete creditor
Required parameter: `Identifier` or `CreditorCode`.
```php
$weFact->creditors()->delete(['Identifier' => $creditorId]);
// or
$weFact->creditors()->delete(['CreditorCode' => $creditorCode]);
```
### Credit Invoice
#### List credit invoices
```php
$weFact->creditInvoices()->list();
// or use listAll to call the show method for each item
$response = $weFact->creditInvoices()->listAll();
```
#### Create credit invoice
Required parameters: `InvoiceCode`, `Creditor` or `CreditorCode` and `InvoiceLines`.
```php
$weFact->creditInvoices()->create([
'InvoiceCode' => 'your-invoice-code',
'CreditorCode' => 'CD10001'
'InvoiceLines' => [
[
'Description' => 'Your description',
'PriceExcl' => 10,
],
],
])
```
#### Update credit invoice
Required parameter: `Identifier` or `CreditInvoiceCode`.
```php
$weFact->creditInvoices()->edit([
'Identifier' => $creditInvoiceId,
'Comment' => 'Your comment',
])
```
#### Show credit invoice
Required parameter: `Identifier` or `CreditInvoiceCode`.
```php
$weFact->creditInvoices()->show(['Identifier' => $creditInvoiceId]);
// or
$weFact->creditInvoices()->show(['CreditInvoiceCode' => $creditInvoiceCode]);
```
#### Delete credit invoice
Required parameter: `Identifier` or `CreditInvoiceCode`.
```php
$weFact->creditInvoices()->delete(['Identifier' => $creditInvoiceId]);
// or
$weFact->creditInvoices()->delete(['CreditInvoiceCode' => $creditInvoiceCode]);
```
### Debtor
#### List debtors
```php
$weFact->debtors()->list();
// or use listAll to call the show method for each item
$response = $weFact->debtors()->listAll();
```
You can also search for debtors:
```php
$weFact->debtors()->list([
'searchat' => 'EmailAddress',
'searchfor' => '[email protected]'
]);
```
#### Create debtor
Required parameters: `CompanyName` or `SurName`.
```php
$weFact->debtors()->create([
'CompanyName' => 'Your company name',
])
```
#### Update debtor
Required parameter: `Identifier` or `DebtorCode`, `CompanyName` or `SurName`.
```php
$weFact->debtors()->edit([
'Identifier' => $debtorId,
'CompanyName' => 'Your company name',
])
```
#### Show debtor
Required parameter: `Identifier` or `DebtorCode`.
```php
$weFact->debtors()->show(['Identifier' => $debtorId]);
// or
$weFact->debtors()->show(['DebtorCode' => $debtorCode]);
```
### Group
#### List groups
Required parameter: `Type`.
```php
$weFact->groups()->list([
'type' => 'debtor',
]);
```
#### Create group
Required parameters: `Type` and `GroupName`.
```php
$weFact->groups()->create([
'Type' => 'debtor',
'GroupName' => 'Your group name',
])
```
#### Update group
Required parameter: `Identifier`.
```php
$weFact->groups()->edit([
'Identifier' => $groupId,
'GroupName' => 'Your group name',
])
```
#### Show group
Required parameter: `Identifier`.
```php
$weFact->groups()->show(['Identifier' => $groupId]);
```
#### Delete group
Required parameter: `Identifier`.
```php
$weFact->groups()->delete(['Identifier' => $groupId]);
```
### Invoice
#### List invoices
```php
$weFact->invoices()->list();
// or use listAll to call the show method for each item
$response = $weFact->invoices()->listAll();
```
#### Create invoice
Required parameters: `DebtorCode` or `DebtorCode` and `InvoiceLines`.
```php
$weFact->invoices()->create([
'DebtorCode' => 'DB10000',
'InvoiceLines' => [
[
'Number' => 1,
'ProductCode' => 'P0001'
]
],
[
'Description' => 'Your product description',
'PriceExcl' => 100
]
])
```
#### Update invoice
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->edit([
'Identifier' => $invoiceId,
'InvoiceLines' => [
[
'Number' => 1,
'ProductCode' => 'P0001'
]
],
[
'Description' => 'Your product description',
'PriceExcl' => 100
]
])
```
#### Show invoice
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->show(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->show(['InvoiceCode' => $invoiceCode]);
```
#### Delete invoice
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->delete(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->delete(['InvoiceCode' => $invoiceCode]);
```
#### Credit
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->credit(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->credit(['InvoiceCode' => $invoiceCode]);
```
#### Part payment
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->partPayment(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->partPayment(['InvoiceCode' => $invoiceCode]);
```
#### Mark invoice as paid
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->markAsPaid(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->markAsPaid(['InvoiceCode' => $invoiceCode]);
```
#### Mark invoice as unpaid
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->markAsUnpaid(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->markAsUnpaid(['InvoiceCode' => $invoiceCode]);
```
#### Send by email
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->sendByEmail(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->sendByEmail(['InvoiceCode' => $invoiceCode]);
```
#### Send reminder by email
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->sendReminderByEmail(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->sendReminderByEmail(['InvoiceCode' => $invoiceCode]);
```
#### Download
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->download(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->download(['InvoiceCode' => $invoiceCode]);
```
#### Block
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->block(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->block(['InvoiceCode' => $invoiceCode]);
```
#### Unblock
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->unblock(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->unblock(['InvoiceCode' => $invoiceCode]);
```
#### Schedule
Required parameter: `Identifier` or `InvoiceCode` and `ScheduledAt`.
```php
$weFact->invoices()->schedule([
'Identifier' => $invoiceId,
'ScheduledAt' => '2020-01-01 00:00:00'
])
// or
$weFact->invoices()->schedule([
'InvoiceCode' => $invoiceCode,
'ScheduledAt' => '2020-01-01 00:00:00'
])
```
#### Cancel schedule
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->cancelSchedule(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->cancelSchedule(['InvoiceCode' => $invoiceCode]);
```
#### Pause payment process
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->paymentProcessPause(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->paymentProcessPause(['InvoiceCode' => $invoiceCode]);
```
#### Reactivate payment process
Required parameter: `Identifier` or `InvoiceCode`.
```php
$weFact->invoices()->paymentProcessReactivate(['Identifier' => $invoiceId]);
// or
$weFact->invoices()->paymentProcessReactivate(['InvoiceCode' => $invoiceCode]);
```
#### Sort lines
Required parameter: `Identifier` or `InvoiceCode` and `InvoiceLines Identifier`.
```php
$weFact->invoices()->sortLines([
'Identifier' => $invoiceId,
'InvoiceLines' => [
[
'Identifier' => $invoiceLineId,
]
]
]);
```
#### Add invoice line
Required parameter: `Identifier` or `InvoiceCode` and `InvoiceLines`.
```php
$weFact->invoices()->addLine([
'Identifier' => $invoiceId,
'InvoiceLines' => [
[
'Number' => 1,
'ProductCode' => 'P0001'
]
],
]);
```
#### Delete invoice line
Required parameter: `Identifier` or `InvoiceCode` and `InvoiceLines Identifier`.
```php
$weFact->invoices()->deleteLine([
'Identifier' => $invoiceId,
'InvoiceLines' => [
[
'Identifier' => $invoiceLineId,
]
]
]);
```
#### Add attachment
Required parameter: `ReferenceIdentifier` or `InvoiceCode`, `Tyoe`, `Filename` and `Base64`.
```php
$weFact->invoices()->addAttachment([
'ReferenceIdentifier' => $invoiceId,
'Type' => 'invoice',
'Filename' => 'test.pdf',
'Base64' => 'base64string'
]);
```
#### Delete attachment
Required parameter: `Identifier` or `Filename`, `ReferenceIdentifier` or `InvoiceCode` and `Type`.
```php
$weFact->invoices()->deleteAttachment([
'Identifier' => $attachmentId,
'ReferenceIdentifier' => $invoiceId,
'Type' => 'invoice',
]);
```
#### Download attachment
Required parameter: `Identifier` or `Filename`, `ReferenceIdentifier` or `InvoiceCode` and `Type`.
```php
$weFact->invoices()->downloadAttachment([
'ReferenceIdentifier' => $invoiceId,
'Filename' => 'test.pdf',
'Type' => 'invoice',
]);
```
### Product
#### List products
```php
$weFact->products()->list();
// or use listAll to call the show method for each item
$response = $weFact->products()->listAll();
```
#### Create product
Required parameters: `ProductName`, `ProductKeyPhrase` and `PriceExcl`.
```php
$weFact->products()->create([
'ProductName' => 'Your product name',
'ProductKeyPhrase' => 'Your product key phrase',
'PriceExcl' => 100
])
```
#### Update product
Required parameter: `Identifier` or `ProductCode`.
```php
$weFact->products()->edit([
'Identifier' => $productId,
'ProductName' => 'Your product name',
'ProductKeyPhrase' => 'Your product key phrase',
'PriceExcl' => 100
])
```
#### Show product
Required parameter: `Identifier`
```php
$weFact->products()->show(['Identifier' => $productId]);
```
#### Delete product
Required parameter: `Identifier` or `ProductCode`.
```php
$weFact->products()->delete(['Identifier' => $productId]);
// or
$weFact->products()->delete(['ProductCode' => $productCode]);
```
### Settings
#### List settings
```php
$weFact->settings()->list();
```
### Settings - Cost Category
#### List cost categories
```php
$weFact->costCategories()->list();
// or use listAll to call the show method for each item
$response = $weFact->costCategories()->listAll();
```
#### Create cost category
Required parameters: `Title`.
```php
$weFact->costCategories()->create([
'Title' => 'Your cost category title',
]);
```
#### Update cost category
Required parameter: `Identifier`.
```php
$weFact->costCategories()->edit([
'Identifier' => $costCategoryId,
]);
```
#### Show cost category
Required parameter: `Identifier`.
```php
$weFact->costCategories()->show(['Identifier' => $costCategoryId]);
```
#### Delete cost category
Required parameter: `Identifier`.
```php
$weFact->costCategories()->delete(['Identifier' => $costCategoryId]);
```
### Subscription
#### List subscriptions
```php
$weFact->subscriptions()->list();
// or use listAll to call the show method for each item
$response = $weFact->subscriptions()->listAll();
```
#### 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 the `TerminationDate`, not both. The `TerminateAfter` includes the number of times the subscription has been billed in the past.
```php
$weFact->subscriptions()->create([
'DebtorCode' => 'DB10000',
'ProductCode' => 'P0001',
'Description' => 'Your product description',
'PriceExcl' => 100,
'Periodic' => 'month',
'TerminateAfter' => 12
])
```
#### Update subscription
Required parameter: `Identifier`.
> Please note: You can pass either the `TerminateAfter` or the `TerminationDate`, not both. The `TerminateAfter` includes the number of times the subscription has been billed in the past.
```php
$weFact->subscriptions()->edit([
'Identifier' => $subscriptionId,
'Description' => 'Your product description',
'PriceExcl' => 100,
'Periodic' => 'month',
'TerminateAfter' => 12
])
```
#### Show subscription
Required parameter: `Identifier`.
```php
$weFact->subscriptions()->show(['Identifier' => $subscriptionId]);
```
#### Terminate subscription
Required parameter: `Identifier`.
```php
$weFact->subscriptions()->terminate(['Identifier' => $subscriptionId]);
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Bas van Dinther](https://github.com/vormkracht10)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.