List a lockbox's remittances

GET/lockboxes/{id}/remittances

Path parameters

idstringRequired

Query parameters

limitintegerOptional

Page size

Default 10. Maximum 100.

starting_afterstringOptional

The id of the last item seen; returns the page after it

ending_beforestringOptional

The id of the first item seen; returns the page before it

Returns

200 OK

dataarray of objectsRequired

9 child attributes

batch_countintegerRequired

business_datestring · dateRequired

A business date, YYYY-MM-DD

created_atstring · date-timeRequired

idstringRequired

item_countintegerRequired

itemsarray of objectsOptional

8 child attributes

amountintegerRequired

batch_numberintegerRequired

check_deposit_idstringOptional

idstringRequired

invoicesarray of objectsOptional

2 child attributes

amountintegerRequired

numberstringRequired

item_numberintegerRequired

microbjectRequired

MICR is a check's magnetic line.

4 child attributes

aux_on_usstringOptional

check_numberstringOptional

on_usstringRequired

Account number, "/" and serial as printed

payor_routing_numberstringRequired

remitterstringOptional

lockbox_idstringRequired

statusstringRequired

total_amountintegerRequired

has_morebooleanRequired

Whether another page follows

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503