TYPES AND CODES
Below is a detailed list of all the types and codes the Xero API uses:
Accounts
Account Class Types
| ASSET |
| EQUITY |
| EXPENSE |
| LIABILITY |
| REVENUE |
Account Types
| BANK |
| CURRENT |
| CURRLIAB |
| DEPRECIATN |
| DIRECTCOSTS |
| EQUITY |
| EXPENSE |
| FIXED |
| LIABILITY |
| NONCURRENT |
| OTHERINCOME |
| OVERHEADS |
| PREPAYMENT |
| REVENUE |
| SALES |
| TERMLIAB |
Account Status Codes
System Accounts
| Default account name |
SystemAccount attribute value |
| Accounts Receivable |
DEBTORS |
| Accounts Payable |
CREDITORS |
| Bank Revaluations |
BANKCURRENCYGAIN |
| GST / VAT |
GST |
| GST On Imports |
GSTONIMPORTS |
| Historical Adjustment |
HISTORICAL |
| Realised Currency Gains |
REALISEDCURRENCYGAIN |
| Retained Earnings |
RETAINEDEARNINGS |
| Rounding |
ROUNDING |
| Tracking Transfers |
TRACKINGTRANSFERS |
| Unpaid Expense Claims |
UNPAIDEXPCLM |
| Unrealised Currency Gains |
UNREALISEDCURRENCYGAIN |
| Wages Payable |
WAGEPAYABLES |
Bank Transactions
Types
Bank Transaction Status Codes
Contacts
Contact Status Codes
| ACTIVE |
| The following value is only supported via the GET method |
| DELETED |
Credit Notes
Credit Note Types
| ACCPAYCREDIT |
An Accounts Payable(supplier) Credit Note |
| ACCRECCREDIT |
An Account Receivable(customer) Credit Note |
All other types are identical to Invoices.
Addresses
Addresses
| AddressType |
| AddressLine 1,2,3,4 |
| City |
| Region |
| PostalCode |
| Country |
| AttentionTo |
Address Types
| POBOX (default mailing address for Invoices) |
| STREET |
Phones
Phones
| PhoneType |
| PhoneNumber |
| PhoneAreaCode |
| PhoneCountryCode |
Phone Types
Invoices
Invoice Types
| ACCPAY |
An Accounts Payable(supplier) invoice |
| ACCREC |
An Account Receivable(customer) invoice |
Invoice Status Codes ( Refer to invoices for details of usage )
| DRAFT |
A Draft Invoice (default) |
| SUBMITTED |
An Awaiting Approval Invoice |
| DELETED |
A Deleted Invoice |
| AUTHORISED |
An Invoice that is Approved and Awaiting Payment OR partially paid |
| PAID |
An Invoice that is completely Paid |
| VOIDED |
A Voided Invoice |
LineAmount Types
| Exclusive |
Invoice lines are exclusive of tax (default) |
| Inclusive |
Invoice lines are inclusive tax |
| NoTax |
Invoices lines have no tax |
LineItems
Tax Types
New Zealand
| TAX TYPE |
RATE |
NAME |
| INPUT |
12.50 |
GST on Expenses (old rate) |
| INPUT2 |
15.00 |
GST on Expenses |
| NONE |
0.00 |
No GST |
| OUTPUT |
12.50 |
GST on Income (old rate) |
| OUTPUT2 |
15.00 |
GST on Income |
United Kingdom
| TAX TYPE |
RATE |
NAME |
| CAPEXINPUT |
17.50 |
VAT on Capital Purchases |
CAPEXOUTPUT |
17.50 |
VAT on Capital Sales |
CAPEXINPUT2 |
20.00 |
VAT on Capital Purchases (new rate from 4 Jan 2011) |
CAPEXOUTPUT2 |
20.00 |
VAT on Capital Sales (new rate from 4 Jan 2011) |
| ECZRINPUT |
0.00 |
Zero Rated EC Expenses |
| ECZROUTPUT |
0.00 |
Zero Rated EC Income |
| EXEMPTINPUT |
0.00 |
Exempt Expenses |
| EXEMPTOUTPUT |
0.00 |
Exempt Income |
| INPUT |
17.50 |
VAT on Expenses |
| INPUT2 |
20.00 |
VAT on Expenses (new rate from 4 Jan 2011) |
| NONE |
0.00 |
No VAT |
| OUTPUT |
17.50 |
VAT on Income |
| OUTPUT2 |
20.0 |
VAT on Income (new rate from 4 Jan 2011) |
| RRINPUT |
5.00 |
5% (VAT on Expenses) |
| RROUTPUT |
5.00 |
5% (VAT on Income) |
| SRINPUT |
15.00 |
VAT on Expenses(old rate) |
| SROUTPUT |
15.00 |
VAT on Income(old rate) |
| ZERORATEDINPUT |
0.00 |
Zero Rated Expenses |
| ZERORATEDOUTPUT |
0.00 |
Zero Rated Income |
Australia
| TAX TYPE |
RATE |
NAME |
| OUTPUT |
10.00 |
GST on Income |
INPUT |
10.00 |
GST on Expenses |
| CAPEXINPUT |
10.00 |
GST on Capital |
| EXEMPTEXPORT |
0.00 |
GST Free Exports |
| EXEMPTEXPENSES |
0.00 |
GST Free Expenses |
| EXEMPTCAPITAL |
0.00 |
GST Free Capital |
| EXEMPTOUTPUT |
0.00 |
GST Free Income |
| INPUTTAXED |
0.00 |
Input Taxed |
| BASEXCLUDED |
0.00 |
No GST |
| GSTONCAPIMPORTS |
0.00 |
GST on Capital Imports |
| GSTONIMPORTS |
0.00 |
GST on Imports |
Global
| TAX TYPE |
RATE |
NAME |
| INPUT |
0.00 |
Tax on Purchases |
| NONE |
0.00 |
Tax Exempt |
| OUTPUT |
0.00 |
Tax on Sales |
| GSTONIMPORTS |
0.00 |
Sales Tax on Imports |
United States
| TAX TYPE |
RATE |
NAME |
| INPUT |
9.2500 |
Tax on Purchases |
| NONE |
0.00 |
Tax Exempt |
| OUTPUT |
9.2500 |
Tax on Sales |
| GSTONIMPORTS |
0.00 |
Sales Tax on Imports |
New tax rates can be setup for a Xero organisation. All new tax rates added have a TaxType of the format TAX001, TAX002 etc.
Manual Journals
Manual Journal Status Codes
| DRAFT |
A Draft ManualJournal (default) |
| POSTED |
A Posted ManualJournal |
| DELETED |
A Deleted Draft ManualJournal |
VOIDED |
A Voided Posted ManualJournal |
Organisation
Version Types
| AU |
Business editions |
| NZ |
| GLOBAL |
| UK |
| US |
| AUONRAMP |
Partner & Cashbook editions. NOTE: Authorization on Cashbook edition has to approved by partners |
| NZONRAMP |
| GLOBALONRAMP |
| UKONRAMP |
| USONRAMP |
Organisation Types
| COMPANY |
| CHARITY |
| CLUBSOCIETY |
| PARTNERSHIP |
| PERSON |
| SOLETRADER |
| TRUST |
User Roles
Xero User Roles