Create sales order document

You use this method to create a new sales order document.

Request method

POST

Request url

https://ponte.venice.be/webconnect/api/{DossierId}/{FinancialYear}/SalesOrder

Context identification

Identification Description
DossierId The unique identifier of the dossier.
FinancialYear The financial year.
Example: Create a new sales order document in financial year 2021, in dossier 'Demo'. 
https://ponte.venice.be/webconnect/api/Demo/2021/SalesOrder

Request header

See request header.

Request body

You can specify additional parameters via the Params-node in the body:

ParameterDescription
AddTextLinesTrue if text lines must be added automatically after the article line, otherwise false. (default = false)
ExpandSetsTrue if set articles must be expanded automatically, otherwise false. (default = false)

Structure

Request (object)
  • Params (object)
    • AddTextLines
    • ExpandSets

Examples

{
  "Request": {
    "Params": {
      "AddTextLines": "true",
      "ExpandSets": "true"
    },
    "SalesOrders": {
      "SalesOrder": [
        {
          "Fields": {
            "CstNum": "1",
            "CstSubNum": "0",
            "DocType": "0",
            "Book": "FACT",
            "DocDate": "2021-01-21",
            "ExpirationDate": "2021-02-21"
          },
          "Details": {
            "Detail": [
              {
                "Fields": {
                  "Quantity": "10.00",
                  "PriceDocC": "11.00",
                  "PurchaseValueDocC": "10.00",
                  "ArtNum": "MyArticle",
                  "ArtDsc": "My article description",
                  "VatCode": "3",
                },
                "Distributions": {
                  "Distribution": [
                    {
                      "Fields": {
                        "Quantity": "10.00",
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

<?xml version="1.0" encoding="utf-8"?>
<Request>
  <Params>
    <AddTextLines>true</AddTextLines>
    <ExpandSets>true</ExpandSets>
  </Params>
  <SalesOrders>
    <SalesOrder>
      <Fields>
        <CstNum>1</CstNum>
        <CstSubNum>0</CstSubNum>
        <DocType>0</DocType>
        <Book>FACT</Book>
        <DocDate>2021-01-21</DocDate>
        <ExpirationDate>2021-02-21</ExpirationDate>
      </Fields>
      <Details>
        <Detail>
          <Fields>
            <Quantity>10.00</Quantity>
            <PriceDocC>11.00</PriceDocC>
            <PurchaseValueDocC>10.00</PurchaseValueDocC>
            <ArtNum>MyArticle</ArtNum>
            <ArtDsc>My article description</ArtDsc>
            <VatCode>3</VatCode>
          </Fields>
          <Distributions>
            <Distribution>
              <Fields>
                <Quantity>10.00</Quantity>
              </Fields>
            </Distribution>
          </Distributions>
        </Detail>
      </Details>
    </SalesOrder>
  </SalesOrders>
</Request>

Http status

See http status.

Response body

You can receive the response in json or xml.

Structure

Response (object)
  • System number

Examples

{
  "Response": {
    "SystemNumber": "5"
  }
}

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <SystemNumber>5</SystemNumber>
</Response>