Customer
Customer in the requestJSON and responseJSON are in the form of List of Customer objects.
The Customer object has the following parameters.
| Field Name | Data Type | Description |
|---|
| salesforceID | ID | Read-Only field, provides the Salesforce Record ID upon successful creation or updation in Salesforce. |
| accountNumber | String | |
| addressbookList | AddressBooks | |
| category | LookupRecord | Internal ID of the Category. |
| companyName | String | The Name of the Customer. Required when isPerson is set to FALSE. |
| creditHoldOverride | String | |
| creditLimit | Double | |
| currencyRecord | LookupRecord | Internal ID of the (Primary) Currency. |
| currencyList | CurrencyListDetail | |
| customFieldList | CustomFields | Custom fields and their values. |
| customForm | LookupRecord | Internal ID of the Custom Form. |
| dateCreated | Long | Read-Only field, the Date will be returned as a Unix timestamp in seconds. |
| email | String | |
| endDate | Long | Date is accepted and returned as a Unix timestamp in seconds. |
| entityId | String | Read-Only field and is auto-populated from the Company Name or the First Name. |
| entityStatus | LookupRecord | Internal ID of the Entity (customer) Status. |
| externalId | String | |
| fax | String | |
| firstName* | String | Required when isPerson is set to TRUE |
| internalId | String | |
| isInactive | Boolean | |
| isPerson | Boolean | |
| lastModifiedDate | Long | Read-Only field and the Date is returned as a Unix timestamp in seconds. |
| lastName* | String | Required when isPerson is set to TRUE |
| middleName | String | Given when isPerson is set to TRUE |
| parent | LookupRecord | Internal ID of the Parent Company. |
| phone | String | |
| priceLevel | LookupRecord | Internal ID of the Price Level. |
| receivablesAccount | LookupRecord | Internal ID of the Receivables Account. |
| reminderDays | Double | |
| resaleNumber | String | |
| salesRep | LookupRecord | Internal ID of the Employee. |
| salutation | String | |
| stage | String | Read-Only field and entityStatus determines its value. |
| startDate | Long | Date is accepted and returned as a Unix timestamp in seconds. |
| subsidiary* | LookupRecord | Internal ID of Subsidiary. |
| taxItem | LookupRecord | Internal ID of Tax Item. |
| terms | LookupRecord | Internal ID of Terms. |
| territory | LookupRecord | Internal ID of Territory. |
| title | String | Given when isPerson is set to TRUE |
| url | String | Given when isPerson is set to FALSE |
| vatRegNumber | String | |
AddressBooks
| Field Name | Data Type | Description |
|---|
| addressbook | AddressBookDetail[] | |
| replaceAll | Boolean | Replaces all Customer addresses when set to TRUE while updating the Customer |
AddressBookDetail
| Field Name | Data Type | Description |
|---|
| addressbookAddress | AddressDetail | Address Info |
| defaultBilling | Boolean | Sets the address as a default billing one. |
| defaultShipping | Boolean | Sets the address as a default shipping one. |
| internalId | String | |
| isResidential | Boolean | |
| label | String | |
AddressDetail
| Field Name | Data Type | Description |
|---|
| addr1 | String | Address Line 1 |
| addr2 | String | Address Line 2 |
| addr3 | String | Address Line 3 |
| addrPhone | String | Phone Number |
| addressee | String | |
| attention | String | |
| city | String | |
| country | String | |
| internalId | String | Internal ID of existing Address |
| state | String | State/Province |
| zip | String | |
CurrencyListDetail
| Field Name | Data Type | Description |
|---|
| currencyRecord | CurrencyDetail[] | List of Currencies |
CurrencyDetail
| Field Name | Data Type | Description |
|---|
| currencyRecord | LookupRecord | Currency Info |
LookupRecord
| Field Name | Data Type | Description |
|---|
| externalId | String | Read-Only, returns the external Id of the Record selected. |
| internalId* | String | Internal Id of the Record or List. |
| name | String | Read-Only, returns the name of the Record selected. |
| type | String | Read-Only. |
CustomFields
| Field Name | Data Type | Description |
|---|
| customField | CustomFieldInfo[] | List of CustomField Info |
CustomFieldInfo
| Field Name | Data Type | Description |
|---|
| fieldType* | String | Specifies the Data Type of a Custom field.Possible values are: string, boolean, date, double, long, select. |
| internalId | String | InternalId of the Custom Field. |
| scriptId* | String | Script ID of the Custom Field. |
| value | String | Required and returned for all the custom fields other than “select” (fieldType) |
| valueLookup | LookupRecord | Required and returned for the fieldType “select” |
Table of contents