Customer
A customer is an individual or business who purchases the goods or services.
Field | Type | Description |
---|---|---|
externalId | string | Friendly reference of the customer/reference of customer from an external system |
id | string | Identifier for the customer, unique to the company in the accounting platform. |
name | string | Name of the customer as recorded in the accounting system, typically the company name. |
active | boolean | Current state of the customer |
currency | string | Currency the customer transacts in |
creditLimit | number | Current credit limit of the customer. |
description | string | Any additional information about the customer |
webSite | string | Web address of the customer. |
totalOutstandingAmount | number | Amount paid from the customer across all transactions. |
totalPaidAmount | number | Amount paid by the customer across all transactions. |
account | string | The account linked to the customer in the accounting system. |
createdDate | date | Date the record was created in the accounting system. |
endDate | date | Date the customer stopped transacting as per accounting system. |
language | string | Language the customer transacts in |
modifiedDate | date | Date the record was last updated in the accounting system. |
priceLevel | string | Prices of products valid for this customer. |
taxCode | string | Default tax code to be applied to the customer. |
taxId | string | Tax number/registration number of the customer |
corporateAddress | object | An object of corporate addresses |
contact | object | An object of contact |
billingAddress | object | An object of billing addresses |
shippingAddress | object | An object of shipping addresses< |
paymentTerms | object | An object of payment terms applicable to the customer |
parent | object | An object of the parent company of the customer. Recorded only if the parent company is also a customer. |
isubsidiary | object | An object of the subsidiary company of the customer. Recorded only if the subsidiary company is also a customer |
corporateAddress
Field | Type | Description |
corporateAddress.city | string | City of customer's corporate address |
corporateAddress.country | string | Country of customer's corporate address |
corporateAddress.id | string | Identifier of customer's corporate address in accounting system< |
corporateAddress.line1 | Address line1 of customer's corporate address | |
corporateAddress.line2 | string | Address line2 of customer's corporate address |
corporateAddress.phone | string | Phone number of customer's corporate address |
corporateAddress.postalCode | string | Postal code of customer's corporate address |
corporateAddress.province | string | Province/State of customer's corporate address |
contact
Field | Type | Description |
contact.address.city | string | City of primary contact at customer |
contact.address.country | string | Country of primary contact at customer |
contact.address.line1 | string | Address line1 of primary contact at customer |
contact.address.line2 | string | Address line2 of primary contact at customer |
contact.address.postalCode | string | Postal code of primary contact at customer |
contact.address.province | string | Province/State of primary contact at customer |
contact.email | string | Email ID of primary contact at customer |
contact.fax | string | Fax of primary contact at customer |
contact.middleName | string | Middle name of primary contact at customer |
contact.mobile | string | Mobile number of primary contact at customer |
contact.salutation | string | Salutation of primary contact at customer |
contact.firstName | string | First name of primary contact at customer |
contact.lastName | string | Last name of primary contact at customer |
contact.phone | string | Phone number of primary contact at customer |
billingAddress
Field | Type | Description |
billingAddress.city | string | City of customer's billing address |
billingAddress.contact.email | string | Email of contact at customer's billing address |
billingAddress.contact.firstName | string | First name of contact at customer's billing address |
billingAddress.contact.lastName | string | Last name of contact at customer's billing address |
billingAddress.contact.middleName | string | Middle name of contact at customer's billing address |
billingAddress.country | string | Country of customer's billing address |
billingAddress.id | string | Identifier of customer's billing address in accounting system |
billingAddress.line1 | string | Address line1 of customer's billing address |
billingAddress.line2 | string | Address line2 of customer's billing address |
billingAddress.postalCode | string | Postal code of customer's billing address |
billingAddress.province | string | Province of customer's billing address |
billingAddress.phone | string | Phone number of customer's billing address |
shippingAddress
Field | Type | Description |
shippingAddress.city | string | City of customer's shipping address |
shippingAddress.contact.email | string | Email of contact at customer's shipping address |
shippingAddress.contact.firstName | string | First name of contact at customer's shipping address |
shippingAddress.contact.lastName | string | Last name of contact at customer's billing address |
shippingAddress.contact.middleName | string | Middle name of contact at customer's billing address |
shippingAddress.country | string | Country of customer's shipping address |
shippingAddress.id | string | Identifier of customer's shipping address in accounting system |
shippingAddress.line1 | string | Address line1 of customer's shipping address |
shippingAddress.line2 | string | Address line2 of customer's shipping address |
shippingAddress.province | string | Province of customer's shipping address |
shippingAddress.phone | string | Phone number of customer's shipping address |
shippingAddress.postalCode | string | Postal code of customer's shipping address |
paymentTerms
Field | Type | Description |
paymentTerms.id | string | Identifier of the payment terms. |
paymentTerms.name | string | Name of the payment terms. |
parent
Field | Type | Description |
parent.id | string | Identifier of the parent company of the customer. |
parent.name | string | Name of the parent company of the customer. |
subsidiary
Field | Type | Description |
subsidiary.id | string | Identifier of the subsidiary company of the customer. |
subsidiary.name | string | Name of the subsidiary company of the customer. |