Read dossier properties

You use this method to read information of a dossier.

Request method

GET

Request url

https://ponte.venice.be/webconnect/api/{DossierId}/Dossier[/{InformationType}?{Parameters}]

Context identification

Identification Description
DossierId The unique identifier of the dossier.
InformationType Requests a specific type of information. Possible values:
  • FinancialYear:

    Finds the last financial year that contains the given date. If no corresponding financial year is found, this method returns http status 404 'NotFound'.

    Required parameters: Date (format: yyyy-MM-dd).

  • FirstOpenYear:

    Finds the first open financial year for the given transfert type. If no financial year is found, this method returns http status 404 'NotFound'.

    Required parameters: TransfertType.

  • NextYear:

    Finds the next financial year for the given year. If no next financial year is found, this method returns http status 404 'NotFound'.

    Required parameters: FinancialYear.

  • FormatNumber:

    Formats an account number. If no general account number can be formatted, this method returns http status 404 'NotFound'.

    Required parameters: AccountPrefix, Number and SubPrefix.

  • ClosedDate:

    Gets the date of the last day of the last closed period for the given type of declaration. If no date can be found, this method returns http status 404 'NotFound'.

    Required parameters: DeclarationType.

  • ClearCache:

    Clears the cache that holds all used SDK objects in this dossier.

    Required parameters: None.

Parameters

Parameter Description
Date The date of which you want to know the financial year (format: yyyy-MM-dd).
Number The number you want to get the general account number of.
FinancialYear The year you want to find the next financial year of.
TransfertType A value of the 'eTrnType' enumeration.
AccountPrefix A value of the 'eAccPrefix' enumeration.
DeclarationType A value of the 'eDeclType' enumeration.
SubPrefix The sub prefix of the number you want to get the general account number of. A value for this parameter is only taken into account if the parameter eAccPrefix has one of the following values: apDeposit, apBank, apPostalCheque or apCash.
Example 1: Get general information from dossier 'Demo'. 
https://ponte.venice.be/WebConnect/api/Demo/Dossier
Example 2: Get the last financial year from dossier 'Demo' that contains the date '2021-01-25'. 
https://ponte.venice.be/WebConnect/api/Demo/Dossier/FinancialYear?Date=2021-01-25

Request header

See request header.

Request body

-

Http status

See http status.

Response body

You can receive the response in json or xml.

Structure

The structure of the response body depends on the value of the parameter 'informationType'. Parameter 'informationType' is not provided
Response (object)
Parameter 'informationType' has the value 'FinancialYear'
Response (object)
Parameter 'informationType' has the value 'FirstOpenYear'
Response (object)
Parameter 'informationType' has the value 'NextYear'
Response (object)
Parameter 'informationType' has the value 'FormatNumber'
Response (object)
Parameter 'informationType' has the value 'ClosedDate'
Response (object)

Examples

{
  "Response": {
    "Dossier": {
      "Directory": "Demo",
      "CabinetName": "Venice",
      "Name": "Demo",
      "LastYear": "0",
      "Currency": "EUR",
      "Options": "Tls,Fid,Axs,Inv,Ext,Acc",
      "Prefixes": {
        "Customer": "400",
        "Supplier": "440",
        "Deposit": "53",
        "Bank": "55",
        "PostalCheque": "56",
        "Cash": "57"
      },
      "Years": {
        "Year": [
          {
            "Name": "2020",
            "Begin": "2020-01-01",
            "End": "2020-12-31",
            "LastClosedVatDate": "2019-12-31"
          },
          {
            "Name": "2021",
            "Begin": "2021-01-01",
            "End": "2021-12-31",
            "LastClosedVatDate": "2020-12-31"
          }
        ]
      }
    }
  }
}

{
  "Response": {
    "Dossier": {
      "FinancialYear": "2021"
    }
  }
}

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <Dossier>
    <Directory>Demo</Directory>
    <CabinetName>Venice</CabinetName>
    <Name>Demo</Name>
    <LastYear>0</LastYear>
    <Currency>EUR</Currency>
    <Options>Tls,Fid,Axs,Inv,Ext,Acc</Options>
    <Prefixes>
      <Customer>400</Customer>
      <Supplier>440</Supplier>
      <Deposit>53</Deposit>
      <Bank>55</Bank>
      <PostalCheque>56</PostalCheque>
      <Cash>57</Cash>
    </Prefixes>
    <Years>
      <Year>
        <Name>2020</Name>
        <Begin>2020-01-01</Begin>
        <End>2020-12-31</End>
        <LastClosedVatDate>2019-12-31</LastClosedVatDate>
      </Year>
      <Year>
        <Name>2021</Name>
        <Begin>2021-01-01</Begin>
        <End>2021-12-31</End>
        <LastClosedVatDate>2020-12-31</LastClosedVatDate>
      </Year>
    </Years>
  </Dossier>
</Response>

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <Dossier>
    <FinancialYear>2021</FinancialYear>
  </Dossier>
</Response>