v1
latestOpenAPI 3.1.02026-07-247328324.6 KBReceivables
List all items
get/creditors/{creditor_id}/receivables/{receivable_id}/items
Path parameters
creditor_idstring required
An object id with prefix
Example:user_0123456789ABCDEFGHIJKLMNOPq
An object id with prefix
receivable_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.
type'disbursement' | 'interest' | 'late_fee' | 'origination_fee' | 'periodic_fee' | 'principal' | 'refund' | 'other'
Type of the transaction being reported
Type of the transaction being reported
Response
Successful operation
Example response
{
"data": [
{
"date": "2024-01-15",
"amount": 10000,
"balance": 10000,
"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"
}
]
}