SIsivo
Receivables

List all receivables

Changed on
get/receivables

Request

  • Base URL
    https://core.sivo.com
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization codehttps://dashboard.sivo.com/oauth/authorize
      Client credentials
      Token URLhttps://core.sivo.com/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

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

creditor_idstring

An object ID assigned and owned by the originator

Example:acct-123
obligor_idstring

An object ID assigned and owned by the originator

Example:acct-123
metadataobject

Metadata filters, use the following format to construct a clause for a metadata search: metadata["<field>"]:<value>

debt_line_idstring

Only the receivables evaluated against this debt line

Example:user_0123456789ABCDEFGHIJKLMNOPq
funded_by'sivo' | 'balance_sheet' | 'other'

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

boolean
OR
string
'eligible' | 'ineligible'
OR
'obligor_type' | 'country' | 'currency' | 'product_type' | 'term_length' | 'credit_limit' | 'max_balance' | 'apr' | 'review'

Eligibility criterion evaluated for a receivable

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": [
    {
      "obligor_id": "acct-123",
      "origination_date": "2024-01-15",
      "currency": "USD",
      "delinquent_amount": 10000,
      "delinquent_times": 42,
      "creditor_id": "acct-123",
      "origination_fee": 10000,
      "periodic_fee": {
        "cycle_type": "30 days",
        "amount": 10000
      },
      "term": "30 days",
      "interest_rate": 0.05,
      "credit_limit": 10000,
      "payment_frequency": "30 days",
      "metadata": {
        "key": "value"
      },
      "delinquent_since": "2024-01-15",
      "fiscal_id": "cfdi:550e8400-e29b-41d4-a716-446655440000",
      "id": "acct-123",
      "created_at": "2024-01-15T10:30:00Z",
      "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
      "updated_at": "2024-01-15T10:30:00Z",
      "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
    }
  ]
}

Changes