Types and Codes


Overview

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 Bank account
CURRENT Current Asset account
CURRLIAB Current Liability account
DEPRECIATN Depreciation account
DIRECTCOSTS Direct Costs account
EQUITY Equity account
EXPENSE Expense account
FIXED Fixed Asset account
LIABILITY Liability account
NONCURRENT Non-current Asset account
OTHERINCOME Other Income account
OVERHEADS Overhead account
PREPAYMENT Prepayment account
REVENUE Revenue account
SALES Sale account
TERMLIAB Non-current Liability account
PAYGLIABILITY PAYG Liability account
SUPERANNUATIONEXPENSE Superannuation Expense account
SUPERANNUATIONLIABILITY Superannuation Liability account
WAGESEXPENSE Wages Expense account

Account Status Codes

ACTIVE
ARCHIVED

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

Addresses

Addresses

AddressType
AddressLine 1,2,3,4
City
Region
PostalCode
Country
AttentionTo

Address Types

POBOX (default mailing address for Invoices)
STREET
DELIVERY

Bank Transactions

Types

RECEIVE
SPEND
The following values are only supported via the GET method at the moment
RECEIVE-OVERPAYMENT
RECEIVE-PREPAYMENT
RECEIVE-TRANSFER
SPEND-OVERPAYMENT
SPEND-PREPAYMENT
SPEND-TRANSFER

Bank Transaction Status Codes

AUTHORISED
DELETED

Contacts

Contact Status Codes

ACTIVE
ARCHIVED

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.


Expense Claims

Expense Claim Status Codes ( Refer to expense claims for details of usage )

SUBMITTED An expense claim has been submitted for approval (default)
AUTHORISED An expense claim has been authorised for payment
PAID An expense claim has been paid

ExternalLinks

External Link Types

Facebook
GooglePlus
LinkedIn
Twitter
Website

Invoices

Invoice Types

ACCPAY A bill – commonly known as a Accounts Payable or supplier invoice
ACCREC A sales invoice – commonly known as an Accounts Receivable or 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

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

Payments

Payment Status Codes

AUTHORISED
DELETED

Payment Terms

DAYSAFTERBILLDATE day(s) after bill date
DAYSAFTERBILLMONTH day(s) after bill month
OFCURRENTMONTH of the current month
OFFOLLOWINGMONTH of the following month

Phones

Phones

PhoneType
PhoneNumber
PhoneAreaCode
PhoneCountryCode

Phone Types

DEFAULT
DDI
MOBILE
FAX

Receipts

Receipt Status Codes ( Refer to receipts for details of usage )

DRAFT A draft receipt (default)
SUBMITTED Receipt has been submitted as part of an expense claim
AUTHORISED Receipt has been authorised in the Xero app
DECLINED Receipt has been declined in the Xero app

Report Tax Types

Below are a list of Report Tax Types included by default in each version of Xero for AU, NZ and UK

Australia

OUTPUT
INPUT
EXEMPTOUTPUT
INPUTTAXED
BASEXCLUDED
EXEMPTEXPENSES

New Zealand

OUTPUT
INPUT
EXEMPTOUTPUT
EXEMPTINPUT

UK

OUTPUT
INPUT
EXEMPTOUTPUT
EXEMPTINPUT
ECOUTPUT
ECOUTPUTSERVICES
ECINPUT
CAPITALSALESOUTPUT
CAPITALEXPENSESINPUT

Sales Tax Basis

Below are a list of Sales Tax Basis values included in each version of Xero

New Zealand

PAYMENTS Payments Basis
INVOICE Invoice Basis
NONE None

United Kingodom

CASH Cash Scheme
ACCRUAL Accrual Scheme
FLATRATECASH Flat Rate Cash Scheme
FLATRATEACCRUAL Flat Rate Accrual Scheme
NONE None

Australia, US & Global

CASH Cash Basis
ACCRUALS Accruals Basis
NONE None

Sales Tax Periods

Below are a list of Sales Tax Periods included in each version of Xero

Australia

MONTHLY Monthly
QUARTERLY1 Quarterly (Option1)
QUARTERLY2 Quarterly (Option2)
QUARTERLY3 Quarterly (Option3)
ANNUALLY Annually

New Zealand

