Click or drag to resize

ESDRecordCustomerInvoice Class

Ecommerce Standards Record that holds data for a single invoice raised against a customer. A customer invoice specifies goods and/or services that have been purchased from a customer, and the monetary amount that the customer owes.
Inheritance Hierarchy
SystemObject
  EcommerceStandardsDocumentsESDRecordCustomerInvoice

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

The ESDRecordCustomerInvoice type exposes the following members.

Constructors
  NameDescription
Public methodESDRecordCustomerInvoice
Constructor
Top
Properties
  NameDescription
Public propertyaccountDiscountRate
Percentage rate discounted off the invoice monetary total.
Public propertyaccountTerritory
Territory associated with the customer account
Public propertybillingAddress1
First address field associated with the billing of the invoice.
Public propertybillingAddress2
Second address field associated with the billing of the invoice.
Public propertybillingAddress3
Third address field associated with the billing of the invoice.
Public propertybillingContact
Name of the contact person at the address associated with the billing of the invoiced.
Public propertybillingCountryCodeISO2
Code of the country of the address associated with the billing of the invoice as a two digit code by the ISO standards.
Public propertybillingCountryCodeISO3
Code of the country of the address associated with the billing of the invoice as a three digit code by the ISO standards.
Public propertybillingCountryName
Name of the country of the address associated with the billing of the invoice.
Public propertybillingDescription
Description of the address associated with the billing of the invoice.
Public propertybillingEmail
Email address at the address associated with the billing of the invoice.
Public propertybillingFax
Fax number at the address associated with the billing of the invoice.
Public propertybillingOrgName
Name of the organisation that the invoiced goods are being billing to
Public propertybillingPhone
Phone number at the address associated with the billing of the invoice.
Public propertybillingPostcode
Postcode of the address associated with the billing of the invoice.
Public propertybillingRegionName
Name of the region/state/province of the address associated with the billing of the invoice.
Public propertycreatedDate
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
Public propertycurrencyISOCode
Currency that all monetary amounts of the invoice are made with. This currency code must be the 3 digit ISO currency code.
Public propertycustomerAccountCode
Code of the customer account, may or not be a unique identifier of the account. human known identifier of the customer account.
Public propertycustomerAccountName
Name of the customer account. Could be an organisation name, person's name, or an other label.
Public propertycustomerAuthorityNumberLabels
list of Labels for the customer authority numbers. Ensure that the array length is the same as the authorityNumbers property, or left empty
Public propertycustomerAuthorityNumbers
Authority numbers of the customer of the invoice.
Public propertycustomerAuthorityNumberTypes
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.
Public propertycustomerEntity
Type of entity purchasing goods/services in the invoice. Set it to one of the constants in the ESDocumentConstants class prefixed with ENTITY_TYPE_
Public propertycustomerInvoiceCode
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
Public propertycustomerInvoiceNumber
Number of the customer invoice, may or may not be a unique identifier
Public propertycustomerOrgName
Name of the organisation who is the customer of the invoice.
Public propertycustomerPersonName
Name of the person who is the customer of the invoice.
Public propertydeliveryAddress1
First delivery address field that the invoiced goods are being delivered to
Public propertydeliveryAddress2
Second delivery address field that the invoiced goods are being delivered to
Public propertydeliveryAddress3
Third delivery address field that the invoiced goods are being delivered to
Public propertydeliveryContact
Name of the contact person at the address that the invoiced goods are being delivered to
Public propertydeliveryCountryCodeISO2
Code of the country at the address that the invoiced goods are being delivered to as a 2 digit code by ISO standards.
Public propertydeliveryCountryCodeISO3
Code of the country at the address that the invoiced goods are being delivered to as a 3 digit code by ISO standards.
Public propertydeliveryCountryName
Name of the country at the address that the invoiced goods are being delivered to
Public propertydeliveryDescription
Description of the address that the invoiced goods are being delivered to
Public propertydeliveryEmail
Email of the contact person at the address that the invoiced goods are being delivered to
Public propertydeliveryFax
Fax number at the address that the invoiced goods are being delivered to
Public propertydeliveryOrgName
Name of the organisation at the address that the invoiced goods are being delivered to
Public propertydeliveryPhone
Phone number at the address that the invoiced goods are being delivered to
Public propertydeliveryPostcode
Post code of the address that the invoiced goods are being delivered to
Public propertydeliveryPurchaseOrderCode
Code of the purchase order to include in the delivery information, that is contains the code of the purchase order relevant to the delivery receiver
Public propertydeliveryRegionName
Name of the region/state/province at the address that the invoiced goods are being delivered to
Public propertydispatchedDate
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
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 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 invoice was created. Ideally each system s its own unique identifier, formatted such as ORG_NAME.SYSTEM_NAME
Public propertyeCommerceUserID
ID of the user in the associated Ecommerce system where the invoice was created.
Public propertyeCommerceUserName
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).
Public propertyemail
Email address for the invoice.
Public propertyexternalKeyLocationID
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.
Public propertyexternalLocationCode
Code of the external location. This external location may be the location where goods are being delivered to or held at.
Public propertyexternalLocationName
Name of the external location. This external location may be the location where goods are being delivered to or held at.
Public propertyfreightCarrierAccountCode
Code of the account in the freight carrier's system
Public propertyfreightCarrierCode
Code of the freight carrier delivering the invoiced goods
Public propertyfreightCarrierConsignCode
Consignment code issued by the freight carrier to delivery the invoiced goods
Public propertyfreightCarrierName
Name of the freight carrier delivering the invoiced goods
Public propertyfreightCarrierServiceCode
Code of the service provided by the freight carrier to deliver the invoiced goods
Public propertyfreightCarrierTrackingCode
Code to track the freight carrier delivering the invoiced goods
Public propertyfreightSystemRefCode
Reference code to the system used to process the freight invoice
Public propertyfullyPaidDate
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
Public propertyinstructions
Text describing instructions on how to handle the invoice.
Public propertyinternalID
Stores an identifier that is relevant only to the system referencing and storing the record for its own needs.
Public propertyisDropship
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.
Public propertyisMultiLocation
Either
  • N - No
  • Y - Yes
