Download the PHP package code050/twinfield without Composer
On this page you can find all versions of the php package code050/twinfield. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package twinfield
Twinfield
A PHP library for Twinfield Integration. Use the Twinfield SOAP Service to have your PHP application communicate directly with your Twinfield account.
:warning: This library is still under construction. Version 1 is available from Composer, but we recommend you to wait for (or help with!) version 2. We hope to release it early 2018.
Installation
Install this Twinfield PHP library with Composer:
Usage
Authentication
You need to set up a \PhpTwinfield\Secure\AuthenticatedConnection
class with your credentials. When using basic
username and password authentication, the \PhpTwinfield\Secure\WebservicesAuthentication
class should be used, as follows:
In order to use OAuth2 to authenticate with Twinfield, one should use the \PhpTwinfield\Secure\Provider\OAuthProvider
to retrieve an \League\OAuth2\Client\Token\AccessToken
object. Next to the OAuthProvider
and AccessToken
, it is required to set up a default \PhpTwinfield\Office
, that will be used during requests to Twinfield. Please note: when a different office is specified when sending a request through one of the ApiConnectors
, this Office will override the default.
Using this information, we can create an instance of the \PhpTwinfield\Secure\OpenIdConnectAuthentication
class, as follows:
For more information about retrieving the initial AccessToken
, please refer to: https://github.com/thephpleague/oauth2-client#usage
Getting data from the API
In order to communicate with the Twinfield API, you need to create an ApiConnector
instance for the corresponding
resource and use the get()
or list()
method.
The ApiConnector
takes a Secure\AuthenticatedConnection
object:
An example:
Creating or updating objects
If you want to create or update a customer or any other object, it's just as easy:
You can also send multiple objects in one batch, chunking is handled automatically.
Supported resources
Not all resources from the Twinfield API are currently implemented. Feel free to create a pull request when you need support for another resource.
Component | get() | listAll() | send() | Mapper |
---|---|---|---|---|
Articles | :white_check_mark: | :white_check_mark: | :white_check_mark: | |
BankTransaction | :white_check_mark: | |||
Customer | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
Electronic Bank Statements | :white_check_mark: | |||
Sales Invoices | :white_check_mark: | :white_check_mark: | :white_check_mark: | |
Matching | :white_check_mark: | |||
Offices | :white_check_mark: | |||
Suppliers | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
Transactions: Purchase, Sale, Journal |
:white_check_mark: | :white_check_mark: | :white_check_mark: | |
Users | :white_check_mark: | |||
Vat types | :white_check_mark: |