The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9

The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL.

The Name of the contact group. Required when creating a new contact  group

The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs.

Contact Groups

The Xero identifier for an account – specified as a string following  the endpoint name   e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9

Boolean – describes whether the account is shown in the watchlist widget on the dashboard

For bank accounts only (Account Type BANK)

For bank accounts only. See Bank Account types

Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)

3 letter alpha code for the currency – see list of currency codes

Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)

Boolean – describes whether account can have payments applied to it

boolean to indicate if an account has an attachment (read only)

Boolean – describes whether account code is available for use with expense claims

Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes

If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null.

Displays array of validation error messages from the API

Accounts

Bank Statements

Bank Transactions

UTC timestamp of creation date of bank transfer

The Bank Transaction ID for the source account

The Bank Transaction boolean to show if it is reconciled for the source account

Boolean to indicate if a Bank Transfer has an attachment

The Bank Transaction ID for the destination account

The Bank Transaction boolean to show if it is reconciled for the destination account

Bank Transfers

A user defined account number. This can be updated via the API and the Xero UI (max length = 50)

Store certain address types for a contact – see address types

Displays array of attachments from the API

The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only)

Bank details for use on a batch payment stored with each contact

Bank account number for use with Batch Payments

(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero.

(Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18

UTC timestamp of creation date of branding theme

The location of the image file used as the logo on this branding theme

Integer – ranked order of branding theme. The default branding theme has a value of 0

Company registration number (max length = 50)

Displays which contact groups a contact is included in

This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.

Current status of a contact – see contact status types

The default discount rate for the contact (read only)

Email address of contact person (umlauts not supported) (max length  = 255)

First name of contact person (max length = 255)

A boolean to indicate if a contact has an attachment

A boolean to indicate if a contact has an validation errors

true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact.

true or false – Boolean that describes if a contact that has any AP  invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts payable invoice is generated against this contact.

Last name of contact person (max length = 255)

ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber.

Full name of contact/organisation (max length = 255)

Store certain phone types for a contact – see phone types

The default purchases account code for contacts

The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

The default purchases tracking categories for contacts

The default sales account code for contacts

The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.

The default sales tracking categories for contacts

Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)

The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

Displays validation errors returned from the API

Contacts In Group

Contacts

ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)

The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used

The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation

Date when credit note was fully paid(UTC format)

boolean to indicate if a credit note has an attachment

A boolean to indicate if a credit note has an validation errors

Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types

ACCRECCREDIT only – additional reference number

The remaining credit balance on the Credit Note

boolean to indicate if a credit note has been sent to a contact via  the Xero app (currently read only)

The subtotal of the credit note excluding taxes

The total of the Credit Note(subtotal + total tax)

UTC timestamp of last update to the credit note

Displays array of warning messages from the API

Credit Notes

Sum of all credit notes, over-payments and pre-payments applied to invoice

Details of credit notes that have been applied to an invoice

The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6])

Date invoice was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation

Shown on sales invoices (Accounts Receivable) when this has been set

The date the invoice was fully paid. Only returned on fully paid invoices

boolean to indicate if an invoice has an attachment

A boolean to indicate if a invoice has an validation errors

Xero generated unique identifier for invoice

ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255)

boolean to indicate if an invoice has a discount

Shown on bills (Accounts Payable) when this has been set

ACCREC only – additional reference number

Xero generated unique identifier for repeating invoices

Boolean to set whether the invoice in the Xero app should be marked as “sent”. This can be set only on invoices that have been approved

Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts

Total of discounts applied on the invoice line items

URL link to a source document – shown as “Go to [appName]” in the Xero app

Invoices

The sales description of the item (max length = 4000)

The inventory asset account for the item. The account must be of type INVENTORY. The  COGSAccountCode in PurchaseDetails is also required to create a tracked item

Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled.

Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled.

True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set.

The purchase description of the item (max length = 4000)

Default account code to be used for purchased/sale. Not applicable to the purchase details of tracked items

Cost of goods sold account. Only applicable to the purchase details of tracked items.

