Skip to main content
GET
Get a break

Authorizations

Authorization
string
header
required

An API key, pk_live_… or pk_test_….

Path Parameters

id
string
required

The id.

Response

OK

id
string

brk_…

kind
enum<string>

UNBOUND_CREDIT: credit to a number with no active binding

MISSING_AT_PARTNER: in the ledger, not on the statement

MISSING_IN_LEDGER: on the statement, not in the ledger (for example a partner charge)

Available options:
UNBOUND_CREDIT,
AMOUNT_MISMATCH,
MISSING_AT_PARTNER,
MISSING_IN_LEDGER,
DUPLICATE_NOTICE,
DUPLICATE_POSTING
status
enum<string>

PROPOSED: an adjustment is waiting for approval

Available options:
OPEN,
PROPOSED,
RESOLVED
title
string
partner
string
partnerName
string
currency
string
partnerAmount
string

empty when the partner has no line Minor units, as a string.

ledgerAmount
string

empty when the ledger has no entry Minor units, as a string.

difference
string

partner minus ledger, signed Minor units, as a string.

externalId
string

the partner's transaction id

accountNumber
string

where the partner says it went

entryId
string
statementId
string
assignedTo
object

Who did something: a person signed in to the console, or an API key.

approvalId
string
resolution
string
notes
object[]
openedAt
string<date-time>
resolvedAt
string<date-time>