Skip to main content
POST
Mark a record as overdue

Authorizations

X-API-KEY
string
header
required

Path Parameters

reconciliation_id
string
required

The unique identifier of the reconciliation the record should be marked overdue in

record_id
string
required

The unique identifier of the record

Body

application/json
overdue_at
string<date-time>

When the record should be considered overdue. Defaults to the current time.

Response

The record's entry in the given reconciliation

A record's entry in one reconciliation. Match status, escalation, and matched records are all scoped to that reconciliation; a record has one entry per reconciliation it participates in. id is the record id.

amount
integer
required

The monetary amount in cents (e.g., 1234 = $12.34)

direction
enum<string>
required
Available options:
credit,
debit
date
string<date>
required
data_stream_key
string
required
id
integer
currency
string
default:USD

Three-letter ISO 4217 currency code (e.g. USD, EUR). Optional on create — defaults to USD when omitted. Case-insensitive on input; always returned uppercase.

Pattern: ^[A-Za-z]{3}$
decimal_places
integer
default:2

Number of decimal places for this currency (2 for USD)

description
string
metadata
object
external_id
string
reconciliation_id
integer
reconciliation_name
string
status
enum<string>

Whether the record is matched in this reconciliation. Read-only.

Available options:
reconciled,
unreconciled
escalated
boolean

Unmatched and past its overdue_at.

overdue_at
string<date-time> | null
matched_records
object[]

Records matched with this record in this reconciliation

days_unreconciled
integer | null

Number of days since the record's date. Null when the record is reconciled.

exception_id
integer | null

Open exception covering this entry's data stream when the entry is escalated. Null otherwise.