SIsivo
Receivables

List receivable metrics

Changed on
get/receivable-metrics

Request

Query parameters

limitinteger

Maximum number of results to return, from 1 to 100; defaults to 25

pagestring

Opaque page token from a previous response's next_page or previous_page; pass it back unchanged, with the same sort and filters

expandstring[]

Extra fields to include in the page; total_count counts the matching results, exactly up to 10000

sort'created_at_desc'

Result order; defaults to created_at_desc

debt_line_idstring

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

Response

Successful operation

has_moreboolean required

Whether more results follow this page in the list order

next_pagestring nullable required

Token for the page after this one, or null when this is the last page

previous_pagestring nullable required

Token for the page before this one, or null when this is the first page

total_countinteger

Number of results matching the filters, exact up to 10000; 10001 means more than that. Only present when the request expands total_count

Example response

{
  "data": [
    {
      "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