BillerAPI/Docs
Sign inGet started
Bill Sync

Bill Sync

Trigger and monitor bill synchronization for linked accounts. When a sync is triggered, BillerAPI fetches the latest bill data from the biller and updates your records.

Related guide: Retrieve Bills

The Sync Record object

A Sync Record captures a single bill-synchronization run for a linked account — when it started, how many bills it found or updated, and whether it succeeded.

Attributes

id*stringUnique sync record identifier
account_link_id*stringThe account link that was synced
status*stringSync status: PENDING, IN_PROGRESS, COMPLETED, FAILED
bills_foundintegerNumber of bills discovered during sync
bills_updatedintegerNumber of bills updated during sync
errorstringError message if sync failed
started_atstringISO 8601 timestamp when sync started
completed_atstringISO 8601 timestamp when sync completed
created_atstringISO 8601 timestamp when the record was created
The Sync Record object
{
  "id": "sync_abc123",
  "account_link_id": "al_xyz789",
  "status": "COMPLETED",
  "bills_found": 3,
  "bills_updated": 1,
  "error": null,
  "started_at": "2026-04-01T12:00:00Z",
  "completed_at": "2026-04-01T12:00:05Z",
  "created_at": "2026-04-01T12:00:00Z"
}
POST/bills/sync/trigger

Trigger a bill sync for a linked account. Returns immediately with a sync record; the sync runs asynchronously in the background.

Request body

account_link_id*stringThe account link to sync bills for
forcebooleanForce a full re-sync even if recently synced (default: false)
Sample uses your_client_id · sign in to auto-fill your sandbox key
curl -X POST https://sandbox.api.billerapi.com/bills/sync/trigger \
  -H "Authorization: Bearer $BILLERAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "account_link_id": "al_xyz789",
    "force": false
  }'
Response201 Created
{
  "id": "sync_abc123",
  "account_link_id": "al_xyz789",
  "status": "PENDING",
  "created_at": "2026-04-01T12:00:00Z"
}
GET/bills/sync

Get sync status and history for an account link.

Query parameters

account_link_id*stringFilter by account link ID
sincestringISO 8601 timestamp to filter syncs created after this date
limitintegerMaximum number of sync records to return (default: 20, max: 100)
include_deletedbooleanInclude deleted sync records (default: false)
Sample uses your_client_id · sign in to auto-fill your sandbox key
curl "https://sandbox.api.billerapi.com/bills/sync?account_link_id=al_xyz789&limit=10" \
  -H "Authorization: Bearer $BILLERAPI_API_KEY"
Response200 OK
{
  "syncs": [SyncRecord],
  "total": 5
}
Was this page helpful?