ESDRecordCustomerAccount Class |
Ecommerce Standards record that contains data for a single customer account. A customer account represents an entity (such as a person or organisation) that purchases from another entity where the account exists. The customer account may also known as a "debtor".
Inheritance HierarchyNamespace: EcommerceStandardsDocuments
Assembly: EcommerceStandardsDocuments.Library (in EcommerceStandardsDocuments.Library.dll) Version: 1.5.0.0 (1.0.0.0)
The ESDRecordCustomerAccount type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ESDRecordCustomerAccount | Initializes a new instance of the ESDRecordCustomerAccount class |
Properties| Name | Description | |
|---|---|---|
 | accountClass | Field that classifies the customer account. |
| accountName | Name of the account. |
| authorityNumberLabels | list of Labels set for the authority numbers. Ensure that the array length is the same as the authorityNumbers property, or left empty |
| authorityNumbers | list of numbers of the government, or any other entity records that is associated with the entity. Ensure that the array length is the same as the authorityNumberLabels property, or left empty |
| authorityNumberTypes | list of authority number types matching the authority numbers. If set must use the ESDocumentConstants that are prefixed with "AUTHORITY_NUM_". Ensure that the array length is the same as the authorityNumbers property, or left empty. |
| balance | Monetary balance of customer account. If the balance is negative then customer account owes money and is in debt, if the balance is positive then the customer account is owed money and is in credit. |
| contactName | Name of person associated to the account that can be contacted. |
| customerAccountCode | Code that allows the account to be identified with. May or may not be unique. |
| discount | Percentage amount that the the customer account receives off any applicable pricing. |
| drop | Data Record OPeration. Denotes an operation that may need to be performed on the record when it is being processed.
Set null, or set it to one of the ESD_RECORD_OPERATION constants in the ESDocumentConstants class to allow the record to be inserted, updated, deleted, or ignored. |
| Email address that may be used to contact the entity associated with the customer account. | |
| internalID | Stores an identifier that is relevant only to the system referencing and storing the record for its own needs. |
| isOnHold | Either 'N'-No or
'Y'-Yes
If 'Y' then indicates that the customer account is On Hold and may not be allowed to make any more purchases until it has paid its outstanding debts, or any other conditions. |
| isOutsideBalance | Either 'N'-No or
'Y'-Yes
If 'Y' then indicates that the customer account's debt balance is outside of its allowed credit limits. |
| isOutsideTerms | Either 'N'-No or
'Y'-Yes
If 'Y' then indicates that the customer account is operating outside of the payment terms of its debts, or other predefined terms. |
| keyCustomerAccountID | Key that allows the customer account record to be uniquely identified and linked to. In other records it may be referred to keyAccountID where appropriate. |
| keyGLAccountID | Key of the general ledger account that the customer account is assigned to. This links the customer account to a general ledger account that sales against it may be reported against for accounting purposes. |
| keyLocationIDs | list of Ley Location IDs that link any number of locations to the customer account. This may be used to control the locations where customer accounts can purchase from. |
| keyPaymentTypeIDs | A list of payment types that may be used to pay for the customer account's debts. Each key relates to a ESDRecordPaymentType record |
| keyPriceLevelID | Key of the Price Level record that the customer account is assigned to. The price level record may control the price-level pricing available to the account. |
| keySalesRepID | Key of the Sales Representative record that links a sales representative to the customer account. The assigned sales representative typically services the account. |
| limit | Maximum monetary amount that the customer account is allowed to purchase debts to. A positive amount denotes that the account's balance may be in placed in debt. A negative amount denots that the account's balance must stay within positive credit. |
| onHoldAction | Either 'OFF'
'BLOCK'
'WARN'
'WARNCC'
Sets the action to take if the customer account is being used while it is On Hold. Either it's blocked from further use (BLOCK), or is allowed to be used but a warning is displayed (WARN), or is allowed to be used but a warning is displayed and only new debts may be created when paid with credit card (WARNCC), or no actions need to be taken (OFF) |
| orgName | Name of the organisation associated to the account. |
| outCreditAction | Either 'OFF'
'BLOCK'
'WARN'
'WARNCC'
Sets the action to take if the customer account is being used while it is Outside Its Credit balance. Either it's blocked from further use (BLOCK), or is allowed to be used but a warning is displayed (WARN), or is allowed to be used but a warning is displayed and only new debts may be created when paid with credit card (WARNCC), or no actions need to be taken (OFF) |
| outTermsAction | Either 'OFF'
'BLOCK'
'WARN'
'WARNCC'
Sets the action to take if the customer account is being used while it is Outside Terms. Either it's blocked from further use (BLOCK), or is allowed to be used but a warning is displayed (WARN), or is allowed to be used but a warning is displayed and only new debts may be created when paid with credit card (WARNCC), or no actions need to be taken (OFF) |
| paymentTypes | A comma delimited list of payment types that may be used to pay for the customer account's debts. |
| phone | Primary phone number to contact the customer account's organisation or individual person. Its preferable to set phone numbers that can be dialled from anywhere internationally. |
| shippingMethod | Method that goods ordered by the customer account may be delivered by. |
| termsDescription | Readable description of the type of terms required by the customer accounts to pay off its debts |
| termsType | Either 'GND'-Given Number of Days
'DOM'-Date OF the Month
'NDAE'-Number of Days After the End of the month
'DMAE'-Date of the Month After the End of the month
'COD'-Cash On Delivery
'NA'-Not Applicable
Defines the type of terms required by the customer account to pay off its debts, and the length that the terms apply for. Use the ACCOUNT PAYMENT constants of the record to set this value.
|
| termsValue1 | First value that may be used to calculate the payment terms of the account |
| termsValue2 | Second value that may be used to calculate the payment terms of the account |
| territory | Name of the area that is customer account is associated to. |
Fields| Name | Description | |
|---|---|---|
  | ACCOUNT_PAYMENT_TERMS_CASH_ON_DELIVERY | Payment Terms - Cash On Delivery |
| ACCOUNT_PAYMENT_TERMS_DAY_OF_MONTH | Payment Terms - Day Of the Month |
| ACCOUNT_PAYMENT_TERMS_DAY_OF_MONTH_AFTER_DAY_OF_MONTH | Payment Terms - Date of the Month After the End of the month |
| ACCOUNT_PAYMENT_TERMS_GIVEN_NO_DAYS | Payment Terms - Given Number of Days |
| ACCOUNT_PAYMENT_TERMS_NA | Payment Terms - Not Applicable |
| ACCOUNT_PAYMENT_TERMS_NO_DAYS_AFTER_END_OF_MONTH | Payment Terms - Number of Days After the End of the month |
See Also