Click or drag to resize

ESDocumentSupplierAccountEnquiry Class

Ecommerce standards document that holds lists of purchase orders for supplier accounts. This document can by used in many ways for enquiring about different data associated to a supplier account's finances.
Inheritance Hierarchy
SystemObject
  EcommerceStandardsDocumentsESDocument
    EcommerceStandardsDocumentsESDocumentSupplierAccountEnquiry

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

The ESDocumentSupplierAccountEnquiry type exposes the following members.

Constructors
  NameDescription
Public methodESDocumentSupplierAccountEnquiry
Constructor
Top
Properties
  NameDescription
Public propertyorderPurchaseRecords
list of Supplier Account Enquiry Order Purchase records.
Top
Fields
  NameDescription
Public fieldconfigs
A dictionary of additional configurations and settings to include with each Ecommerce Standard Document. Typically documents would contain the "dataFields" key that would have a comma delimited list of record properties that are expected to contain data when reading the document's records. Any records not containing data for properties in list could then have the data set to a default when saved to a database.
(Inherited from ESDocument.)
Public fielddataTransferMode
Denotes if the data being placed into document is a complete data set, or partial data being transferred containing only data changes.
(Inherited from ESDocument.)
Public fieldmessage
Message providing details of if the data could be obtained when requesting the document. The message gives meaning to the result status.
(Inherited from ESDocument.)
Public fieldresultStatus
Code that denotes if the data could be successfully obtained for the document, and if not why. See ESDocumentConstants Class for the list of status codes
(Inherited from ESDocument.)
Public fieldtotalDataRecords
The total number of records placed within document. For documents that contain multiple record lists, please check the relevant documentation to see how this number applies.
(Inherited from ESDocument.)
Public fieldversion
Version of the Ecommerce Standards Document. Verifying the version of the document is critical for systems transferring and manipulating the data.
(Inherited from ESDocument.)
Top
Examples
An example of the Supplier Account Enqury Standards document in its JSON serialised form, displaying a list of purchase orders for a supplier account
{
    "version": 1.3,
    "resultStatus": 1,
    "message":"The supplier account enquiry purchase order data has been successfully obtained.",
    "dataTransferMode": "COMPLETE",
    "totalDataRecords": 2,
    "configs":{},
    "orderSaleRecords":
     [
        {
            "keyOrderPurchaseID":"11",
            "orderID":"PURCHASEORDER-11",
            "keySupplierAccountID":"222",
            "supplierAccountCode":"SUPPLIER004",
            "totalExTax": 400.00,
            "totalIncTax": 440.00,
            "totalTax": 40.00,
            "totalPaid": 0,
            "balance": 440.00
        },
        {
            "keyOrderPurchaseID":"12",
            "orderID":"PURCHASEORDER-12",
            "keySupplierAccountID":"222",
            "supplierAccountCode":"SUPPLIER004",
            "orderNumber": "4324234",
            "creationDate": 1449132083084,
            "orderDate": 1449932083084,
            "dueDate": 1449932083084,
            "keyLocationID": "456",
            "locationCode": "LCT-456",
            "locationLabel": "Warehouse",
            "locationType": "WAREHOUSE",
            "referenceKeyID": "112",
            "referenceType": "INVOICE",
            "referenceNumber": "1234123",
            "supplierReference": "3434343",
            "purchaseRepCode": "JD",
            "purchaseRepName": "John Doe",
            "deliveryContact": "Lee",
            "deliveryOrgName": "Lee's Business Pty Ltd",
            "deliveryAddress1": "22",
            "deliveryAddress2": "Bourkie Street",
            "deliveryAddress3": "Melbourne",
            "deliveryStateProvince": "Victoria",
            "deliveryCountry": "Australia",
            "deliveryCountryCodeISO2": "AU",
            "deliveryCountryCodeISO3": "AUS",
            "deliveryPostcode": "3000",
            "billingContact": "Tom",
            "billingOrgName": "Lee's Business Pty Ltd",
            "billingAddress1": "15",
            "billingAddress2": "Bourkie Street",
            "billingAddress3": "Melbourne",
            "billingStateProvince": "Victoria",
            "billingCountry": "3000",
            "billingCountryCodeISO2": "AU",
            "billingCountryCodeISO3": "AUS",
            "billingPostcode": "3000",
            "taxNumber": "123 12332 123",
            "taxLabel": "GST",
            "taxRate": 10,
            "totalExTax": 100.00,
            "totalIncTax": 110.00,
            "totalTax": 10.00,
            "totalFreightIncTax": 11.00,
            "totalFreightExTax": 10.00,
            "totalExtraChargesIncTax": 1.10,
            "totalExtraChargesExTax": 1.00,
            "totalDiscountsIncTax": 220.00,
            "totalDiscountsExTax": 22.00,
            "totalLeviesIncTax": 22.00,
            "totalLeviesExTax": 20.00,
            "totalPaid": 50.00,
            "balance": 60.00,
            "currencyCode": "AUD",
            "totalQuantity": 3,
            "description": "",
            "language": "EN_AU",
            "comment": "Goods to be left by the back entrance"
        }
    ]
}
An example of the Supplier Account Enqury Standards document in its JSON serialised form, containing the detail of a single purchase order for a supplier account
{
    "resultStatus":"1",
    "message":"The supplier account enquiry purchase order detail data has been successfully obtained.",
    "configs":{},
    "dataTransferMode": "COMPLETE",
    "version": 1.3,
    "totalDataRecords": 1,
    "orderPurchaseRecords":
     [
        {
            "keyOrderPurchaseID":"112",
            "orderID":"PURCHASEORDER-112",
            "keySupplierAccountID":"222",
            "supplierAccountCode":"SUPPLIER004",
            "orderNumber": "4324234",
            "creationDate": 1449132083084,
            "orderDate": 1449932083084,
            "dueDate": 1449932083084,
            "expectedDeliveryDate": 1449982083084,
            "deliveredDate": 1449982083084,
            "keyLocationID": "456",
            "locationCode": "LCT-456",
            "locationLabel": "Warehouse",
            "locationType": "WAREHOUSE",
            "referenceKeyID": "112",
            "referenceType": "INVOICE",
            "referenceNumber": "1234123",
            "supplierReference": "3434343",
            "purchaseRepCode": "JD",
            "purchaseRepName": "John Doe",
            "deliveryContact": "Lee",
            "deliveryOrgName": "Lee's Business Pty Ltd",
            "deliveryAddress1": "22",
            "deliveryAddress2": "Bourkie Street",
            "deliveryAddress3": "Melbourne",
            "deliveryStateProvince": "Victoria",
            "deliveryCountry": "Australia",
            "deliveryCountryCodeISO2": "AU",
            "deliveryCountryCodeISO3": "AUS",
            "deliveryPostcode": "3000",
            "billingContact": "Tom",
            "billingOrgName": "Lee's Business Pty Ltd",
            "billingAddress1": "15",
            "billingAddress2": "Bourkie Street",
            "billingAddress3": "Melbourne",
            "billingStateProvince": "Victoria",
            "billingCountry": "3000",
            "billingCountryCodeISO2": "AU",
            "billingCountryCodeISO3": "AUS",
            "billingPostcode": "3000",
            "taxNumber": "123 12332 123",
            "taxLabel": "GST",
            "taxRate": 10,
            "totalExTax": 100.00,
            "totalIncTax": 110.00,
            "totalTax": 10.00,
            "totalFreightIncTax": 11.00,
            "totalFreightExTax": 10.00,
            "totalExtraChargesIncTax": 1.10,
            "totalExtraChargesExTax": 1.00,
            "totalDiscountsIncTax": 220.00,
            "totalDiscountsExTax": 22.00,
            "totalLeviesIncTax": 22.00,
            "totalLeviesExTax": 20.00,
            "totalPaid": 50.00,
            "balance": 60.00,
            "currencyCode": "AUD",
            "totalQuantity": 3,
            "description": "",
            "freightCarrierCode": "ACME-FREIGHT-001",
            "freightCarrierName": "ACME Freight Shippers",
            "freightSystemRefCode": "SHIP-SYS",
            "freightCarrierConsignCode": "CON-23124123",
            "freightCarrierTrackingCode": "34325-25243-24343",
            "freightCarrierServiceCode": "EXPRESS-24",
            "freightCarrierAccountCode": "ACME-001",
            "language": "EN_AU",
            "comment": "Goods to be left by the back entrance",
            "lines":
            [
                {
                    "keyOrderPurchaseLineID":"4122"
                },
                {
                    "keyOrderPurchaseLineID":"4123",
                    "lineItemID":"PROD1234453",
                    "lineItemCode":"PROD-123",
                    "lineType":"ITEM",
                    "description":"Tea Towels",
                    "language":"EN_AU",
                    "unit":"EACH",
                    "quantityOrdered": 22,
                    "quantityDelivered": 22,
                    "quantityBackordered": 0,
                    "priceExTax": 300.00,
                    "priceIncTax": 330.00,
                    "priceTax": 30.00,
                    "totalPriceExTax":6600.00,
                    "totalPriceIncTax": 7260.00,
                    "totalPriceTax": 660,
                    "taxCode":"GST",
                    "keyLocationID":"456",
                    "locationCode":"LCT-456",
                    "currencyCode":"AUD",
                    "referenceLineItemCode":"",
                    "referenceLineCode":""
                },
                {
                    "keyInvoiceLineID":"11234124",
                    "lineType":"TEXT",
                    "description":"Tea towels are packed into cardboard boxes"
                }
            ]
        }
    ]
}
See Also