Global API
Request
Contact
10 min
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 https //docs breadwinner com/xero/contact#pd 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 https //docs breadwinner com/xero/contact#mj brandingthemewrapper default branding theme for contact paymentterms https //docs breadwinner com/xero/contact#cc paymenttermwrapper default payment terms for the contact salestrackingcategories trackingcategorywrapper https //docs breadwinner com/xero/contact#by trackingcategorywrapper the default sales tracking categories for contact purchasestrackingcategories trackingcategorywrapper https //docs breadwinner com/xero/contact#by trackingcategorywrapper the default purchases tracking categories for contact contactpersons contactpersonwrapper https //docs breadwinner com/xero/contact#rx contactpersonwrapper a contact can have a maximum of 5 contactpersons phones phonewrapper https //docs breadwinner com/xero/contact#dc phonewrapper store certain phone types for a contact balances balancewrapper https //docs breadwinner com/xero/contact#2j 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 https //docs breadwinner com/xero/contact#xw billsorsaleswrapper sales billsorsaleswrapper https //docs breadwinner com/xero/contact#xw 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 https //docs breadwinner com/xero/contact#ws accountbalancewrapper accountspayable accountbalancewrapper https //docs breadwinner com/xero/contact#ws accountbalancewrapper accountbalancewrapper field name data type description outstanding decimal overdue decimal