Click or drag to resize

ESDRecordCustomerAccountPayment Class

Ecommerce Standard Document that holds details of a payment made by a customer account for a given record type
Inheritance Hierarchy
SystemObject
  EcommerceStandardsDocumentsESDRecordCustomerAccountPayment

Namespace:  EcommerceStandardsDocuments
Assembly:  EcommerceStandardsDocuments.Library (in EcommerceStandardsDocuments.Library.dll) Version: 1.3.0.0 (1.0.0.0)

The ESDRecordCustomerAccountPayment type exposes the following members.

Constructors
  NameDescription
Public methodESDRecordCustomerAccountPayment
Creates a Customer Account Payment Ecommerce Standard Document record
Top
Properties
  NameDescription
Public propertycreationDate
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
Public propertycurrencyCode
ISO currency code that denotes the currency that all monetary amounts stored in the invoice with
Public propertycustomerAccountCode
Code of the customer account assigned to the invoice.
Public propertycustomerReference
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.
Public propertydrop
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.
Public propertyeCommerceSystemID
ID of the associated Ecommerce system where the payment was made from.
Public propertyeCommerceUserID
ID of the user in the associated Ecommerce system where the payment was made from.
Public propertyeCommerceUserName
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).
Public propertyinternalID
Stores an identifier that is relevant only to the system referencing and storing the record for its own needs.
Public propertykeyCustomerAccountID
Key of the customer account record assigned to the payment.
Public propertykeyCustomerAccountPaymentID
Key that allows the customer account payment record to be uniquely identified and linked to.
Public propertykeyPaymentTypeID
Key of the payment type record that is associated to the payment. The payment type record indicates how the payment was made.
Public propertypaymentAmount
Monetary amount of the payment
Public propertypaymentCode
Code that allows the payment to be identified with. May or may not be unique.
Public propertypaymentDate
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
Public propertypaymentID
ID that allows the payment to be identified with. May or may not be unique.
Public propertypaymentMethod
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_
Public propertypaymentReceipt
text that contains a receipt number associated with the payment
Public propertyrecords
list of records that the payment applies to
Public propertyreferenceNumber
Number set for reference purposes to the payment.
Public propertysurcharges
list of surcharges that have been added to the payment
Top
Methods
  NameDescription
Public methodsetDefaultValuesForNullMembers
sets default values for members that have no values set
Top
Fields
  NameDescription
Public fieldStatic memberPAYMENT_METHOD_CREDIT
CREDIT - Payment was made with a credit card
Public fieldStatic memberPAYMENT_METHOD_DIRECTDEPOSIT
DIRECTDEPOSIT - Payment has been made with a direct bank transfer
Public fieldStatic memberPAYMENT_METHOD_NA
ACCOUNT - A payment was not applicable
Public fieldStatic memberPAYMENT_METHOD_PROPRIETARY
PROPRIETARY - A payment was made using a proprietary payment system. PayPal could be one example of this.
Public fieldStatic memberPAYMENT_METHOD_UNPAID
UNPAID - No payment was received as yet
Public fieldStatic memberRECORD_TYPE_BACKORDER
Record Type - Back Order
Public fieldStatic memberRECORD_TYPE_INVOICE
Record Type - Invoice
Public fieldStatic memberRECORD_TYPE_ORDER_PURCHASE
Record Type - Purchase Order
Public fieldStatic memberRECORD_TYPE_ORDER_SALE
Record Type - Sales Order
Top
See Also