Unit Price of the item. By default UnitPrice is rounded to two decimal places. You can use 4 decimal places by adding the unitdp=4 querystring parameter to your request.

The value of the item on hand. Calculated using average cost accounting.

Items

Journals

Display a unique key used for Xero-to-Xero transactions

Address details for organisation – see Addresses

Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)

Timestamp when the organisation was created in Xero

The default for LineAmountTypes on purchase transactions

The default for LineAmountTypes on sales transactions

BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing)

Organisation profile links for popular services such as Facebook,Twitter, GooglePlus and LinkedIn. You can also add link to your website here. Shown if Organisation settings  is updated in Xero. See ExternalLinks below

Boolean to describe if organisation is a demo company.

Description of business type as defined in Organisation settings

Display name of organisation shown in Xero

Will be set to ACTIVE if you can connect to organisation via the Xero API

Boolean to describe if organisation is registered with a local tax authority i.e. true, false

Phones details for organisation – see Phones

Shows for New Zealand, Australian and UK organisations

The accounting basis used for tax returns. See Sales Tax Basis

The frequency with which tax returns are processed. See Sales Tax Period

A unique identifier for the organisation. Potential uses.

Shown if set. Displays in the Xero UI as Tax File Number (AU), GST Number (NZ), VAT Number (UK) and Tax ID Number (US & Global).

Organisation

The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00

The suppliers bank account number the payment is being made to

The amount of the payment in the currency of the bank account.

Present if the payment was created as part of a batch.

Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value)

Number of invoice or credit note you are applying payment to e.g. INV-4003

Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500

Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06

The information to appear on the supplier's bank account

Number of invoice or credit note you are applying payment to e.g.INV-4003

An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET

The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used

The date the overpayment is created YYYY-MM-DD

boolean to indicate if a overpayment has an attachment

The remaining credit balance on the overpayment

The subtotal of the overpayment excluding taxes

The total of the overpayment (subtotal + total tax)

UTC timestamp of last update to the overpayment

The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used

The date the prepayment is created YYYY-MM-DD

boolean to indicate if a prepayment has an attachment

Returns Invoice number field. Reference field isn't available.

The remaining credit balance on the prepayment

The subtotal of the prepayment excluding taxes

The total of the prepayment(subtotal + total tax)

UTC timestamp of last update to the prepayment

An optional description for the payment e.g. Direct Debit

UTC timestamp of last update to the payment

Payments

Projects

The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used.

Date purchase order was issued – YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation

The address the goods are to be delivered to

Date the goods are to be delivered – YYYY-MM-DD

A free text feild for instructions (500 characters max)

The date the goods are expected to arrive.

boolean to indicate if a purchase order has an attachment

Xero generated unique identifier for purchase order

Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)

Boolean to set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed

The phone number for the person accepting the delivery

Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax)

Total of discounts applied on the purchase order line items

Purchase Orders

The currency rate for a multicurrency quote

Date quote was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation

QuoteID GUID is automatically generated and is returned after create or GET.

Unique alpha numeric code identifying a quote (Max Length = 255)

Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts

Total of discounts applied on the quote line items

Quotes

Boolean to describe if tax rate can be used for asset accounts i.e.  true,false

Boolean to describe if tax rate can be used for equity accounts i.e true,false

Boolean to describe if tax rate can be used for expense accounts  i.e. true,false

Boolean to describe if tax rate can be used for liability accounts  i.e. true,false

Boolean to describe if tax rate can be used for revenue accounts i.e. true,false

Effective Tax Rate (decimal to 4dp) e.g 12.5000

Tax Rates

Boolean to indicate if user is the subscriber

User role that defines permissions in Xero and via API (READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, etc)

Xero API Integration Profile

How to work with Contact Groups in Xero API

Operations on Contact Groups Collection

Build every single integration your customers need with AI

Field Name	API Key	Type	Description
Name	Name	string	The Name of the contact group. Required when creating a new contact group
Status	Status	string	The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs.
Contact Group Id	ContactGroupID	string	The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9
Contacts	Contacts	array of items	The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL.
Contact Id	item.ContactID	string