Financial API Feeds

Search for a solution

The Finance API feed endpoints allow you to integrate invoice, item, and payment information with other accounting, bookkeeping, and finance software.

 

The feed is available if you have the API Feeds module. Please speak to your CSM to find out more about this module.

Purpose of the API Feeds

The Financial 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, it is also possible to update some information via the feed.

It is not possible to create new Invoices via the feed. This action should always be managed by an Administrator within the accessplanit platform.

It is not possible to filter the results of GET request for Invoices, other than specifying the specific invoice via

  • {{apiroot}}/invoices/[invoice id]

Field

GET
(Read)

GET
(Filter)

PUT
(Update)

POST
(Create new)

Validation

Invoice ID

n/a

Invoice Ref

n/a

Issuer ID 

n/a

Amount
(in pence/cents)

n/a

Tax
(in pence/cents)

n/a

Date Generated

n/a

Date Due

Date Time

Invoice Status

n/a

Amount Outstanding
(in pence/cents)

n/a

Amount Paid
(in pence/cents)

n/a

PO Number

Max 50 characters

Invoice Based Custom Fields

Subject to custom field type used


Invoice Items

This feed is used for accessing the details of the items on the Invoices. Items include Delegates, the courses being purchased, Discounts, Placeholders, and Products and Services.

It is not possible to create or update Invoice Items via the feed. These actions should always be managed by an Administrator within the accessplanit platform.

It is not possible to filter the results of GET request for Invoices Items, other than specifying the specific invoice item or invoice via

  • {{apiroot}}/invoiceitems/[invoice item id]

  • {{apiroot}}/invoices/[invoice id]/invoiceitems

Field

GET
(Read)

GET
(Filter)

PUT
(Update)

POST
(Create new)

Validation

Invoice ID   

n/a

Invoice Item ID

n/a

Line Description

n/a

Invoice Item Amount
(in pence/cents)

n/a

Invoice Item Tax
(in pence/cents)

n/a


Transactions

This feed is used for accessing the details of payments/transactions logged on Invoices.

It is possible to view and create transactions, however, it is not possible to edit existing transactions. 

It is not possible to filter the results of GET request for Transactions, other than specifying the specific transaction or invoice via

  • {{apiroot}}/invoicetransactions/[transaction id]

  • {{apiroot}}/invoices/[invoice id]/invoicetransactions

Field

GET
(Read)

GET
(Filter)

PUT
(Update)

POST
(Create new)

Validation

TransactionInvoiceID

n/a

Invoice ID

Mandatory

Must validate against existing Invoices

Transaction ID

n/a

External Transaction ID

Max characters 250

Transaction Method

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

Mandatory

Date Time

Amount
(in pence/cents)

Mandatory

Number

Tax
(in pence/cents)

Mandatory

Number


Connecting to the API

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

As the API Feeds are an additional module, please contact your assigned Customer Success Manager (CSM) to gain access to them for your integrations.