API Calls
The API calls can be called as a Web request where the parameters are supplied via either the URL query or POST data. The host for the web api is the same as the user uses to login, usually in the lines of https://tracetreasuryxxxx.aareoncloud.nl where the x’s are a bunch of numbers.
For example:
GET /API/GetReportData?reportIds=1&callbackUrl=https://mywebsite.com/callback
General
GetAvailableReports
This API call will retrieve the reports to which the service account has access to. It takes no parameters and returns a JSON object in the format:
[{"reportNumber": 307,"companyNumber": 1,"memoField": "","reportName": "Standaard treasury rapport"}, ...]
The report number can then be used to retrieve data of that report. Report numbers are stable and reports will keep the same report number until it is deleted.
GetReportData
This method takes one or more reportIds and a callbackUrl. Because it can take a significant amount of time to download some reports, this is an asynchronous call. The resulting data will be send via a POST request to the supplied callbackUrl.
The following POST data is send to the callbackUrl:
| Key | Value |
|---|---|
| success | A Boolean whether the download was successful. |
| reportData | A ZIP file containing the files for each of the specified reports |
GetReportDataSingle
Same as GetReportData, but only retrieves the data for a single report and doesn’t use a callback URL or compress the result. The data is returned in CSV format.
It takes the following parameters:
| Key | Value |
|---|---|
| reportId | The id of the report of which to download the data. |
Cash flow
ImportRealisations
Via this call you can import a file containing realized bank transactions. The file can be CSV, MT940 or CAMT.053. Because this operation can take a significant amount of time, it is an async operation. The result of the call will be send to the given callbackUrl.
The following parameters must be supplied:
| Key | Value |
|---|---|
| companyId | The ID of the company into which the realisations should be imported |
| callbackUrl | The URL to which to send the result. |
| fileSelector | One or more files to import |
| checkDuplicateImport | A true/false value specifying whether a check should be performed on duplicate entries. |
| importFormat | One of the following values: SwiftGenericMT940, Camt053, CSV This value specifies the format of files specified in FileSelector |
| importFormatDefinitionId | The Id of the import format definition. Only used when the CSV format is selected and specifies what information is in which column. |
| consolidate | A true/false value specifying whether the realisations should be consolidated where possible. |
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.