Read financial documents

You use this method to read one or more financial documents.

Request method

GET

Request url

https://venice.unit4.com/webconnect/api/{DossierId}/{FinancialYear}/Financial?{Key}={KeyValues}[&fields={FieldList}][&entryFields={FieldList}][&analyticalCentreFields={FieldList}][&analyticalUnitFields={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 financial:
  • SystemNumber={SystemNumber}: Seek financial documents by system number.
  • Document={Book}<tab>{Number}: Seek financial documents by book and document number.
  • SyncReference={SyncReference}: Seek financial documents by synchronization reference.
Fields List of fields, containing property names of the financial 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)
Example: Get from dossier 'Demo', financial year '2019' a financial documents with system number '1' and limit the data to the 'TotalDocC' field and limit the entry fields to 'AmountDocC' and 'Account'. All other fields are not requested.
https://venice.unit4.com/WebConnect/api/Demo/2019/Financial?SystemNumber=1&fields=TotalDocC&entryFields=AmountDocC,Account&analyticalCentreFields=-&analyticalUnitFields=-

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": {
    "Financials": {
      "Financial": [
        {
          "Fields": {
            "TotalDocC": "100.00"
          },
          "Entries": {
            "Entry": [
              {
                "Fields": {
                  "AmountDocC": "100.00",
                  "Account": "5500002"
                }
              },
              {
                "Fields": {
                  "AmountDocC": "-100.00",
                  "Account": "400000000001"
                }
              }
            ]
          }
        }
      ]
    }
  }
}
<?xml version="1.0" encoding="utf-8"?>
<Response>
  <Financials>
    <Financial>
      <Fields>
        <TotalDocC>100.00</TotalDocC>
      </Fields>
      <Entries>
        <Entry>
          <Fields>
            <AmountDocC>100.00</AmountDocC>
            <Account>5500002</Account>
          </Fields>
        </Entry>
        <Entry>
          <Fields>
            <AmountDocC>-100.00</AmountDocC>
            <Account>400000000001</Account>
          </Fields>
        </Entry>
      </Entries>
    </Financial>
  </Financials>
</Response>