Finalize a Staged Snapshot

Finalization is accepted only when received_row_count equals expected_row_count.

Authentication

Requires debts:write. Uses the write limiter: 500 requests/hour per company. For every staged snapshot, send an empty body or {}:

curl -X POST "https://getbill.io/external-api/v1/campaigns/client-a-2026/snapshots/export-2026-07-17-550e8400/finalize" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

HTTP/1.1 202 Accepted
Location: /external-api/v1/campaigns/client-a-2026/snapshots/export-2026-07-17-550e8400

{
  "error": false,
  "message": "Snapshot finalization accepted",
  "data": {
    "api_reference": "client-a-2026",
    "snapshot_reference": "export-2026-07-17-550e8400",
    "delivery_mode": "staged",
    "status": "pending",
    "core_applied": false,
    "expected_row_count": 2500,
    "received_row_count": 2500,
    "received_chunk_count": 3,
    "next_chunk_index": 3,
    "counts": null,
    "failure": null,
    "created_at": "2026-07-17T09:00:00Z",
    "updated_at": "2026-07-17T09:03:00Z",
    "status_url": "/external-api/v1/campaigns/client-a-2026/snapshots/export-2026-07-17-550e8400"
  }
}

Poll status_url. Repeating finalize while pending or processing returns 202; repeating it after completed or failed returns 200. A pending retry may enqueue another transport message, but the atomic worker claim prevents duplicate processing. An incomplete upload returns 409 snapshot_incomplete. processing_error returns 409 because GetBill operator recovery is required.

Get started

Guides

SFTP integration

Company API

Creditors API

Debtors API

Debts API

Timelines API

Campaigns API

Settings API

Invoice documents API

Followups API

Todos API

Status API

Authentication

​Authentication

Authentication