logo
TransactionsBanking statement

Banking statement

Returns the company’s banking statement with optional filters and cursor-based pagination.

Rules:

  • If you pass endDate, you must pass startDate, and vice versa.
  • limit must be between 1 and 50 per page (default: 20).
  • Use nextPageStartKey to paginate.
  • The amount filters (amountEq, amountGt, amountLt) are mutually exclusive.
curl -X GET "https://api-sandbox.contasimples.com/statements/v1/banking?accountId=123&startDate=2025-01-01&endDate=2025-01-31&limit=42&nextPageStartKey=example_string&sorting=transactionDate:DESC&hasAttachments=true&wasConciled=true&categoryIds=["example_string"]&costCenterIds=["example_string"]&responsibleEmail=user@example.com&status=[42]&amountEq=3.14&amountGt=3.14&amountLt=3.14" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "transactions": [
    {
      "id": 123,
      "transactionType": {
        "id": 123,
        "description": "example_string",
        "icon": "example_string",
        "subType": "example_string"
      },
      "companyId": "example_string",
      "status": 42,
      "statusDescription": "example_string",
      "accountId": 123,
      "finalCardNumber": "example_string",
      "bearerName": "John Doe",
      "transactionDate": "2024-12-25T10:00:00Z",
      "brlAmount": 3.14,
      "usdAmount": 3.14,
      "usdExchangeRate": 3.14,
      "usdExchangeRateDate": "2024-12-25T10:00:00Z",
      "totalTransactionAmount": 3.14,
      "iofAmount": 3.14,
      "feeServiceAmount": 3.14,
      "mccCode": 42,
      "mccGroup": 42,
      "idPurchaseEvent": 123,
      "mccDescription": "example_string",
      "sourceDestinationName": "John Doe",
      "placeEstablishment": "example_string",
      "attachments": [
        {
          "id": "example_string",
          "name": "receipt.pdf",
          "type": "image/jpeg",
          "_links": {
            "content": {
              "href": "/attachments/v1/content/{id}",
              "rel": "GET"
            }
          }
        }
      ],
      "conciliation": {
        "description": "example_string",
        "conciled": true
      },
      "showReceipt": true,
      "description": "example_string",
      "notes": "example_string",
      "category": {
        "id": "example_string",
        "description": "example_string"
      },
      "costCenter": {
        "id": "example_string",
        "description": "example_string"
      },
      "user": {
        "id": "example_string",
        "email": "user@example.com"
      },
      "requesterUser": {
        "id": "example_string",
        "email": "user@example.com"
      },
      "customCategory": {
        "id": 123,
        "name": "John Doe"
      }
    }
  ],
  "nextPageStartKey": "example_string"
}
GET
/statements/v1/banking
GET
Bearer Token
Bearer Tokenstring
Required

Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}

Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}
query
accountIdinteger

Bank account ID. If omitted, returns transactions from all accounts.

query
startDatestring

Period start (YYYY-MM-DD). Required when endDate is set.

Format: date
query
endDatestring

Period end (YYYY-MM-DD). Required when startDate is set.

Format: date
query
limitinteger

Max transactions per page. Min: 1, max: 50. Default: 20.

Min: 1 • Max: 50
query
nextPageStartKeystring

Opaque pagination token from the previous response. Pass it back unchanged to fetch the next page.

query
sortingstring

Sort field and order, e.g. transactionDate:DESC.

query
hasAttachmentsboolean

Filter for transactions with or without attachments.

query
wasConciledboolean

Filter by reconciliation status.

query
categoryIdsarray

Category ID list. Separate multiple values with a comma.

query
costCenterIdsarray

Cost center ID list. Separate multiple values with a comma.

query
responsibleEmailstring

Filter by responsible person’s email.

query
statusarray

Filter by status: 1 (CANCELED), 2 (PROCESSED), 3 (PENDING). Comma-separate multiple values.

query
amountEqnumber

Exact amount match.

query
amountGtnumber

Amount greater than.

query
amountLtnumber

Amount less than.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}

Query Parameters

accountIdinteger

Bank account ID. If omitted, returns transactions from all accounts.

startDatestring

Period start (YYYY-MM-DD). Required when endDate is set.

endDatestring

Period end (YYYY-MM-DD). Required when startDate is set.

limitinteger

Max transactions per page. Min: 1, max: 50. Default: 20.

nextPageStartKeystring

Opaque pagination token from the previous response. Pass it back unchanged to fetch the next page.

sortingstring

Sort field and order, e.g. transactionDate:DESC.

hasAttachmentsboolean

Filter for transactions with or without attachments.

wasConciledboolean

Filter by reconciliation status.

categoryIdsarray

Category ID list. Separate multiple values with a comma.

costCenterIdsarray

Cost center ID list. Separate multiple values with a comma.

responsibleEmailstring

Filter by responsible person’s email.

statusarray

Filter by status: 1 (CANCELED), 2 (PROCESSED), 3 (PENDING). Comma-separate multiple values.

amountEqnumber

Exact amount match.

amountGtnumber

Amount greater than.

amountLtnumber

Amount less than.

Responses

transactionsarray
Required

Bank transactions

nextPageStartKeystring

Next page token. Omitted if there is no next page.