ONEMONTHS Monthly
TWOMONTHS 2 Monthly
SIXMONTHS 6 Monthly

US & Global

1MONTHLY Monthly
2MONTHLY 2 Monthly
3MONTHLY 3 Monthly
6MONTHLY 6 Monthly
ANNUALLY Annually

United Kingdom

MONTHLY Monthly
QUARTERLY Quarterly
YEARLY Yearly

Tax Types

New tax rates can be setup for a Xero organisation. All new tax rates added have a TaxType of the format TAX001, TAX002 etc.

Below are a list of Tax Types included by default in each version of Xero. Tax Types that are system defined cannot be updated via the API.

Australia

TAX TYPE RATE NAME SYSTEM DEFINED
OUTPUT 10.00 GST on Income
INPUT 10.00 GST on Expenses
CAPEXINPUT 10.00 GST on Capital Yes
EXEMPTEXPORT 0.00 GST Free Exports Yes
EXEMPTEXPENSES 0.00 GST Free Expenses Yes
EXEMPTCAPITAL 0.00 GST Free Capital Yes
EXEMPTOUTPUT 0.00 GST Free Income
INPUTTAXED 0.00 Input Taxed
BASEXCLUDED 0.00 BAS Excluded
GSTONCAPIMPORTS 0.00 GST on Capital Imports Yes
GSTONIMPORTS 0.00 GST on Imports Yes

Please note the tax rate code changes for Australia implemented in March 2013.

Global

TAX TYPE RATE NAME SYSTEM DEFINED
INPUT 0.00 Tax on Purchases
NONE 0.00 Tax Exempt Yes
OUTPUT 0.00 Tax on Sales
GSTONIMPORTS 0.00 Sales Tax on Imports Yes

New Zealand

TAX TYPE RATE NAME SYSTEM DEFINED
INPUT2 15.00 GST on Expenses
NONE 0.00 No GST Yes
ZERORATED 0.00 Zero Rated
OUTPUT2 15.00 GST on Income
GSTONIMPORTS 0.00 GST on Imports Yes

United Kingdom

TAX TYPE RATE NAME SYSTEM DEFINED
CAPEXINPUT 17.50 17.5% (VAT on Capital Purchases) Yes
CAPEXINPUT2 20 20% (VAT on Capital Purchases) Yes
CAPEXOUTPUT 17.50 17.5% (VAT on Capital Sales) Yes
CAPEXOUTPUT2 20 20% (VAT on Capital Sales) Yes
CAPEXSRINPUT 15 15% (VAT on Capital Purchases) Yes
CAPEXSROUTPUT 15 15% (VAT on Capital Sales) Yes
ECZRINPUT 0.00 Zero Rated EC Expenses
ECZROUTPUT 0.00 Zero Rated EC Goods Income
ECZROUTPUTSERVICES 0.00 Zero Rated EC Services
EXEMPTINPUT 0.00 Exempt Expenses
EXEMPTOUTPUT 0.00 Exempt Income
GSTONIMPORTS 0.00 VAT on Imports Yes
INPUT2 20.00 20% (VAT on Expenses)
NONE 0.00 No VAT Yes
OUTPUT2 20.0 20% (VAT on Income)
RRINPUT 5.00 5% (VAT on Expenses)
RROUTPUT 5.00 5% (VAT on Income)
SRINPUT 15.00 15% (VAT on Expenses)
SROUTPUT 15.00 15% (VAT on Income)
ZERORATEDINPUT 0.00 Zero Rated Expenses
ZERORATEDOUTPUT 0.00 Zero Rated Income

United States

TAX TYPE RATE NAME SYSTEM DEFINED
INPUT 9.2500 Tax on Purchases
NONE 0.00 Tax Exempt Yes
OUTPUT 9.2500 Tax on Sales
GSTONIMPORTS 0.00 Sales Tax on Imports Yes

User Roles

Xero User Roles

READONLY Read only user – Further info
INVOICEONLY Invoice only user – Further info
STANDARD Standard user – Further info
FINANCIALADVISER Financial adviser role – Further info
MANAGEDCLIENT Managed client role (Partner Edition only) – Further info
CASHBOOKCLIENT Cashbook client role (Partner Edition only) – Further info