finov.ioDocumentationHome

List batch transactions

API Documentation / Resources / Bank data

List transactions in a bank batch

GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/bank-accounts/{bank_account_id}/batches/{batch_id}/transactions

Required OAuth scope: accounting:read

Returns undeleted transactions belonging to one batch in one bank account.

Parameter Meaning Default
mapped Filter by reconciliation state Both states
search Search transaction text and amount fields No search
sort date, amount, line, or created_at date
order asc or desc asc
page, per_page Page-number pagination 1, 30

API-submitted rows expose external_id; transactions from other batch sources may omit it. The effective default order is date then stable line order.

Parameters

Name In Required Type Description
tenant_id path Yes string (uuid) UUID of the authorized company group.
subsidiary_id path Yes string (uuid) UUID of the subsidiary containing the bank account.
bank_account_id path Yes string (uuid) UUID of the bank account.
batch_id path Yes string (uuid) UUID of a batch in the identified bank account.
mapped query No boolean
search query No string
page query No integer
per_page query No integer
sort query No string: date, amount, line, created_at
order query No string: asc, desc

Request

GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/bank-accounts/{bank_account_id}/batches/{batch_id}/transactions HTTP/1.1
Host: api.finov.io
Authorization: Bearer {access_token}

Responses

Status Description
200 A page of transactions in the batch.
401 Access token is missing, expired, revoked, or invalid.
403 Token lacks accounting:read or the granted accounting context.
404 Resource does not exist in the granted accounting context.
422 One or more supplied filters failed validation.

200 example

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [
    {
      "id": "7af4aa6b-bb1f-4137-874e-f1ec4488c477",
      "external_id": "bank-90814",
      "batch_id": "ad2f5fe3-d5e6-4234-b921-a70d4bf04f44",
      "line": 1,
      "date": "2026-07-03",
      "type": "DIRECT_CREDIT",
      "details": "Customer payment",
      "particulars": "ASTER RIDGE",
      "code": "INV-1048",
      "reference": "BANK-90814",
      "amount": "1250.0000",
      "mapped": false,
      "created_at": "2026-08-10T09:43:00Z",
      "updated_at": "2026-08-10T09:43:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 30,
    "last_page": 1,
    "total": 1
  }
}