Xero Accounting Endpoint: Contacts

Overview

The Xero Contacts endpoint allows you to access a simple list of contacts (both customers and suppliers) present within Xero.

This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many contacts.

In most situations, it is recommended to use the ContactsExpanded. It provides many additional fields and is also optimised for larger data files.

The following fields are available for the Contacts endpoint.

ContactID: A GUID field representing the internal id of an contact.; This field can be used to link to other endpoints.

ContactNumber: A text field that provides the contact number (appears as Contact Code in the Xero User Interface (UI).; This fields is used to enter a unique contact number for linking with external systems.

AccountNumber: A text field that provides the user defined account number (not chart of accounts related).

ContactStatus

A text field that indicates the status of the contact.

Possible values are:

ACTIVE: Indicate the contact can be used on transaction.
ARCHIVE: Indicates the contact cannot be used on transaction any longer but may have had historical transactions.
GDPRREQUEST: Indicates the contact is subject to the GDPR (General Data Protection Regulation) erasure (aka 'right to be forgotten') cannot be used on transaction any longer but may have had historical transactions.

SkypeUserName: A text field that provides the skype user name of the contact.

BankAccountDetails: A text field that provides the bank account number of the contact.

CompanyNumber

A text field that provides the business registration number of the contact.

This could either be:

TaxNumber

A text field that provides the tax number of the contact.

This could either be:

AccountsReceivableTaxType: A text field that indicates the default tax type for sales.

AccountsPayableTaxType: A text field that indicates the default tax type for purchases.

Addresses: A table field that provides the list of addresses for the contact.

Phones: A table field that provides the list of phone numbers for the contact.

IsSupplier: A true/false value that indicates if this contact can be used on purchases.

IsCustomer: A true/false value that indicates if this contact can be used on sales.

DefaultCurrency: A text field that provides the 3 digit ISO currency code.; This field can be linked to the Currencies endpoint.

BatchPayments: A record field that provides additional fields for when recording batch payements.; See BatchPayments Fields for more information.

Balances: A record field that provides the balance details for the contact.; See Balances Fields for more information.

HasAttachments: A true/false value that indicates if this contact has attachments uploaded.

UpdatedDateUTC: A date time field that indicates the last time this record was updated.

The BatchPayments Fields include the following sub fields.

BankAccountNumber: A text field that provides the bank account number of the contact.

BankAccountName: A text field that provides the bank account name of the contact.

Details: A text field that provides the details sent to a financial institution.

The Balances Fields includes the following sub-fields.

AccountsReceivable: A record field that provides the account receivable balance details for customer contacts.; See Balances.AccountsReceivable Fields for more information.

AccountsPayable: A record field that provides the account payables balance details for supplier contacts.; See Balances.AccountsPayable Fields for more information.