SIsivo
Receivables

Get the metrics for a receivable

Changed on
get/receivables/{id}/metric

Request

Path parameters

idstring required

An object ID assigned and owned by the originator

Example:acct-123

Response

Successful operation

idstring required

Receivable ID

created_atstring date-time required

When the metric row was created

updated_atstring date-time required

When the metric row was last updated

outdated_atstring date-time required

When the metric row was last marked as needing recalculation

debt_line_idstring nullable

The most recent active debt line for the originator

loan_aprnumber nullable

APR calculated from the receivable properties (fees, interest rate, and term)

xirr_aprnumber nullable

APR calculated from the full receivable cash flows using XIRR

simple_aprnumber nullable

APR calculated from the net receivable cash flows without compounding

aprnumber nullable

Effective APR chosen between xirr_apr and simple_apr, capped by loan_apr

balanceinteger nullable

Latest reported balance of the receivable, floored at 0 (a negative balance holds no value) and 0 once it defaults

default_balanceinteger nullable

Balance at the time the receivable went into default

disbursedinteger nullable

Total amount disbursed to the obligor

closed_onstring date nullable

Date on which the receivable was reported closed

status'active' | 'closed' | 'null' nullable

Latest reported status of the receivable

repayment_daysinteger nullable

Days from the first disbursement (or origination) to collection in full; empty while the receivable is outstanding

Example response

{
  "id": "acct-123",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "outdated_at": "2024-01-15T10:30:00Z",
  "debt_line_id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "balance": 10000,
  "default_balance": 10000,
  "disbursed": 10000,
  "closed_on": "2024-01-15",
  "repayment_days": 42
}

Changes