ESDRecordCustomerInvoice Class

Constructor

Percentage rate discounted off the invoice monetary total.

Territory associated with the customer account

First address field associated with the billing of the invoice.

Second address field associated with the billing of the invoice.

Third address field associated with the billing of the invoice.

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

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

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

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

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

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

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

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

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

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

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

Date that the invoice 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 invoice are made 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. human known identifier of the customer account.

Name of the customer account. Could be an organisation name, person's name, or an other label.

list of Labels 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 invoice.

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.

Type of entity purchasing goods/services in the invoice. Set it to one of the constants in the ESDocumentConstants class prefixed with ENTITY_TYPE_

Code of the customer invoice, may or may not be a unique identifier, the code may be made up of the customer invoice number and any prefix or suffix text

Number of the customer invoice, may or may not be a unique identifier

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

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

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

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

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

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

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

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

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

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

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

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

Name of the organisation at the address that the invoiced goods are being delivered to

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

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

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

Date that the invoiced 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 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 invoice was created. Ideally each system s its own unique identifier, formatted such as ORG_NAME.SYSTEM_NAME

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

Name of the user in the associated Ecommerce system where the order was created. Ideally this is 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 for the invoice.

key of the external location where the products for the invoice 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 invoiced goods

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

Name of the freight carrier delivering the invoiced goods

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

Code to track the freight carrier delivering the invoiced goods

Reference code to the system used to process the freight invoice

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

Text describing instructions on how to handle the invoice.

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

Either

• N - No
• Y - Yes

If 'Y' then indicates that the is being delivered to a different entity from the customer assigned to the invoice.

Either

• N - No
• Y - Yes

If 'Y' then indicates that the invoiced goods are to be obtained across multiple locations.

Either

• N - No
• Y - Yes

If 'Y' then indicates that all products for the invoice have been delivered.

Key of the customer account record that is assigned to the invoice. The customer indicates the the entity supplying the invoice.

Key that allows the customer invoice record to be uniquely identified and linked to.

key of the location where the products for the invoice can be found. The key stores the unique identifier of the location. The location may be a warehouse, site, office or other location.

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

Key of the sales order record that allows the customer invoice record to be linked to an associated sales order originally raised

Key of the sales representative record linked to the customer invoice. May indicate the person, organisation or other entity who raised the invoice, or sold the goods/services for the supplier

List of lines stored against the invoice. Each line specifies a product, labour, download or text line stored within the invoice.

Code of the location

Name of the location

Date that the customer invoice 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 paid for the invoice.

Date that the invoice is due to be paid. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone

Method on how the invoice is being paid for. The field must be one of the ESDocumentConstants class's constants prefixed by PAYMENT_METHOD_

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

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

List of payment lines to the invoice. Each payment line indicates the amount paid by the customer against the invoice.

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

Date that the invoice 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 customer's purchase order that may be associated to the customer invoice. 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 invoiced goods were received. 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 record that may be linked to the customer invoice

Number of the sales order record that may be linked to the customer invoice

Code of the sales representative

Either

• N - No
• Y - Yes

If 'Y' then indicates that the sales representative is an individual person, otherwise is a organisation or other entity.

Name of the sales representative. It could be the name of the organisation, person, or other entity who raised in the invoice, or sold the goods/services for the supplier

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 invoice was sent

Method that the invoice is being shipped by

List of surcharge lines stored against the invoice. Each surcharge indicates a charge applied against the invoice

Total number of download lines in the invoice

Total number of labour lines in the invoice

Total number of lines in the invoice.

Total monetary price of the invoice exclusive of tax

Total monetary price of the invoice inclusive of tax

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

Total monetary amount of the invoice 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 invoice before discounts were applied. This amount may be useful when showing discounts applied to an order.

Total number of product lines in the invoice

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

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

Total number of surcharges applied to the invoice

Total monetary amount of taxes applied to surcharges in the invoice

Total monetary amount of taxes applied to the invoice

Total volume of the invoiced 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 invoiced goods

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

sets default values for members that have no values