Skip to main content
GET
Get an approval

Authorizations

Authorization
string
header
required

An API key, pk_live_… or pk_test_….

Path Parameters

id
string
required

The id.

Response

OK

id
string
kind
enum<string>

ADJUSTMENT: adj_

REVERSAL: rev_

FREEZE: frz_

LIMIT_CHANGE: lim_

FX_RATE: fx_

INTEGRATION_MODE: mod_

NAMED_ACCOUNT_CHANGE: nac_

API_KEY: kyr_

PERIOD_CLOSE: prd_

INTERNAL_ACCOUNT: iac_

LEDGER: ldg_

MODULES: mdl_

TEAM_CHANGE: tmc_ ; confirmed by a second tenant admin or an approver

FEE_SCHEDULE: fee_

Available options:
ADJUSTMENT,
REVERSAL,
FREEZE,
LIMIT_CHANGE,
FX_RATE,
INTEGRATION_MODE,
NAMED_ACCOUNT_CHANGE,
API_KEY,
PERIOD_CLOSE,
INTERNAL_ACCOUNT,
LEDGER,
MODULES,
TEAM_CHANGE,
FEE_SCHEDULE
status
enum<string>

APPROVED: and applied

FAILED: approved, but applying it was refused (for example INSUFFICIENT_FUNDS)

Available options:
WAITING,
APPROVED,
REJECTED,
WITHDRAWN,
FAILED
title
string
reason
string
proposedBy
object

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

approvalsRequired
integer<int32>

2 above tenant_policies.single_approver_max

decisions
object[]
amount
string

the money at stake, when there is any Minor units, as a string.

currency
string
postings
object[]

What will happen on approval. For ADJUSTMENT and REVERSAL this is the entry to be posted.

proposal
object

kind-specific fields, schema per kind

subjectId
string

the account, entry, break or binding this is about

breakId
string
entryId
string

the entry posted on approval

failureCode
string
canDecide
boolean

Computed for the caller. has approve scope, did not propose it, has not already decided

requiresStepUp
boolean
createdAt
string<date-time>
decidedAt
string<date-time>