ESDRecordOrderSale Class

constructor

Percentage rate discounted off the order monetary total based on the discount assigned to the order's customer account.

Territory associated with the customer account

First address field associated with the billing of the order.

Second address field associated with the billing of the order.

Third address field associated with the billing of the order.

Name of the contact person at the address associated with the billing of the order.

Code of the country of the address associated with the billing of the order as a two digit code set by the ISO standards.

Code of the country of the address associated with the billing of the order as a three digit code set by the ISO standards.

Name of the country of the address associated with the billing of the order.

Description of the address associated with the billing of the order.

Email address at the address associated with the billing of the order.

Fax number at the address associated with the billing of the order.

Name of the organisation that the orders goods are being billing to

Phone number at the address associated with the billing of the order.

Postcode of the address associated with the billing of the order.

Name of the region/state/province of the address associated with the billing of the order.

Date that the order was created. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone

Currency that all monetary amounts of the order are set with. This currency code must be the 3 digit ISO currency code.

Code of the customer account, may or not be a unique identifier of the account.

Name of the customer account

list of Labels set for the customer authority numbers. Ensure that the array length is the same as the authorityNumbers property, or left empty

Authority numbers of the customer of the order.

list of authority number types matching the customer 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.

Customer entity buying the order. Set it to one of the constants in the ESDocumentConstants class prefixed with ENTITY_TYPE_

Name of the organisation who is the customer of the order.

Name of the person who is the customer of the order.

First delivery address field that the ordered goods are being delivered to

Second delivery address field that the ordered goods are being delivered to

Third delivery address field that the ordered goods are being delivered to

Name of the contact person at the address that the ordered goods are being delivered to

Code of the country at the address that the ordered goods are being delivered to as a 2 digit code set by ISO standards.

Code of the country at the address that the ordered goods are being delivered to as a 3 digit code set by ISO standards.

Name of the country at the address that the ordered goods are being delivered to

Description of the address that the ordered goods are being delivered to

Email of the contact person at the address that the ordered goods are being delivered to

Fax number at the address that the ordered goods are being delivered to

Name of the organisation that the orders goods are being delivered to

Phone number at the address that the ordered goods are being delivered to

Post code of the address that the ordered goods are being delivered to

Name of the region/state/province at the address that the ordered goods are being delivered to

Date that the order's goods were sent out. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone

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.

ID of the associated Ecommerce system where the order was created. Ideally each system sets its own unique identifier, formatted such as ORG_NAME.SYSTEM_NAME

ID of the user in the associated Ecommerce system where the order was created.

Name of the user in the associated Ecommerce system where the order 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).

Email address set for the order.

key of the external location where the products for the order can be found. This external location may be the location where goods are being delivered to or held at.

Code of the external location. This external location may be the location where goods are being delivered to or held at.

Name of the external location. This external location may be the location where goods are being delivered to or held at.

Code of the account in the freight carrier's system

Code of the freight carrier delivering the ordered goods

Consignment code issued by the freight carrier to delivery the ordered goods

Name of the freight carrier delivering the orders goods

Code of the service provided by the freight carrier to deliver the ordered goods

Code to track the freight carrier delivering the ordered goods

Reference code to the system used to process the freight order

Text describing instructions on how to handle the order.

Stores an identifier that is relevant only to the system referencing and storing the record for its own needs.

Either 'N'-No or 'Y'-Yes If 'Y' then indicates that the order is being supplied by a different entity from supplier assigned to the order.

Either 'N'-No or 'Y'-Yes If 'Y' then indicates that the ordered goods are to be obtained across multiple locations.

Either 'N'-No or 'Y'-Yes If 'Y' then indicates that all products for the order have been delivered.

Key of the customer account record that is assigned to the order. The customer indicates the purchaser of the order.

key of the location where the products for the order can be found.

Key of the payment type record that is associated to the payment. The payment type record indicates how the payment was made for the order.

Key that allows the sale order record to be uniquely identified and linked to.

Key of the sales representative record linked to the order.

List of lines set to the order

Code of the location that the order's products are to be picked/packed/delivered/managed from by default.

Name of the location that the order's products are to be picked/packed/delivered/managed from by default.

Date that the order was last modified. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone

Monetary amount already paid for the order.

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_

Code the proprietary system that is used as the payment method for the order.

Number that contains a reference to the payment applied against the order

List of payments set to the order

Status indicating how the order has been paid for. Set it to one of the constants in the class prefixed with PAYMENT_STATUS_

Date that the order was processed. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone

Number of the purchase order that may be associated to the sales order. This may be used for referencing purposes.

Code of the system that the purchasing entity stores its data within.

ID of the system that the purchasing entity stores its data within.

Name of the system that the purchasing entity stores its data within.

Date that the order's goods were received by the purchaser. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone

Code of the sales order, may or may not be a unqiue indentifier

Number of the sales order, may or may not be a unique identifier

Code of the sales representative.

Either 'N'-No or 'Y'-Yes If 'Y' then indicates that the sales representative is an individual person.

Name of the sales representative.

Code of the system that the selling entity stores its data within.

ID of the system that the selling entity stores its data within.

Name of the system that the selling entity stores its data within.

Date that the order was sent

Either 'N'-No or 'Y'-Yes If 'Y' then indicates that the ordered goods are to be obtained across multiple locations.

List of surcharge lines set to the order

Total number of download lines in the order

Total number of labour lines in the order

Total number of lines in the order.

Total monetary price of the order exclusive of tax

Total monetary price of the order inclusive of tax

Total monetary amount of the order before discounts were applied, exclusive of taxes. This amount may be useful when showing discounts applied to an order.

Total monetary amount of the order before discounts were applied, inclusive of taxes. This amount may be useful when showing discounts applied to an order.

Total monetary amount of taxes applied to the order before discounts were applied. This amount may be useful when showing discounts applied to an order.

Total number of product lines in the order

Total monetary amount of surcharges applied to the order exclusive of taxes

Total monetary amount of surcharges applied to the order inclusive of taxes

Total number of surcharges applied to the order

Total monetary amount of taxes applied to surcharges in the order

Total monetary amount of taxes applied to the order

Total volume of the ordered goods

Code of the unit of measure for the volume. Set it to a constant prefixed with UNIT_MEASURE_VOLUME_ in the ESDocumentConstants class

Total weight of the ordered goods

Code of the unit of measure for the weight. Set it to a constant prefixed with UNIT_MEASURE_MASS_ in the ESDocumentConstants class

Converts the order sale record into a customer account enquiry order sale record

sets default values for members that have no values set

List of the invoice numbers linked to this sales order.

ACCOUNT - A payment will be assigned to a customer account and paid based on the agreed payment terms

COD - Payment will be made with cash when the goods are delivered to the delivery location

CREDITCARD - A payment was made with a credit card

DIRECTDEPOSIT - Payment has been made with a direct bank transfer

NONE - No payment was made or needed

PROPRIETARY - A payment was made using a proprietary payment system. PayPal could be one example of this.

QUOTE - No payment was made as a quote was only required

UNPAID - No payment was received as yet

DECLINED - A payment failed when trying to be paid

NONREQUIRED - No payment is required to pay for the order

PAID - The order has been paid

PENDING - A payment is currently in the process of being paid for, or is waiting on a process to complete

UNPAID - The order has not been paid for