Page Comparison

The Invoice and Transactions API feeds allow you to integrate invoice, item, and payment information with other accounting, bookkeeping, and finance software.

Purpose of the API Feed

The Invoices and Transaction API Feeds can be used to connect your accessplanit platform to other finance software, such as your Invoicing tool.

Connecting your platforms and syncing the data between them removes the need for double data entry, reduces the risk of human error and eases the headache of managing multiple pieces of software!

Fields Available in the API Feeds

There are three feeds included for Invoices and Transactions data.

Each of these three feeds can be used to read data from, send updates to, and create new records in your accessplanit platform.

Invoices

This feed is used for accessing the details of Invoices within the database. Please note, it is not possible to create new Invoices via the feed.

Field	GET (Read)	PUT (Update)	POST (Create new)	Validation
Invoice ID

YImage RemovedNImage RemovedN

	n/a
Invoice Ref

Image RemovedYImage RemovedNImage RemovedN

	n/a
Issuer ID

Image RemovedYImage RemovedNImage RemovedN

	n/a
Amount (Net)

Image RemovedYImage RemovedNImage RemovedN

	n/a
Tax

Image RemovedYImage RemovedNImage RemovedN

	n/a
Date Generated

Image RemovedYImage RemovedNImage RemovedN

	n/a
Date Due

Image RemovedYImage RemovedYImage RemovedN

Invoice Status

Image RemovedYImage RemovedNImage RemovedN

	n/a
Amount Outstanding

Image RemovedYImage RemovedNImage RemovedN

	n/a
Amount Paid

Image RemovedYImage RemovedNImage RemovedN

	n/a
Target Link

Image RemovedYImage RemovedNImage RemovedN

	n/a
PO Number

Image RemovedYImage RemovedYImage RemovedN

50 chars max

Invoice Items

This feed is used for accessing the details of the items on the Invoices. Items include the Delegates and courses being purchased, Discounts, and Products and Services. Invoice items can only be accessed via the Invoices feed. It is not possible to output a list of all Invoice Items.

It is not possible to create or update Invoice Items.

Field	GET (Read)	PUT (Update)	POST (Create new)	Validation
Invoice ID

Image RemovedYImage RemovedNImage RemovedN

	n/a
Invoice Item ID

Image RemovedYImage RemovedNImage RemovedN

	n/a
Line Description

Image RemovedYImage RemovedNImage RemovedN

	n/a
Invoice Item Amount

Image RemovedYImage RemovedNImage RemovedN

	n/a
Invoice Item Tax

Image RemovedYImage RemovedNImage RemovedN

n/a

Transactions

This feed is used for accessing the details of payments/transactions logged on Invoices. It is possible view and create transactions, however, it is not possible to edit existing transactions. 

Field	GET (Read)	PUT (Update)	POST (Create new)	Validation
TransactionInvoiceID

Image RemovedYImage RemovedNImage RemovedN

	n/a
Invoice ID

Image RemovedYImage RemovedNImage Removed Mandatory

	Mandatory	Must validate against existing Invoices
Transaction ID

Image RemovedYImage RemovedNImage RemovedN

	n/a
External Transaction ID

Image RemovedYImage RemovedNImage RemovedY

	Max char 250
Transaction Method

Image RemovedYImage RemovedNImage Removed Mandatory

	Mandatory	Only the following values are accepted: BACS Cash Cheque Card Adyen Barclays ePDQ - Remote PayPal Standard PayPal Express Realex - Redirect Opayo (formally SagePay) - Direct Stripe WorldPay Business Gateway WPM Education
Date

Image RemovedYImage Removed MandatoryImage RemovedN

	Mandatory
Amount (Net)

Image RemovedYImage Removed Mandatory

Image RemovedN

	Mandatory
Tax

Image RemovedYImage Removed MandatoryImage RemovedN

Mandatory

Connecting to the API

DISCLAIMER: By using accessplanit APIs, you agree to our terms of use.

To gain access to your platform's API Feeds please speak to the CSM team at accessplanit on csm@accessplanit.com