Read sales order documents

You use this method to read one or more sales order documents.

Request method

GET

Request url

https://ponte.venice.be/webconnect/api/{DossierId}/{FinancialYear}/SalesOrder?{Key}={KeyValues}[&fields={FieldList}][&detailFields={FieldList}][&distributionFields={FieldList}]

Context identification

Identification Description
DossierId The unique identifier of the dossier.
FinancialYear The financial year.

Parameters

Parameter Description
{Key} The available keys to seek one or more sales orders:
  • SystemNumber={SystemNumber}: Seek sales order documents by system number.
  • Document={Book}<tab>{Number}: Seek sales order documents by document number.
  • SyncReference={SyncReference}: Seek sales order documents by synchronization reference.
Fields List of fields, containing property names of the sales order document, of which the value has to be returned in the response body. (optional)
DetailFields List of detail fields, containing property names of the sales order detail, of which the value has to be returned in the response body. (optional)
DistributionFields List of distribution fields, containing property names of the distribution detail, of which the value has to be returned in the response body. (optional)
Example: Get from dossier 'Demo' and financial year 2021 a sales order documents with system number '1' and limit the data to the 'CstNum' and 'CstSubNum' fields and limit the entry fields to 'Account', 'PriceDocC' and 'Quantity'. All other fields are not requested. 
https://ponte.venice.be/WebConnect/api/Demo/2021/SalesOrder?SystemNumber=1&fields=CstNum,CstSubNum&detailFields=Account,PriceDocC,Quantity&distributionFields=-

Request header

See request header.

Request body

-

Http status

See http status.

Response body

You can receive the response in json or xml.

Structure

Response (object)

Examples

{
  "Response": {
    "SalesOrders": {
      "SalesOrder": [
        {
          "Fields": {
            "CstNum": "1",
            "CstSubNum": "0",
          },
          "Details": {
            "Detail": [
              {
                "Fields": {
                  "ArtNum": "MyArticle",
                  "PriceDocC": "300.00",
                  "Quantity": "6.00"
                }
              },
              ...
            ]
          }
        }
      ]
    }
  }
}

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <SalesOrders>
    <SalesOrder>
      <Fields>
        <CstNum>1</CstNum>
        <CstSubNum>0</CstSubNum>
      </Fields>
      <Details>
        <Detail>
          <Fields>
            <ArtNum>MyArticle</ArtNum>
            <PriceDocC>300.00</PriceDocC>
            <Quantity>6.00</Quantity>
          </Fields>
          ...
        </Detail>
      </Details>
    </SalesOrder>
  </SalesOrders>
</Response>