List Statements

GET 
/statements

List Statements

Request

Query Parameters

after string

An object ID that is used as a cursor in pagination. For instance, if you make a list request and receive 100 objects, ending with obj_foo42, your subsequent call can include after=obj_foo42 in order to fetch the next page of the list.

limit integer

Possible values: >= 1 and <= 100

Default value: 10

A limit on the number of objects to be returned, between 1 and 100.

order string

Possible values: [ASC, DESC]

Default value: DESC

Sort list objects in either ascending or descending order.

Responses

200

OK

Response Headers

• Acme-Mode

  string

  Has the value LIVE if the data exists in live production mode or the value TEST if the data exists in test sandbox mode.

application/json

Schema

Schema

data

object[]

required

Array [

id stringrequired

Unique identifier for the object

statementDate stringrequired

Statement date

type stringrequired

Possible values: [CAMT.053]

Statement type

bankAccount

object

required

The bank account of the statement

id string

Internal Account ID

bank string

Bank SWIFT/BIC code

bankAccountNumber string

Account number

createdAt stringrequired

Time at which the object was created. In ISO 8601 format.

updatedAt stringrequired

Time at which the object was last updated. In ISO 8601 format.

]

hasMore booleanrequired

Example (from schema)

{
  "data": [
    {
      "id": "stmt_0H3BQSYF6QQ0W",
      "statementDate": "2024-02-06",
      "type": "CAMT.053",
      "bankAccount": {
        "id": "intacc_12345678",
        "bank": "DBSSSGSGXXX",
        "bankAccountNumber": "0052312891"
      },
      "createdAt": "2023-04-24T00:00:00.000000Z",
      "updatedAt": "2023-04-24T00:00:00.000000Z"
    }
  ],
  "hasMore": true
}

Loading...