List all receivables

get

https://core.sivo.com/receivables

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

1 to 100

Defaults to 25

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

page

string

length between 1 and 1024

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

expand

array of strings

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

expand

Allowed:

sort

string

enum

Defaults to created_at_desc

Result order; defaults to created_at_desc

Allowed:

creditor_id

string

length between 1 and 255

An object ID assigned and owned by the originator

obligor_id

string

length between 1 and 255

An object ID assigned and owned by the originator

metadata

object

Metadata filters, use the following format to construct a clause for a metadata search: metadata["

debt_line_id

string

^[a-z]{3,7}_[0-9A-Za-z]{27}$

Only the receivables evaluated against this debt line

funded_by

string

enum

Indicates whether this receivable is funded by sivo, your own balance sheet, or a third party capital source

Allowed:

outstanding

true: only the receivables with a balance still owed; false: only those without one

eligibility

enum

eligible: meeting every eligibility criterion of their debt line; ineligible: failing at least one; a criterion name (e.g. term_length): failing that criterion. Receivables not evaluated against a debt line yet never match

Response

200Successful operation