Skip to content

Latest commit

 

History

History
180 lines (127 loc) · 8.75 KB

readme.md

File metadata and controls

180 lines (127 loc) · 8.75 KB
Raw

Twinfield

A PHP library for Twinfield Integration. Developed by Remco Tolsma and Leon Rowland from Pronamic.

Use the Twinfield SOAP Service to have your PHP application communicate directly with your Twinfield account.

Why this fork?

This package provides a proper semver-versioned fork of the package, for safe usage with composer in your projects.

Usage

Install this package with composer:

composer require picqer/twinfield-php-client

General Usage

Components have Factories to simplify the request and send process of Twinfield. Each factory will require just the \Pronamic\Twinfield\Secure\Config() class with the filled in details.

An example of the usage of the Configuration class.

$config = new \Pronamic\Twinfield\Secure\Config();
$config->setCredentials('Username', 'Password', 'Organization', 'Office');
  • or, when using OAuth:
$config = new \Pronamic\Twinfield\Secure\Config();
$config->setOAuthParameters('clientID', 'clientSecret', 'returnURL', 'Organization', 'Office', true);
//the true parameter at the end tells the system to automatically redirect to twinfield to login

The current modules

In the following example, we will use the Customer component as showcase. Although this will be the method for all components ( including Invoice currently )

Typically it is as follows, if using the Factories

  • Add/Edit: Make Object, Make Factory, Give object in Submit method of related factory.
  • Retrieve: Make Factory, Supply all required params to respective listAll() and get() methods

Add/Edit

Make your Customer object

$customer = new \Pronamic\Twinfield\Customer\Customer();
$customer
	->setID(10666)
	->setName('Leon Rowland')
	->setType('DEB')
	->setWebsite('http://leon.rowland.nl')
	->setEBilling(true)
	->setEBillMail('[email protected]')
	->setVatCode('VL')
	->setDueDays(10)
	->setCocNumber('12341234');

Customers can have addresses associated with them

$customerAddress = new \Pronamic\Twinfield\Customer\CustomerAddress();
$customerAddress
	->setDefault(false)
	->setType('invoice')
	->setField1('Testing field 1')
	->setField2('Testing field 2')
	->setField3('Testing field 3')
	->setPostcode('1212 AB')
	->setCity('TestCity')
	->setCountry('NL')
	->setTelephone('010-12345')
	->setFax('010-1234')
	->setEmail('[email protected]');

Assign that address to the customer

$customer->addAddress($customerAddress);

Now lets submit it!

use \Pronamic\Twinfield\Customer as TwinfieldCustomer;

// Config object prepared and passed to the CustomerFactory
$customerFactory = new TwinfieldCustomer\CustomerFactory($config);

//$customer = new TwinfieldCustomer\Customer();

// Attempt to send the Customer document
if($customerFactory->send($customer)){
	// Use the Mapper to turn the response back into a TwinfieldCustomer\Customer
	$successfulCustomer = TwinfieldCustomer\Mapper\CustomerMapper::map($customerFactory->getResponse());
}

Retrieve/Request

You can get all customers or get a single one currently.

use \Pronamic\Twinfield\Customer as TwinfieldCustomer;

// Config object prepared and passed into the CustomerFactory
$customerFactory = new TwinfieldCustomer\CustomerFactory($config);

$customers = $customerFactory->listAll();

At the moment, listAll will return an array of just name and short name.

$customer = $customerFactory->get('customerCode', 'office[optional]');

The response from get() will be a \Pronamic\Twinfield\Customer\Customer object.

Contribute

You can contribute to the development of this project. Try and keep to the way of doing things as the other 2 components have implemented.

A large requirement is to maintain backwards compatibility so if you have any plans for large restructure or alteration please bring up in an issue first.

Component get() listAll() send() Mapper Namespace
Customer ✅ ✅ ✅ ✅ Pronamic/Twinfield/Customer
Sales Invoices ✅ ✅ ✅ ✅ Pronamic/Twinfield/Invoice
Transactions: Purchase Sale ✅ Pronamic/Twinfield/Transaction
Articles Pronamic/Twinfield/Article
Balance Sheets Pronamic/Twinfield/BalanceSheet
Suppliers Pronamic/Twinfield/Supplier
Dimension Groups Pronamic/Twinfield/Dimension/Group
Dimension Types Pronamic/Twinfield/Dimension/Type
Offices ✅ Pronamic/Twinfield/Office
Vat types ✅ Pronamic/Twinfield/VatCode

Links

Authors

License

Copyright 2009-2017 Pronamic.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA