Customer

Customer

A customer is an individual or business who purchases the goods or services. 

FieldTypeDescription
externalIdstringFriendly reference of the customer/reference of customer from an external system
idstringIdentifier for the customer, unique to the company in the accounting platform.
namestringName of the customer as recorded in the accounting system, typically the company name.
activebooleanCurrent state of the customer
currencystringCurrency the customer transacts in
creditLimitnumberCurrent credit limit of the customer.
descriptionstringAny additional information about the customer
webSitestringWeb address of the customer.
totalOutstandingAmountnumberAmount paid from the customer across all transactions.
totalPaidAmountnumberAmount paid by the customer across all transactions.
accountstringThe account linked to the customer in the accounting system.
createdDatedateDate the record was created in the accounting system.
endDatedateDate the customer stopped transacting as per accounting system.
languagestringLanguage the customer transacts in
modifiedDatedateDate the record was last updated in the accounting system.
priceLevelstringPrices of products valid for this customer.
taxCodestringDefault tax code to be applied to the customer.
taxIdstringTax number/registration number of the customer
corporateAddressobjectAn object of corporate addresses
contactobjectAn object of contact
billingAddressobjectAn object of billing addresses
shippingAddressobjectAn object of shipping addresses<
paymentTermsobjectAn object of payment terms applicable to the customer
parentobjectAn object of the parent company of the customer. Recorded only if the parent company is also a customer.
isubsidiaryobjectAn object of the subsidiary company of the customer. Recorded only if the subsidiary company is also a customer

corporateAddress

FieldTypeDescription
corporateAddress.citystringCity of customer's corporate address
corporateAddress.countrystringCountry of customer's corporate address
corporateAddress.idstringIdentifier of customer's corporate address in accounting system<
corporateAddress.line1
Address line1 of customer's corporate address
corporateAddress.line2stringAddress line2 of customer's corporate address
corporateAddress.phonestringPhone number of customer's corporate address
corporateAddress.postalCodestringPostal code of customer's corporate address
corporateAddress.provincestringProvince/State of customer's corporate address

contact
FieldTypeDescription
contact.address.citystringCity of primary contact at customer
contact.address.countrystringCountry of primary contact at customer
contact.address.line1stringAddress line1 of primary contact at customer
contact.address.line2stringAddress line2 of primary contact at customer
contact.address.postalCodestringPostal code of primary contact at customer
contact.address.provincestringProvince/State of primary contact at customer
contact.emailstringEmail ID of primary contact at customer
contact.faxstringFax of primary contact at customer
contact.middleNamestringMiddle name of primary contact at customer
contact.mobilestringMobile number of primary contact at customer
contact.salutationstringSalutation of primary contact at customer
contact.firstNamestringFirst name of primary contact at customer
contact.lastNamestringLast name of primary contact at customer
contact.phonestringPhone number of primary contact at customer

billingAddress

FieldTypeDescription
billingAddress.citystringCity of customer's billing address
billingAddress.contact.emailstringEmail of contact at customer's billing address
billingAddress.contact.firstNamestringFirst name of contact at customer's billing address
billingAddress.contact.lastNamestringLast name of contact at customer's billing address
billingAddress.contact.middleNamestringMiddle name of contact at customer's billing address
billingAddress.countrystringCountry of customer's billing address
billingAddress.idstringIdentifier of customer's billing address in accounting system
billingAddress.line1stringAddress line1 of customer's billing address
billingAddress.line2stringAddress line2 of customer's billing address
billingAddress.postalCodestringPostal code of customer's billing address
billingAddress.provincestringProvince of customer's billing address
billingAddress.phonestringPhone number of customer's billing address

shippingAddress

FieldTypeDescription
shippingAddress.citystringCity of customer's shipping address
shippingAddress.contact.emailstringEmail of contact at customer's shipping address
shippingAddress.contact.firstNamestringFirst name of contact at customer's shipping address
shippingAddress.contact.lastNamestringLast name of contact at customer's billing address
shippingAddress.contact.middleNamestringMiddle name of contact at customer's billing address
shippingAddress.countrystringCountry of customer's shipping address
shippingAddress.idstringIdentifier of customer's shipping address in accounting system
shippingAddress.line1stringAddress line1 of customer's shipping address
shippingAddress.line2stringAddress line2 of customer's shipping address
shippingAddress.provincestringProvince of customer's shipping address
shippingAddress.phonestringPhone number of customer's shipping address
shippingAddress.postalCodestringPostal code of customer's shipping address

paymentTerms

FieldTypeDescription
paymentTerms.idstringIdentifier of the payment terms.
paymentTerms.namestringName of the payment terms.

parent

FieldTypeDescription
parent.idstringIdentifier of the parent company of the customer.
parent.namestringName of the parent company of the customer.

subsidiary

FieldTypeDescription
subsidiary.idstringIdentifier of the subsidiary company of the customer.
subsidiary.namestringName of the subsidiary company of the customer.