Accounting API

Ledger Accounts

Tax Rates

Company Info

Invoices

Customers

Bills

Suppliers

Invoice Items

Payments

Credit Notes

Journal Entries

Subsidiaries

BalanceSheet

ProfitAndLoss

Purchase Orders

Locations

Departments

Attachments

Tracking Categories

Bill Payments

Expenses

Making Tax Digital compatible accounting software for small businesses and accountants in the UK. Take a 30 day free trial today.

Clear Books

Code

Account ID

Account Name

Nominal Code

medium

edge-case

The channel through which the transaction is processed.

Channel

The company or subsidiary id the transaction belongs to

CompanyId

Company name

The date and time when the object was created.

Created at (timestamp)

Created by

Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

Currency

UNKNOWN_CURRENCY

When custom mappings are configured on the resource, the result is included here.

Display ID

Display Name

The third-party API ID of original entity

First name

Is this an individual or business supplier

Is individual

Last name

Middle name

Notes

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Payment method used for the transaction, such as cash, credit card, bank transfer, or check

Payment method

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

Row version

Status

Suffix

Tax number

Tax rate code

The ID of the object.

Name

Rate

Job title

The date and time when the object was last updated.

Updated at (timestamp)

Updated by

high

Is this an individual or business customer

The parent customer this entity is linked to.

The parent ID of the customer this entity is linked to.

Customer ID

LinkedParentCustomer

Is project

Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row.

Accounting by Row

Balance

The name which you used in opening your bank account.

Bank Account Name

A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number.

Bank Account Number

Account Type

A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.

Bank Code

Bank Name

A branch identifier is a unique identifier for a branch of a bank or financial institution.

Branch Identifier

A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution.

BSB Number

The International Bank Account Number (IBAN).

A routing number is a nine-digit code used to identify a financial institution in the United States.

Routing number

Name of the contact person at the address

country code according to ISO 3166-1 alpha-2.

Address field that holds a sublocality, such as a county

Line 1 of the address e.g. number, street, suite, apt #, etc.

Salutation of the contact person at the address

The address string. Some APIs don't provide structured address data.

Currency Exchange Rate at the time entity was recorded/generated.

Currency Exchange Rate

Company Name

Email

The ID of the customer this entity is linked to.

The name of the customer. Deprecated, use display_name instead.

LinkedCustomer

Customer memo

Deposit

Discount Amount

Discount percentage applied to this invoice.

Discount Percent

The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD.

Due date

Invoice date

Invoice Sent

language code according to ISO 639-1. For the United States - EN

Invoice Line Item

Invoice number

A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.

Purchase Order number

Invoice reference

URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.

Source document URL

Sub-total amount

Applicable tax id/code override if tax is not supplied on a line item basis.

Tax Code

Tax inclusive

Template

Terms

Total amount

Total tax amount applied to this invoice.

Total tax amount

Linked tracking categories

The unique identifier for the tracking category.

Tracking Category ID

Tracking Category Name

Invoice type

The balance reflecting any payments made against the transaction.

Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD

Datetime

Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD

Unique identifier representing the entity

Credit Note identifier

Optional note to be associated with the credit note.

Note

Credit note number

Optional reference message ie: Debit remittance detail.

Credit Note reference

Indicates the total credit amount still available to apply towards the payment.

Remaining Credit

Credit Note status

Optional terms to be associated with the credit note.

Credit Note Type

Accounting period

Bill date

Bill number

Discount percentage applied to this transaction.

Discount Percentage

The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD.

Bill Line Item

The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD.

Clear Books

Supported resources

Details