finov.ioDocumentationHome

Get or delete a bank batch

API Documentation / Resources / Bank data

Get a bank batch

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

Required OAuth scope: accounting:read

Returns one undeleted batch from the identified bank account.

A batch belonging to another tenant, subsidiary, or bank account is not disclosed and returns 404 Not Found.

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 whose books contain the bank account.
bank_account_id path Yes string (uuid) UUID of the bank account.
batch_id path Yes string (uuid) UUID of the bank batch.

Request

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

Responses

Status Description
200 Bank batch details.
401 Access token is missing, expired, revoked, or invalid.
403 Token lacks the required scope or granted accounting context.
404 Resource does not exist in the granted accounting context.

200 example

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

{
  "data": {
    "id": "ad2f5fe3-d5e6-4234-b921-a70d4bf04f44",
    "bank_account_id": "b9d01a74-c53e-461b-bd68-e78a11691a9f",
    "source": "API",
    "description": "July 2026 bank activity",
    "records": 2,
    "created_at": "2026-08-10T09:43:00Z",
    "updated_at": "2026-08-10T09:43:00Z"
  }
}

Delete an unreconciled API bank batch

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

Required OAuth scope: bankbatches:write

Soft-deletes an API-created batch and all its transactions.

Deletion matrix

Batch state Result
API batch with no reconciled transactions 204 No Content
API batch containing a mapped or journaled transaction 409 bank_batch_reconciled
UPLOAD, MANUAL, or FEED batch 403 bank_batch_source_forbidden

Deletion does not remove journals. A batch must first be unreconciled through the accounting application before this operation can succeed.

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 whose books contain the bank account.
bank_account_id path Yes string (uuid) UUID of the bank account.
batch_id path Yes string (uuid) UUID of the bank batch.

Request

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

Responses

Status Description
204 Batch and its transactions were deleted. The response has no body.
401 Access token is missing, expired, revoked, or invalid.
403 The batch was not created by the developer API.
404 Resource does not exist in the granted accounting context.
409 At least one transaction has been reconciled.

409 example

HTTP/1.1 409 Conflict
Content-Type: application/problem+json

{
  "type": "https://api.finov.io/problems/bank_batch_reconciled",
  "title": "Bank batch cannot be deleted",
  "status": 409,
  "code": "bank_batch_reconciled",
  "detail": "A batch containing reconciled transactions cannot be deleted.",
  "request_id": "req_01J50Y7N6C4X8W2NV9P0Y6H3KQ"
}