SIsivo
Debt Lines

List the receivables a debt line funds

Changed on
get/debt-lines/{id}/receivables

Request

Path parameters

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

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'origination_date_desc' | 'origination_date_asc' | 'balance_desc' | 'balance_asc'

Result order; defaults to origination_date_desc

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",
      "metric": {
        "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
      },
      "receivable": {
        "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"
      },
      "obligor": {
        "website": "https://acme.com",
        "email": "email@domain.com",
        "phone": "+14155551234",
        "industry": "541511",
        "legal_entity_id": "duns:123456789",
        "credit_score": "paydex:123",
        "active_since": "2024-01-15",
        "monthly_revenue": 10000,
        "monthly_costs": 10000,
        "cash_on_hand": 10000,
        "avg_sale_size": 10000,
        "buyer_concentration": 0.05,
        "average_days_to_pay": 42,
        "lifetime_spend": 10000,
        "customer_count": 42,
        "insurance": {
          "rating": "coface:8",
          "limit": 10000,
          "coverage": 0.05
        },
        "metadata": {
          "key": "value"
        },
        "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