Read sales invoice documents

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

Request method

GET

Request url

https://ponte.venice.be/webconnect/api/{DossierId}/{FinancialYear}/SalesInvoice?{Key}={KeyValues}[&fields={FieldList}][&detailFields={FieldList}][&distributionFields={FieldList}][&intrastatDetailFields={FieldList}][&pdfFields={True or False}]

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 invoices: SystemNumber={SystemNumber}: Seek sales invoice documents by system number. Document={Book}<tab>{Number}: Seek sales invoice documents by document number. SyncReference={SyncReference}: Seek sales invoice documents by synchronization reference.
Fields	List of fields, containing property names of the sales invoice 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 invoice 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)
IntrastatDetailFields	List of Intrastat detail fields, containing property names of the Intrastat detail, of which the value has to be returned in the response body. (optional)
PdfFields	True if the response should contain information on the pdf representation of the invoice. (optional)

Example: Get the sales invoice document with system number '1' from financial year 2021 in dossier 'Demo' and limit the data to the 'CstNum' and 'CstSubNum' fields, limit the entry fields to 'ArtNum', 'PriceDocC' and 'Quantity' and request the pdf representation of the sales invoice. All other fields are not requested.

https://ponte.venice.be/WebConnect/api/Demo/2021/SalesInvoice?SystemNumber=1&fields=CstNum,CstSubNum&detailFields=ArtNum,PriceDocC,Quantity&distributionFields=-&intrastatDetailFields=-&pdfFields=True

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)

SalesInvoices (array)
- SalesInvoice (array item)
  - Fields (object)
    - Sales invoice header fields
  - Details (array)
    - Detail (array item)
      - Fields (object)
        Sales invoice detail fields
      - Distributions (array)
        Distribution (array item)
        Fields (object)
        Sales invoice distribution detail fields
  - IntrastatDetails (array)
    - IntrastatDetail (array item)
      - Fields (object)
        Sales invoice Intrastat detail fields
  - Pdf (object)
    - FileName: The file name of the pdf file, containing the representation of the sales invoice
    - MimeCode: 'application/pdf'
    - Data: Base64 encoded string containing the contents of the pdf file

{
  "Response": {
    "SalesInvoices": {
      "SalesInvoice": [
        {
          "Fields": {
            "CstNum": "1",
            "CstSubNum": "0",
          },
          "Details": {
            "Detail": [
              {
                "Fields": {
                  "ArtNum": "MyArticle",
                  "PriceDocC": "300.00",
                  "Quantity": "6.00"
                }
              },
              ...
            ]
          },
          "Pdf": {
            "FileName": "FAC_2021_000001.pdf",
            "MimeCode": "application/pdf",
            "Data": "..."
          }
        }
      ]
    }
  }
}

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <SalesInvoices>
    <SalesInvoice>
      <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>
      <Pdf>
        <FileName>FAC_2021_000001.pdf</FileName>
        <MimeCode>application/pdf</MimeCode>
        <Data>...</Data>
      </Pdf>
    </SalesInvoice>
  </SalesInvoices>
</Response>