ESDRecordCustomerAccountPayment Class |
Ecommerce Standard Document that holds details of a payment made by a customer account for a given record type
Inheritance HierarchyNamespace: EcommerceStandardsDocuments
Assembly: EcommerceStandardsDocuments.Library (in EcommerceStandardsDocuments.Library.dll) Version: 1.5.0.0 (1.0.0.0)
The ESDRecordCustomerAccountPayment type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ESDRecordCustomerAccountPayment | Creates a Customer Account Payment Ecommerce Standard Document record |
Properties| Name | Description | |
|---|---|---|
 | creationDate | Date that the payment record was created. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone |
| currencyCode | ISO currency code that denotes the currency that all monetary amounts stored in the invoice with |
| customerAccountCode | Code of the customer account assigned to the invoice. |
| customerReference | Text, number or code that the customer uses to identify the payment record. This could be the customer's purchase order order, supplier invoice code, or an other identifier. |
| 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. |
| eCommerceSystemID | ID of the associated Ecommerce system where the payment was made from. |
| eCommerceUserID | ID of the user in the associated Ecommerce system where the payment was made from. |
| eCommerceUserName | Name of the user in the associated Ecommerce system where the payment was created. Ideally this is set to a label of the user, and not the credentials used for a user to login (since that could be a security issue passing around such information). |
| internalID | Stores an identifier that is relevant only to the system referencing and storing the record for its own needs. |
| keyCustomerAccountID | Key of the customer account record assigned to the payment. |
| keyCustomerAccountPaymentID | Key that allows the customer account payment record to be uniquely identified and linked to. |
| keyPaymentTypeID | Key of the payment type record that is associated to the payment. The payment type record indicates how the payment was made. |
| paymentAmount | Monetary amount of the payment |
| paymentCode | Code that allows the payment to be identified with. May or may not be unique. |
| paymentDate | Date of the payment record. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone |
| paymentID | ID that allows the payment to be identified with. May or may not be unique. |
| paymentMethod | Method on how the order is being paid for. The field must be set to one of the class's constants prefixed by PAYMENT_METHOD_ |
| paymentReceipt | text that contains a receipt number associated with the payment |
| records | list of records that the payment applies to |
| referenceNumber | Number set for reference purposes to the payment. |
| surcharges | list of surcharges that have been added to the payment |
Methods| Name | Description | |
|---|---|---|
| setDefaultValuesForNullMembers | sets default values for members that have no values set |
Fields| Name | Description | |
|---|---|---|
  | PAYMENT_METHOD_CREDIT | CREDIT - Payment was made with a credit card |
| PAYMENT_METHOD_DIRECTDEPOSIT | DIRECTDEPOSIT - Payment has been made with a direct bank transfer |
| PAYMENT_METHOD_NA | ACCOUNT - A payment was not applicable |
| PAYMENT_METHOD_PROPRIETARY | PROPRIETARY - A payment was made using a proprietary payment system. PayPal could be one example of this. |
| PAYMENT_METHOD_UNPAID | UNPAID - No payment was received as yet |
| RECORD_TYPE_BACKORDER | Record Type - Back Order |
| RECORD_TYPE_INVOICE | Record Type - Invoice |
| RECORD_TYPE_ORDER_PURCHASE | Record Type - Purchase Order |
| RECORD_TYPE_ORDER_SALE | Record Type - Sales Order |
See Also