API

Get account

Get the AccountLink on a box (any source).

Returns the box’s AccountLink: source, payment/credit slots, paymentMode, and alertSettings. Works for manual, bank, and crypto.

GET/v1/get_account

Query

FieldTypeRequiredDefaultDescription
budgetIdstringYes—Budget that owns the box.
boxIdstringYes—Box whose funding link to load.

Response data

FieldTypeDescription
budgetIdstringId of the budget this resource belongs to.
boxIdstringId of the parent expense box.
accountLinkIdstringAccountLink document id.
sourcestringmanual, bank, or crypto.
paymentModestringaccount or creditCard.
creditCycleEndDaynumberCredit cycle end day 1–31 when paymentMode is creditCard.
paymentobjectPrimary funding slot (always uses accountId).
creditobjectOptional credit-card slot when paymentMode is creditCard.
alertSettingsobjectBox account alert rules (balanceThreshold, insufficientForPlan, creditExceedsPayment).