README

A PHP library for Twinfield Integration. Use the Twinfield SOAP Service to have your PHP application communicate directly with your Twinfield account.

⚠️ 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:

composer require code050/twinfield

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:

$connection = new Secure\WebservicesAuthentication("username", "password", "organization");

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:

$provider    = new OAuthProvider([
    'clientId'     => 'someClientId',
    'clientSecret' => 'someClientSecret',
    'redirectUri'  => 'https://example.org/'
]);
$accessToken = $provider->getAccessToken("authorization_code", ["code" => ...]);
$office      = \PhpTwinfield\Office::fromCode("someOfficeCode");

$connection  = new \PhpTwinfield\Secure\OpenIdConnectAuthentication($provider, $accessToken, $office);

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:

$connection = new Secure\AuthenticatedConnection("username", "password", "organization");
$customerApiConnector = new ApiConnectors\CustomerApiConnector($connection);

// Get one customer.
$office   = Office::fromCode('office code');
$customer = $customerApiConnector->get('1001', $office);

// Get a list of all customers.
$customer = $customerApiConnector->listAll($office);

Creating or updating objects

If you want to create or update a customer or any other object, it's just as easy:

$customer_factory = new ApiConnectors\CustomerApiConnector($connection);

// First, create the objects you want to send.
$customer = new Customer();
$customer
    ->setCode('1001')
    ->setName('John Doe')
    ->setOffice($office)
    ->setEBilling(false);

$customer_address = new CustomerAddress();
$customer_address
    ->setType('invoice')
    ->setDefault(false)
    ->setPostcode('1212 AB')
    ->setCity('TestCity')
    ->setCountry('NL')
    ->setTelephone('010-12345')
    ->setFax('010-1234')
    ->setEmail('johndoe@example.com');
$customer->addAddress($customer_address);

// And secondly, send it to Twinfield.
$customer_factory->send($customer);

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	✅		✅	✅
BankTransaction			✅
Customer	✅	✅	✅	✅
Electronic Bank Statements			✅
Sales Invoices	✅		✅	✅
Matching			✅
Offices		✅
Suppliers	✅	✅	✅	✅
Transactions: Purchase, Sale, Journal	✅		✅	✅
Users		✅
Vat types		✅

code050 / twinfield

Maintainers

Details