The Finance API feed endpoints allow you to integrate invoice, item, and payment information with other accounting, bookkeeping, and finance software.
Purpose of the API Feeds
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 endpoints available for Financial data, please see the below tables for the data that is available in each.
Each of these three feeds have different levels of reading, creating, and updating, the tables below explain what actions are available for the fields in each feed.
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 | PUT | POST | Validation |
|---|---|---|---|---|
Invoice ID |
|
|
| n/a |
Invoice Ref |
|
|
| n/a |
Issuer ID |
|
|
| n/a |
Amount (Net) |
|
|
| n/a |
Tax |
|
|
| n/a |
Date Generated |
|
|
| n/a |
Date Due |
|
|
| |
Invoice Status |
|
|
| n/a |
Amount Outstanding |
|
|
| n/a |
Amount Paid |
|
|
| n/a |
Target Link |
|
|
| n/a |
PO Number |
|
|
| 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 | PUT | POST | Validation |
|---|---|---|---|---|
Invoice ID |
|
|
| n/a |
Invoice Item ID |
|
|
| n/a |
Line Description |
|
|
| n/a |
Invoice Item Amount |
|
|
| n/a |
Invoice Item Tax |
|
|
| 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 | PUT | POST | Validation |
|---|---|---|---|---|
TransactionInvoiceID |
|
|
| n/a |
Invoice ID |
|
|
| Must validate against existing Invoices |
Transaction ID |
|
|
| n/a |
External Transaction ID |
|
|
| Max char 250 |
Transaction Method |
|
|
| Only the following values are accepted:
|
Date |
|
|
| |
Amount (Net) |
|
|
| |
Tax |
|
|
|
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