Receivables

List all entries

Changed on
get/receivables/{id}/entries

Request

Path parameters

idstring required

An object ID assigned and owned by the originator

Example:acct-123

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'date_desc'

Result order; defaults to date_desc

type'disbursement' | 'interest' | 'late_fee' | 'origination_fee' | 'periodic_fee' | 'principal' | 'refund' | 'sale' | 'other'

Type of the transaction being reported

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": [
    {
      "date": "2024-01-15",
      "amount": 10000,
      "balance": 10000,
      "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