Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Livesearch
spaceKeyHG
additionalpage excerpt
placeholderSearch for a solution
typepage

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

Y

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Invoice Ref

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Issuer ID 

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Amount (Net)

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Tax

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Date Generated

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Date Due

Image RemovedY

(tick)

Image RemovedY

(tick)

Image RemovedN

(error)


Invoice Status

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Amount Outstanding

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Amount Paid

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Target Link 

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

PO Number

Image RemovedY

(tick)

Image RemovedY

(tick)

Image RemovedN

(error)

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 RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Invoice Item ID

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Line Description

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Invoice Item Amount

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Invoice Item Tax

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

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 RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

Invoice ID

Image RemovedY

(tick)

Image RemovedNImage Removed Mandatory

(error)

(tick) Mandatory

Must validate against existing Invoices

Transaction ID

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedN

(error)

n/a

External Transaction ID

Image RemovedY

(tick)

Image RemovedN

(error)

Image RemovedY

(tick)

Max char 250

Transaction Method

Image RemovedY

(tick)

Image RemovedNImage Removed Mandatory

(error)

(tick) 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 Mandatory

(tick)

Image RemovedN

(error)

(tick) Mandatory


Amount (Net)

Image RemovedYImage Removed Mandatory

(tick)

Image RemovedN

(error)

(tick) Mandatory


Tax

Image RemovedYImage Removed Mandatory

(tick)

Image RemovedN

(error)

(tick) 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