Customer
Represents customers, including billing and financial settings, account health, payment options, pricing, and contact list details.
Columns
| Name | Type | ReadOnly | Description |
| accountGroup_Href | String | True |
The URL of the account group associated with this customer. |
| accountGroup_Id | String | False |
The Id of the account group associated with this customer. |
| accountGroup_Key | String | False |
The system-assigned key of the account group associated with this customer. |
| accountLabel_Href | String | True |
The URL of the account label associated with this customer. |
| accountLabel_Id | String | False |
The Id of the account label associated with this customer. |
| accountLabel_Key | String | False |
The system-assigned key of the account label associated with this customer. |
| activationDate | Date | True |
The date on which the customer record was activated. |
| advanceBillBy | String | False |
The number of periods to advance-bill this customer. |
| advanceBillByType | String | False |
The unit type used for advance billing this customer, such as days or months. |
| attachment_Href | String | True |
The URL of the attachment associated with this customer. |
| attachment_Id | String | False |
The Id of the attachment associated with this customer. |
| attachment_Key | String | False |
The system-assigned key of the attachment associated with this customer. |
| auditCreatedBy | String | True |
The user who created the customer record. |
| auditCreatedDateTime | Datetime | True |
The date and time when the customer record was created. |
| auditModifiedBy | String | True |
The user who last modified the customer record. |
| auditModifiedDateTime | Datetime | True |
The date and time when the customer record was last modified. |
| creditLimit | Decimal | False |
The credit limit amount for this customer. |
| currency | String | False |
The default currency used for this customer. |
| customerAccountHealthChurnRisk | Bool | False |
Indicates whether this customer is flagged as a churn risk. |
| customerAccountHealthHealthScore | Int | False |
The numeric health score assigned to this customer's account. |
| customerAccountHealthHealthStatus | String | False |
The health status of this customer's account, such as healthy, at-risk, or critical. |
| customerMessage_Href | String | True |
The URL of the customer message associated with this customer. |
| customerMessage_Id | String | False |
The Id of the customer message associated with this customer. |
| customerMessage_Key | String | False |
The system-assigned key of the customer message associated with this customer. |
| customerMessage_Message | String | False |
The text of the customer message displayed on transactions for this customer. |
| customerResaleNumber | String | False |
The resale number assigned to this customer for tax exemption purposes. |
| customerRestriction | String | False |
The restriction type applied to this customer, such as unrestricted or restricted to specific locations or departments. |
| customerType_Href | String | True |
The URL of the customer type associated with this customer. |
| customerType_Id | String | False |
The Id of the customer type associated with this customer. |
| customerType_Key | String | False |
The system-assigned key of the customer type associated with this customer. |
| defaultRevenueGLAccount_Href | String | True |
The URL of the default revenue GL account associated with this customer. |
| defaultRevenueGLAccount_Id | String | False |
The Id of the default revenue GL account associated with this customer. |
| defaultRevenueGLAccount_Key | String | False |
The system-assigned key of the default revenue GL account associated with this customer. |
| defaultRevenueGLAccount_Name | String | True |
The name of the default revenue GL account associated with this customer. |
| deliveryOptions | String | False |
The invoice delivery options configured for this customer, such as print or email. |
| discountPercent | String | False |
The default discount percentage applied to transactions for this customer. |
| electronicAddress | String | False |
The electronic address used for electronic invoice delivery for this customer. |
| emailOptIn | Bool | False |
Indicates whether this customer has opted in to receive email communications. |
| enableOnlineACHPayment | Bool | False |
Indicates whether online ACH payments are enabled for this customer. |
| enableOnlineCardPayment | Bool | False |
Indicates whether online card payments are enabled for this customer. |
| entity_Href | String | True |
The URL of the entity associated with this customer. |
| entity_Id | String | True |
The Id of the entity associated with this customer. |
| entity_Key | String | True |
The system-assigned key of the entity associated with this customer. |
| entity_Name | String | True |
The name of the entity associated with this customer. |
| href | String | True |
The URL of the customer resource. |
| id | String | False |
The unique identifier of the customer. |
| isOnHold | Bool | False |
Indicates whether this customer account is on hold. |
| isOneTimeUse | Bool | False |
Indicates whether this customer is designated as a one-time-use customer. |
| key [KEY] | String | True |
The system-assigned key that uniquely identifies the customer record. |
| lastInvoiceCreatedDate | Date | True |
The date on which the most recent invoice was created for this customer. |
| lastStatementGeneratedDate | Date | True |
The date on which the most recent statement was generated for this customer. |
| name | String | False |
The name of the customer. |
| notes | String | False |
The notes associated with this customer record. |
| nsp_billingcontact_customer_Key | String | False |
The system-assigned key of the billing contact relationship for this customer. |
| nsp_r10023_Key | String | False |
The system-assigned key of the nsp r10023 relationship for this customer. |
| nsp_r10149_Key | String | False |
The system-assigned key of the nsp r10149 relationship for this customer. |
| overrideOffsetGLAccount_Href | String | True |
The URL of the override offset GL account associated with this customer. |
| overrideOffsetGLAccount_Id | String | False |
The Id of the override offset GL account associated with this customer. |
| overrideOffsetGLAccount_Key | String | False |
The system-assigned key of the override offset GL account associated with this customer. |
| overrideOffsetGLAccount_Name | String | True |
The name of the override offset GL account associated with this customer. |
| overridePriceList | String | False |
The price list override setting for this customer. |
| parent_Href | String | True |
The URL of the parent customer associated with this customer. |
| parent_Id | String | False |
The Id of the parent customer associated with this customer. |
| parent_Key | String | False |
The system-assigned key of the parent customer associated with this customer. |
| parent_Name | String | True |
The name of the parent customer associated with this customer. |
| priceList_Href | String | True |
The URL of the price list associated with this customer. |
| priceList_Id | String | False |
The Id of the price list associated with this customer. |
| priceList_Key | String | False |
The system-assigned key of the price list associated with this customer. |
| priceSchedule_Href | String | True |
The URL of the price schedule associated with this customer. |
| priceSchedule_Id | String | False |
The Id of the price schedule associated with this customer. |
| priceSchedule_Key | String | False |
The system-assigned key of the price schedule associated with this customer. |
| resaleNumber | Decimal | False |
The resale number used for tax exemption purposes on this customer record. |
| restrictionsRestrictionType | String | False |
The restriction type applied to this customer for location and department access. |
| retainagePercentage | Decimal | False |
The default retainage percentage applied to invoices for this customer. |
| salesRepresentative_Href | String | True |
The URL of the sales representative associated with this customer. |
| salesRepresentative_Id | String | False |
The Id of the sales representative associated with this customer. |
| salesRepresentative_Key | String | False |
The system-assigned key of the sales representative associated with this customer. |
| salesRepresentative_Name | String | True |
The name of the sales representative associated with this customer. |
| shippingMethod_Href | String | True |
The URL of the shipping method associated with this customer. |
| shippingMethod_Id | String | False |
The Id of the shipping method associated with this customer. |
| shippingMethod_Key | String | False |
The system-assigned key of the shipping method associated with this customer. |
| status | String | False |
The current status of the customer, such as active or inactive. |
| subscriptionEndDate | Date | True |
The date on which the customer's subscription ends. |
| taxId | String | False |
The tax identifier for this customer. |
| term_Href | String | True |
The URL of the payment term associated with this customer. |
| term_Id | String | False |
The Id of the payment term associated with this customer. |
| term_Key | String | False |
The system-assigned key of the payment term associated with this customer. |
| territory_Href | String | True |
The URL of the territory associated with this customer. |
| territory_Id | String | False |
The Id of the territory associated with this customer. |
| territory_Key | String | False |
The system-assigned key of the territory associated with this customer. |
| territory_Name | String | False |
The name of the territory associated with this customer. |
| totalDue | Decimal | True |
The total outstanding amount due from this customer. |
| ListAggregate_ContactList | String | False |
The aggregate list of contacts associated with this customer. |
| ListAggregate_CustomerEmailTemplates | String | False |
The aggregate list of email templates associated with this customer. |
| ListAggregate_RestrictedDepartments | String | False |
The aggregate list of departments to which this customer is restricted. |
| ListAggregate_RestrictedLocations | String | False |
The aggregate list of locations to which this customer is restricted. |