Accounting API

Ledger Accounts

Tax Rates

Company Info

Invoices

Customers

Bills

Suppliers

Invoice Items

Payments

Credit Notes

BalanceSheet

ProfitAndLoss

Journal Entries

Get paid sooner when you accept payments online straight from a Xero invoice. Give your customers different payment options, including PayPal and Stripe.

oauth_credentials

Xero

edge-case

Whether sales tax is calculated automatically for the company

Automated sales tax

Company name

Date when company file was created

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

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

Tax rate code

The ID of the object.

Name

Rate

medium

The start month of fiscal year.

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

Legal name

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

Whether sales tax is enabled for the company

Sales tax enabled

Sales Tax Number

Based on the status some functionality is enabled or disabled.

Company status

The date and time when the object was last updated.

Updated at (timestamp)

Updated by

Code

Account ID

Account Name

Nominal Code

Display ID

Display Name

The third-party API ID of original entity

First name

Is this an individual or business customer

Is individual

Last name

Middle name

Notes

The parent customer this entity is linked to.

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

Customer ID

LinkedParentCustomer

Is project

Status

Suffix

Tax number

Job title

high

Tax code assigned to identify this tax rate.

Tax code

Tax components

Description

Effective tax rate

ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.

Original tax rate ID

Report Tax type to aggregate tax collected or paid for reporting purposes

Report Tax Type

Tax rate status

Unique identifier for the account for tax collected.

Tax payable account id

Unique identifier for the account for tax remitted.

Tax remitted account id

Not compounded sum of the components of a tax rate

Total tax rate

Tax type used to indicate the source of tax collected or paid

Tax Type

Is active

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

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

Classification

Current balance

The human readable display ID used when displaying the account

Fully Qualified Name

Is header

Reconciliation Date means the last calendar day of each Reconciliation Period.

Last Reconciliation Date

Opening balance

The human readable display ID used when displaying the parent account

Parent account ID

Account status

Whether the account is a sub account or not.

Is sub account

Sub accounts

Sub Type

Type

Item code

Item ID

The date of opening balance if inventory item is tracked - YYYY-MM-DD.

Inventory date

Item name

Tax inclusive

Description of the unit type the item is sold as, ie: kg, hour.

Unit of measure

Unit price

Item is available for purchase transactions

Item purchased

Quantity

Item will be available on sales transactions

Item sold

Item tracked

critical

Balance

Address field that holds a sublocality, such as a county

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

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

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

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

Template

Terms

Total amount

Total tax amount applied to this invoice.

Total tax amount

Invoice type

Unique identifier for the account to allocate payment to.

Accounts receivable account id

Type of accounts receivable account

Display id

Unique identifier representing the entity

Payment identifier

Optional note to be associated with the payment.

Note

Payment method

Optional reference message returned by payment method on processing

Payment method reference

Reconciled

Optional payment reference message ie: Debit remittance detail.

Payment reference

Payment status

The ID of the supplier this entity is linked to.

Supplier ID

LinkedSupplier

Date transaction was entered - YYYY:MM::DDThh:mm:ss.sTZD

Transaction datetime

Payment Type

Is this an individual or business supplier

Bill date

Bill number

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

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

Paid date

Bill reference

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

Credit Note identifier

Optional note to be associated with the credit note.

Xero

Supported resources

Details