v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Accounts

List end-of-day summaries

Returns a list of end-of-day reporting summaries, on a per booked date basis, for the account identified by id.

Note that these summaries are only available based on end-of-day reporting, e.g. camt.053, MT940 or equivalent end-of-day reporting bank statements.

Absence of a summary entry for a given account and date means Atlar has not (yet) processed booked transactions based on end-of-day reporting.

The primary use case for these summaries is to provide a means to determine when it is safe to assume all transactions for a given booked date can be listed using the API endpoint GET https://api.atlar.com/financial-data/v2/transactions.

get/financial-data/v2beta/accounts/{id}/end-of-day-summaries

Path parameters

idstring required

Include only summaries for the account identified by id. If value - is specified, summaries across all accounts will be included.

Query parameters

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

datestring date

Example:2022-01-15

Include only summaries with property date matching the given value.

Response

List of summaries.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "accountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "date": "2022-05-07",
      "transactionsControlData": {
        "total": {
          "count": 3,
          "sum": {
            "currency": "EUR",
            "value": 1234,
            "stringValue": "12.34"
          }
        },
        "net": {
          "count": 3,
          "sum": {
            "currency": "EUR",
            "value": -567,
            "stringValue": "-5.67"
          }
        }
      },
      "version": 1,
      "etag": "version:3"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}