v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Connections

List bank statements

List bank statements.

get/connectivity/v2beta/connections/{cid}/reports/{id}/bank-statements

Path parameters

cidstring required

Atlar connection ID.

idstring required

Atlar resource ID.

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.

account_idstring

Unique resource identifier.

Example:2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8

The account ID to filter for.

type'EODY' | 'NONE'

The statement period type to filter for.

fromstring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

Example:2022-05-07

The from date to filter for. Returns all statements that contain transactions after or equal to this date.

tostring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

Example:2022-05-07

The to date to filter for. Returns all statements that contain transactions before or equal to this date.

Response

List of bank statements.

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": [
    {
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "accountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "version": 1,
      "etag": "version:3",
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}