Xero Accounting Endpoint: ContactsExpanded
Overview
The Xero Contacts endpoint allows you to access the complete list of contacts (both customers and suppliers) present within Xero.
This endpoints provides access to all fields and details. It is also optimised for larger data files.
In most situations, it is recommended to use this endpoint instead of the Contacts endpoint.
Fields
The following fields are available for the Accounts 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.
- Name
- A text field that provides the full contact name.
- FirstName
- A text field that provides the first name of the contact.
- LastName
- A text field that provides the last name of the contact.
- EmailAddress
- A text field that provides the email address of the contact.
- SkypeUserName
- A text field that provides the skype user name of the contact.
- Website
- A text field that provides the website url 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:
- ACN (for Australia)
- NZBN (for New Zealand)
- Business Registration Number (for UK)
- Business Registration Number (for all other regions)
- TaxNumber
- A text field that provides the tax number of the contact.
- This could either be:
- ABN (for Australia)
- GST Number (for New Zealand)
- VAT Number (for UK)
- Tax ID Number (for all other regions)
- 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.
- ContactGroups
- A table field that provides the list of contact groups assigned to 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.
- Discount
- A decimal field that provides the default discount rate provided to this contact.
- BrandingTheme
- A record field that provides the default branding theme associated with the contact.
- SalesDefaultAccountCode
- A text field that provides the default account code used for sales.
- This field can be linked to the Accounts endpoint.
- SalesTrackingCategories
- A record field that provides the list of tracking category options linked to this contact for selling purposes.
- PurchasesTrackingCategories
- A record field that provides the list of tracking category options linked to this contact for purchasing purposes.
- BatchPayments
- A record field that provides additional fields for when recording batch payements.
- See BatchPayments Fields for more information.
- PaymentTerms
- A record field that provides payment terms information.
- See BatchPayments Fields for more information.
- Balances
- A record field that provides the balance details for the contact.
- See Balances Fields for more information.
- ContactPersons
- A table field that provides the list of contact persons for a given contact.
- See ContactPersons Fields for more information.
- XeroNetworkKey
- A text field that provides xero network key for a given contact.
- 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.
BatchPayments Fields
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.
PaymentTerms Fields
The PaymentTerms Fields include the following sub fields.
- Bills
- A record field provides further information for payment terms for purchases.
- See PaymentTerms.Bills Fields for more information.
- Sales
- A record field provides further information for payment terms for sales.
- See PaymentTerms.Sales Fields for more information.
PaymentTerms.Bills Fields
The PaymentTerms.Bills Fields include the following sub fields.
- Day
- A whole number field that indicates the day of the month.
- Type
- A text field that indicates how the day field is applied.
- Possible values are:
- DAYSAFTERBILLDATE: x days after bill date
- DAYSAFTERBILLMONTH: x days after bill month
- OFCURRENTMONTH: on a specific day of the current month
- OFFOLLOWINGMONTH: on a specific day of the following month
PaymentTerms.Sales Fields
The PaymentTerms.Sales Fields include the following sub fields.
- Day
- A whole number field that indicates the day of the month.
- Type
- A text field that indicates how the day field is applied.
- Possible values are:
- DAYSAFTERBILLDATE: x days after bill date
- DAYSAFTERBILLMONTH: x days after bill month
- OFCURRENTMONTH: on a specific day of the current month
- OFFOLLOWINGMONTH: on a specific day of the following month
Balances Fields
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.
Balances.AccountsReceivable Fields
The Balances.AccountsReceivable Fields includes the following sub-fields.
- Outstanding
- A decimal field that provides the total outstanding balance this customer owes.
- Overdue
- A decimal field that provides the portion of ouststanding balance this customer owes that is overdue.
Balances.AccountsPayable Fields
The Balances.AccountsPayable Fields includes the following sub-fields.
- Outstanding
- A decimal field that provides the total outstanding balance owed to this supplier.
- Overdue
- A decimal field that provides the portion of ouststanding balance owed to this supplier that is overdue
ContactPersons Fields
The ContactPersons Fields includes the following sub-fields.
- FirstName
- A text field that provides the first name of the contact person.
- LastName
- A text field that provides the last name of the contact person.
- EmailAddress
- A text field that provides the email address of the contact person.
- IncludeInEmails
- A true/false value that indicates if this contact person is included in emails or not.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields