Record Statement Balance

POST

/schedules/statement-balance

curl --request POST \
  --url https://example.com/schedules/statement-balance \
  --header 'Content-Type: application/json' \
  --data '{ "account": "example", "due_date": "2026-04-15", "statement_balance": 1, "statement_date": "2026-04-15", "transaction_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Record a credit card’s statement balance against the payment it is due on. The payment instance takes the statement balance (both legs move, the card’s leg = the balance), is pinned so the current-balance estimate no longer moves it, and reports basis: statement; the statement, its closing date and who recorded it stay on the instance. Recording again replaces it; resetting the instance removes it. Credit cards only — a loan payment is an ordinary override (PATCH /transactions/{id}).

Request Body^required

Media typeapplication/json

StatementBalanceIn

A card statement balance for the payment it is due on (decision 80). Address the payment instance by transaction_id, or by the card (account) plus the statement’s due_date.

object

account

Any of:

string

string

null

null

due_date

Any of:

string

string format: date

null

null

statement_balance

required

Any of:

number

number

string

string

statement_date

Any of:

string

string format: date

null

null

transaction_id

Any of:

string

string format: uuid

null

null

Example ^generated

{
  "account": "example",
  "due_date": "2026-04-15",
  "statement_balance": 1,
  "statement_date": "2026-04-15",
  "transaction_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

Successful Response

Media typeapplication/json

StatementBalanceOut

object

amount

required

Any of:

string

string

null

null

basis

required

Basis

Where the amount comes from: fixed, an estimate basis (last, rolling_avg_3, rolling_avg_12, counterparty_balance = the card’s current balance), override (a pinned instance: the amount is yours) or statement (a recorded card statement balance, decision 80)

string

Allowed values: fixed last rolling_avg_3 rolling_avg_12 counterparty_balance override statement

date

required

Date

string format: date

occurrence_date

required

Any of:

string

string format: date

null

null

overdue

required

Overdue

boolean

pinned

required

Pinned

Edited by a human/agent; exempt from rule refresh/resync

boolean

previous_amount

required

Previous Amount

The schedule account’s leg before the statement was recorded

string

schedule_id

required

Schedule Id

string format: uuid

statement_balance

Any of:

string

string

null

null

statement_date

Any of:

string

string format: date

null

null

statement_source

Any of:

string

string

Allowed values: human agent

null

null

transaction_id

required

Transaction Id

string format: uuid

Example

{
  "basis": "fixed",
  "statement_source": "human"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}