Read sales documents
You use this method to read one or more sales documents.
Request method
GET
Request url
https://ponte.venice.be/webconnect/api/{DossierId}/{FinancialYear}/Sales?{Key}={KeyValues}[&fields={FieldList}][&entryFields={FieldList}][&analyticalCentreFields={FieldList}][&analyticalUnitFields={FieldList}][&intrastatDetailFields={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: |
Fields | List of fields, containing property names of the sales document, of which the value has to be returned in the response body. (optional) |
EntryFields | List of entry fields, containing property names of the accounting detail, of which the value has to be returned in the response body. (optional) |
AnalyticalCentreFields | List of analytical centre fields, containing property names of the analytical detail, of which the value has to be returned in the response body. (optional) |
AnalyticalUnitFields | List of analytical unit fields, containing property names of the analytical 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) |
https://ponte.venice.be/WebConnect/api/Demo/2021/Sales?SystemNumber=1&fields=TotalDocC&entryFields=Account,AmountDocC&analyticalCentreFields=-&analyticalUnitFields=-&intrastatDetailFields=-
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)
- Sales (array)
- Sale (array item)
- Fields (object)
- Entries (array)
- Entry (array item)
- Fields (object)
- AnalyticalCentres (array)
- AnalyticalCentre (array item)
- Fields (object)
- AnalyticalUnits (array)
- AnalyticalUnit (array item)
- Fields (object)
- IntrastatDetails (array)
- IntrastatDetail (array item)
- Fields (object)
Examples
{ "Response": { "Sales": { "Sale": [ { "Fields": { "TotalDocC": "2000.00" }, "Entries": { "Entry": [ { "Fields": { "Account": "440000000001", "AmountDocC": "-2000.00" } }, { "Fields": { "Account": "600", "AmountDocC": "2000.00" } } ] } } ] } } }
<?xml version="1.0" encoding="utf-8"?> <Response> <Sales> <Sale> <Fields> <TotalDocC>2000.00</TotalDocC> </Fields> <Entries> <Entry> <Fields> <Account>440000000001</Account> <AmountDocC>-2000.00</AmountDocC> </Fields> <Fields> <Account>600</Account> <AmountDocC>2000.00</AmountDocC> </Fields> </Entry> </Entries> </Sale> </Sales> </Response>