v1

latestOpenAPI 3.1.02026-07-247328324.6 KB

Receivables

List all receivable s

get/creditors/{creditor_id}/receivables

Path parameters

creditor_idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

Query parameters

skipinteger

For pagination, skip a number of results

Example:42

For pagination, skip a number of results

takeinteger

Only take up to a number of results.

Example:42

Only take up to a number of results.

idstring

A cursor (bookmark) used to only return results equal or lower than the given id. More efficient than skip for large result sets.

Example:user_0123456789ABCDEFGHIJKLMNOPq

A cursor (bookmark) used to only return results equal or lower than the given id. More efficient than skip for large result sets.

metadataobject

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

debtor_idstring

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

program_idstring

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

Response

Successful operation

Example response

{
  "data": [
    {
      "debtor_id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "program_id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "origination_date": "2024-01-15",
      "currency": "USD",
      "delinquent_days": 42,
      "delinquent_amount": 10000,
      "delinquent_times": 42,
      "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"
      },
      "id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "created_at": "2024-01-15T10:30:00Z",
      "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
      "updated_at": "2024-01-15T10:30:00Z",
      "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
    }
  ]
}