Contact

10min

In Xero, the "Contact" object includes both Customers and Suppliers.  A Contact is said to be a Customer or Supplier or Both based on the two boolean fields "IsCustomer" and "IsSupplier".
When requesting an Contact, use the requestJSON to pass the Contact data, and the response will have responseJSON which stores the Contacts response returned by Xero.
The Contact object has the following parameters.
Field Name
Data Type 
Description
Addresses
﻿AddressWrapper﻿
﻿
Name
String
Full Name of Contact/Organization
DefaultCurrency
String
The default currency for raising Invoices against contact
AccountNumber
String
A user defined account number
ContactStatus
String
Current status of a contact such as "ACTIVE", "ARCHIVED", "GDPRREQUEST"
SkypeUserName
String
Skype user name of contact
EmailAddress
String
Email address of contact person
LastName
String
Last name of the contact person
FirstName
String
First name of contact person
ContactID
String
Read-Only; Unique identifier for this object
TaxNumber
String
Tax number of contact - this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) 
AccountsReceivableTaxType
String
Default tax type used for contact on AR invoices
AccountsPayableTaxType
String
Default tax type used for contact on AP invoices (Bills and POs)
IsSupplier
Boolean
Read-Only; it is automatically set when an accounts payable invoice is generated against this contact.
IsCustomer
Boolean
Read-Only; it is automatically set when an accounts receivable invoice is generated against this contact
SalesDefaultAccountCode
String
The default sale account code for contacts
PurchasesDefaultAccountCode
String
The default purchases account code for contacts
Discount
Decimal
The default discount rate for the contact
BrandingTheme
﻿BrandingThemeWrapper﻿
Default branding theme for contact
PaymentTerms
﻿PaymentTermWrapper﻿
Default payment terms for the contact
SalesTrackingCategories
﻿TrackingCategoryWrapper﻿
The default sales tracking categories for contact
PurchasesTrackingCategories
﻿TrackingCategoryWrapper﻿
The default purchases tracking categories for contact
ContactPersons
﻿ContactPersonWrapper﻿
A contact can have a maximum of 5 ContactPersons
Phones
﻿PhoneWrapper﻿
Store certain phone types for a contact
Balances
﻿BalanceWrapper﻿
The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, converted to base currency
Website
String
Website address for Website address for contact
Salesforce_Account_Id
String
To link the Customer with the Salesforce Account
AddressWrapper
Field Name
Data Type
Description
AddressType
String
﻿
AddressLine1
String
﻿
AddressLine2
String
﻿
AddressLine3
String
﻿
AddressLine4
String
﻿
City
String
﻿
Region
String
﻿
PostalCode
String
﻿
Country
String
﻿
AttentionTo
String
﻿
BrandingThemeWrapper
Field Name
Data Type
Description
BrandingThemeID
String
﻿
Name
String
﻿
PaymentTermWrapper
Field Name
Data Type
Description
Bills
﻿BillsOrSalesWrapper﻿
﻿
Sales
﻿BillsOrSalesWrapper﻿
﻿
BillsOrSalesWrapper
Field Name
Data Type
Description
Day
Integer
﻿
Type
String
﻿
TrackingCategoryWrapper
Field Name
Data Type
Description
TrackingCategoryName
String
﻿
TrackingOptionName
String
﻿
ContactPersonWrapper
Field Name
Data Type
Description
FirstName
String
﻿
LastName
String
﻿
EmailAddress
String
﻿
IncludeInEmails
Boolean
﻿
PhoneWrapper
Field Name
Data Type
Description
PhoneType
String
﻿
PhoneNumber
String
﻿
PhoneAreaCode
String
﻿
PhoneCountryCode
String
﻿
BalanceWrapper
Field Name
Data Type
Description
AccountsReceivable
﻿AccountBalanceWrapper﻿
﻿
AccountsPayable
﻿AccountBalanceWrapper﻿
﻿
AccountBalanceWrapper
Field Name
Data Type
Description
Outstanding
Decimal
﻿
Overdue
Decimal
﻿
﻿

Field Name	Data Type	Description
Addresses	AddressWrapper
Name	String	Full Name of Contact/Organization
DefaultCurrency	String	The default currency for raising Invoices against contact
AccountNumber	String	A user defined account number
ContactStatus	String	Current status of a contact such as "ACTIVE", "ARCHIVED", "GDPRREQUEST"
SkypeUserName	String	Skype user name of contact
EmailAddress	String	Email address of contact person
LastName	String	Last name of the contact person
FirstName	String	First name of contact person
ContactID	String	Read-Only; Unique identifier for this object
TaxNumber	String	Tax number of contact - this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK)
AccountsReceivableTaxType	String	Default tax type used for contact on AR invoices
AccountsPayableTaxType	String	Default tax type used for contact on AP invoices (Bills and POs)
IsSupplier	Boolean	Read-Only; it is automatically set when an accounts payable invoice is generated against this contact.
IsCustomer	Boolean	Read-Only; it is automatically set when an accounts receivable invoice is generated against this contact
SalesDefaultAccountCode	String	The default sale account code for contacts
PurchasesDefaultAccountCode	String	The default purchases account code for contacts
Discount	Decimal	The default discount rate for the contact
BrandingTheme	BrandingThemeWrapper	Default branding theme for contact
PaymentTerms	PaymentTermWrapper	Default payment terms for the contact
SalesTrackingCategories	TrackingCategoryWrapper	The default sales tracking categories for contact
PurchasesTrackingCategories	TrackingCategoryWrapper	The default purchases tracking categories for contact
ContactPersons	ContactPersonWrapper	A contact can have a maximum of 5 ContactPersons
Phones	PhoneWrapper	Store certain phone types for a contact
Balances	BalanceWrapper	The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, converted to base currency
Website	String	Website address for Website address for contact
Salesforce_Account_Id	String	To link the Customer with the Salesforce Account

Field Name	Data Type	Description
AddressType	String
AddressLine1	String
AddressLine2	String
AddressLine3	String
AddressLine4	String
City	String
Region	String
PostalCode	String
Country	String
AttentionTo	String

Field Name	Data Type	Description
BrandingThemeID	String
Name	String

Field Name	Data Type	Description
Bills	BillsOrSalesWrapper
Sales	BillsOrSalesWrapper

Field Name	Data Type	Description
Day	Integer
Type	String

Field Name	Data Type	Description
TrackingCategoryName	String
TrackingOptionName	String

Field Name	Data Type	Description
FirstName	String
LastName	String
EmailAddress	String
IncludeInEmails	Boolean

Field Name	Data Type	Description
PhoneType	String
PhoneNumber	String
PhoneAreaCode	String
PhoneCountryCode	String

Field Name	Data Type	Description
AccountsReceivable	AccountBalanceWrapper
AccountsPayable	AccountBalanceWrapper

Field Name	Data Type	Description
Outstanding	Decimal
Overdue	Decimal

Updated 18 Apr 2023

Did this page help you?

Request

Read