If 'Y' then indicates that the invoiced goods are to be obtained across multiple locations.
Public propertyisProductsDelivered
Either
  • N - No
  • Y - Yes
If 'Y' then indicates that all products for the invoice have been delivered.
Public propertykeyCustomerAccountID
Key of the customer account record that is assigned to the invoice. The customer indicates the the entity supplying the invoice.
Public propertykeyCustomerInvoiceID
Key that allows the customer invoice record to be uniquely identified and linked to.
Public propertykeyLocationID
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.
Public propertykeyPaymentTypeID
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.
Public propertykeySalesOrderID
Key of the sales order record that allows the customer invoice record to be linked to an associated sales order originally raised
Public propertykeySalesRepID
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
Public propertylines
List of lines stored against the invoice. Each line specifies a product, labour, download or text line stored within the invoice.
Public propertylocationCode
Code of the location
Public propertylocationName
Name of the location
Public propertymodifiedDate
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
Public propertypaymentAmount
Monetary amount paid for the invoice.
Public propertypaymentDueDate
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
Public propertypaymentMethod
Method on how the invoice is being paid for. The field must be one of the ESDocumentConstants class's constants prefixed by PAYMENT_METHOD_
Public propertypaymentProprietaryCode
Code the proprietary system that is used as the payment method for the invoice.
Public propertypaymentReceipt
Number that contains a reference to the payment applied against the invoice
Public propertypayments
List of payment lines to the invoice. Each payment line indicates the amount paid by the customer against the invoice.
Public propertypaymentStatus
Status indicating how the invoice has been paid for. Set it to one of the ESDocumentConstants constants in the class prefixed with PAYMENT_STATUS_
Public propertyprocessedDate
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
Public propertypurchaseOrderNumber
Number of the customer's purchase order that may be associated to the customer invoice. This may be used for referencing purposes.
Public propertypurchaserSystemCode
Code of the system that the purchasing entity stores its data within.
Public propertypurchaserSystemID
ID of the system that the purchasing entity stores its data within.
Public propertypurchaserSystemName
Name of the system that the purchasing entity stores its data within.
Public propertyreceivedDate
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
Public propertysalesOrderCode
Code of the sales order record that may be linked to the customer invoice
Public propertysalesOrderNumber
Number of the sales order record that may be linked to the customer invoice
Public propertysalesRepCode
Code of the sales representative
Public propertysalesRepIndividual
Either
  • N - No
  • Y - Yes
If 'Y' then indicates that the sales representative is an individual person, otherwise is a organisation or other entity.
Public propertysalesRepName
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
Public propertysellerSystemCode
Code of the system that the selling entity stores its data within.
Public propertysellerSystemID
ID of the system that the selling entity stores its data within.
Public propertysellerSystemName
Name of the system that the selling entity stores its data within.
Public propertysentDate
Date that the invoice was sent
Public propertyshippingMethod
Method that the invoice is being shipped by
Public propertysurcharges
List of surcharge lines stored against the invoice. Each surcharge indicates a charge applied against the invoice
Public propertytotalDownloads
Total number of download lines in the invoice
Public propertytotalLabour
Total number of labour lines in the invoice
Public propertytotalLines
Total number of lines in the invoice.
Public propertytotalPriceExTax
Total monetary price of the invoice exclusive of tax
Public propertytotalPriceIncTax
Total monetary price of the invoice inclusive of tax
Public propertytotalPriceUndiscountedExTax
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.
Public propertytotalPriceUndiscountedIncTax
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.
Public propertytotalPriceUndiscountedTax
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.
Public propertytotalProducts
Total number of product lines in the invoice
Public propertytotalSurchargeExTax
Total monetary amount of surcharges applied to the invoice exclusive of taxes
Public propertytotalSurchargeIncTax
Total monetary amount of surcharges applied to the invoice inclusive of taxes
Public propertytotalSurchargeItems
Total number of surcharges applied to the invoice
Public propertytotalSurchargeTax
Total monetary amount of taxes applied to surcharges in the invoice
Public propertytotalTax
Total monetary amount of taxes applied to the invoice
Public propertytotalVolume
Total volume of the invoiced goods
Public propertytotalVolumeMeasureCode
Code of the unit of measure for the volume. Set it to a constant prefixed with UNIT_MEASURE_VOLUME_ in the ESDocumentConstants class
Public propertytotalWeight
Total weight of the invoiced goods
Public propertytotalWeightMeasureCode
Code of the unit of measure for the weight. Set it to a constant prefixed with UNIT_MEASURE_MASS_ in the ESDocumentConstants class
Top
Methods
  NameDescription
Public methodsetDefaultValuesForNullMembers
sets default values for members that have no values
Top
See Also