Xero Accounting Endpoint: ContactsExpandedTable
Jump to navigation
Jump to search
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.
Note this endpoint is an alternate format of the ContactsExpanded endpoint. It provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.
Fields
The following fields are available for the Accounts endpoint.
- DataFileID
- A guid field that provides the id of the data file as setup in OdataLink.
- DataFileName
- A text field provides the name of the data file as setup in OdataLink.
- DataFileCode
- A text field provides the code of the data file as setup in OdataLink.
- 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.
- BillingAddressAttentionTo
- A text field provides the name of the recipient on the billing address.
- BillingAddressLine1
- A text field provides the first line of the billing address.
- BillingAddressLine2
- A text field provides the second line of the billing address.
- BillingAddressLine3
- A text field provides the third line of the billing address.
- BillingAddressLine4
- A text field provides the fourth line of the billing address.
- BillingAddressCity
- A text field provides the city of the billing address.
- BillingAddressRegion
- A text field provides the state, province or region of the billing address.
- BillingAddressPostalCode
- A text field provides the postal code or zip code of the billing address.
- BillingAddressCountry
- A text field provides the country of the billing address.
- PostalAddressAttentionTo
- A text field provides the name of the recipient on the Postal address.
- PostalAddressLine1
- A text field provides the first line of the Postal address.
- PostalAddressLine2
- A text field provides the second line of the Postal address.
- PostalAddressLine3
- A text field provides the third line of the Postal address.
- PostalAddressLine4
- A text field provides the fourth line of the Postal address.
- PostalAddressCity
- A text field provides the city of the Postal address.
- PostalAddressRegion
- A text field provides the state, province or region of the Postal address.
- PostalAddressPostalCode
- A text field provides the postal code or zip code of the Postal address.
- PostalAddressCountry
- A text field provides the country of the Postal address.
- PhoneNumber
- A text field provides the phone number.
- PhoneAreaCode
- A text field provides the area code of the phone number.
- PhoneCountryCode
- A text field provides the country code of the phone number.
- MobileNumber
- A text field provides the mobile or cell phone number.
- MobileAreaCode
- A text field provides the area code of the mobile or cell phone number.
- MobileCountryCode
- A text field provides the country code of the mobile or cell phone number.
- DirectNumber
- A text field provides the direct phone number.
- DirectAreaCode
- A text field provides the area code of the direct phone number.
- DirectCountryCode
- A text field provides the country code of the direct phone number.
- FaxNumber
- A text field provides the fax number.
- FaxAreaCode
- A text field provides the area code of the fax number.
- FaxCountryCode
- A text field provides the country code of the fax number.
- 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.
- BrandingThemeID
- A GUID field representing the internal id of a branding theme applied to this contact.
- BrandingThemeName
- A text field provides the name of the branding theme applied to this contact.
- PurchasesDefaultAccountCode
- A text field that provides the default account code used for purchases.
- This field can be linked to the Accounts endpoint.
- PurchasesTrackingCategoryName1
- A text field provides the name of the first tracking category for purchases.
- PurchasesTrackingOptionName1
- A text field provides the option of the first tracking category for purchases.
- PurchasesTrackingCategoryName2
- A text field provides the name of the second tracking category for purchases.
- PurchasesTrackingOptionName2
- A text field provides the option of the second tracking category for purchases.
- PurchasesDefaultLineAmountType
- A text field that provides the type of line (inc or ex) for purchases.
- SalesDefaultAccountCode
- A text field that provides the default account code used for sales.
- This field can be linked to the Accounts endpoint.
- SalesTrackingCategoryName1
- A text field provides the name of the first tracking category for sales.
- SalesTrackingOptionName1
- A text field provides the option of the first tracking category for sales.
- SalesTrackingCategoryName2
- A text field provides the name of the second tracking category for sales.
- SalesTrackingOptionName2
- A text field provides the option of the second tracking category for sales.
- SalesDefaultLineAmountType
- A text field that provides the type of line (inc or ex) for sales.
- BatchPaymentsBankAccountNumber
- A text field that provides the bank account number of the contact when making batch payments.
- BatchPaymentsBankAccountName
- A text field that provides the bank account name of the contact when making batch payments.
- BatchPaymentsDetails
- A text field that provides the details sent to a financial institution when making batch payments.
- BatchPaymentsCode
- A text field that provides the code when making batch payments.
- BatchPaymentsReference
- A text field that provides the reference when making batch payments.
- PaymentTermsBillsDay
- A whole number field that indicates the day of the month terms for purchases.
- PaymentTermsBillsType
- A text field that indicates how the day field is applied for terms for purchases.
- 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
- PaymentTermsSalesDay
- A whole number field that indicates the day of the month terms for sales.
- PaymentTermsSalesType
- A text field that indicates how the day field is applied for terms for sales.
- 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
- AccountsReceivableOutstanding
- A decimal field that provides the total outstanding balance this customer owes.
- AccountsReceivableOverdue
- A decimal field that provides the portion of ouststanding balance this customer owes that is overdue.
- AccountsPayableOutstanding
- A decimal field that provides the total outstanding balance owed to this supplier.
- AccountsPayableOverdue
- A decimal field that provides the portion of ouststanding balance owed to this supplier that is overdue.
- ContactPerson1FirstName
- A text field that provides the first name of the 1st contact person.
- ContactPerson1LastName
- A text field that provides the last name of the 1st contact person.
- ContactPerson1EmailAddress
- A text field that provides the email address of the 1st contact person.
- ContactPerson1IncludeInEmails
- A true/false value that indicates if this 1st contact person is included in emails or not.
- ContactPerson2FirstName
- A text field that provides the first name of the 2nd contact person.
- ContactPerson2LastName
- A text field that provides the last name of the 2nd contact person.
- ContactPerson2EmailAddress
- A text field that provides the email address of the 2nd contact person.
- ContactPerson2IncludeInEmails
- A true/false value that indicates if this 2nd contact person is included in emails or not.
- ContactPerson3FirstName
- A text field that provides the first name of the 3rd contact person.
- ContactPerson3LastName
- A text field that provides the last name of the 3rd contact person.
- ContactPerson3EmailAddress
- A text field that provides the email address of the 3rd contact person.
- ContactPerson3IncludeInEmails
- A true/false value that indicates if this 3rd contact person is included in emails or not.
- ContactPerson4FirstName
- A text field that provides the first name of the 4th contact person.
- ContactPerson4LastName
- A text field that provides the last name of the 4th contact person.
- ContactPerson4EmailAddress
- A text field that provides the email address of the 4th contact person.
- ContactPerson4IncludeInEmails
- A true/false value that indicates if this 4th contact person is included in emails or not.
- ContactPerson5FirstName
- A text field that provides the first name of the 5th contact person.
- ContactPerson5LastName
- A text field that provides the last name of the 5th contact person.
- ContactPerson5EmailAddress
- A text field that provides the email address of the 5th contact person.
- ContactPerson5IncludeInEmails
- A true/false value that indicates if this 5th contact person is included in emails or not.
- 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.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Endpoints
- Contacts
- Accounts
- BankTransactions
- BankTransactionsExpanded
- CreditNotes
- CreditNotesExpanded
- Currencies
- Invoices
- InvoicesExpanded
- Overpayments
- OverpaymentsExpanded
- Prepayments
- PrepaymentsExpanded
- Projects
- PurchaseOrders
- Quotes
- RepeatingInvoices
- TaxRates