List credit ledger entries

POST {{baseUrl}}/credits/listEntries?next_page=<string>

Fetches a list of credit ledger entries. Returns lists of ledgers per customer. Ledger entries are returned in chronological order. Ledger entries associated with voided credit grants are not included.

Request Params

Request Body

{"customer_ids"=>["<uuid>", "<uuid>"], "credit_type_ids"=>["<uuid>", "<uuid>"], "starting_on"=>"<dateTime>", "ending_before"=>"<dateTime>"}

HEADERS

RESPONSES

status: OK

{"data":[{"customer_id":"\u003cuuid\u003e","ledgers":[{"credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"starting_balance":{"excluding_pending":"\u003cnumber\u003e","including_pending":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e"},"ending_balance":{"excluding_pending":"\u003cnumber\u003e","including_pending":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e"},"entries":[{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"},{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"}],"pending_entries":[{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"},{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"}]},{"credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"starting_balance":{"excluding_pending":"\u003cnumber\u003e","including_pending":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e"},"ending_balance":{"excluding_pending":"\u003cnumber\u003e","including_pending":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e"},"entries":[{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"},{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"}],"pending_entries":[{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"},{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"}]}]},{"customer_id":"\u003cuuid\u003e","ledgers":[{"credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"starting_balance":{"excluding_pending":"\u003cnumber\u003e","including_pending":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e"},"ending_balance":{"excluding_pending":"\u003cnumber\u003e","including_pending":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e"},"entries":[{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"},{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"}],"pending_entries":[{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"},{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"}]},{"credit_type":{"name":"\u003cstring\u003e","id":"\u003cuuid\u003e"},"starting_balance":{"excluding_pending":"\u003cnumber\u003e","including_pending":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e"},"ending_balance":{"excluding_pending":"\u003cnumber\u003e","including_pending":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e"},"entries":[{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"},{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"}],"pending_entries":[{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"},{"amount":"\u003cnumber\u003e","reason":"\u003cstring\u003e","running_balance":"\u003cnumber\u003e","effective_at":"\u003cdateTime\u003e","created_by":"\u003cstring\u003e","credit_grant_id":"\u003cuuid\u003e","invoice_id":"\u003cuuid\u003e"}]}]}],"next_page":"\u003cstring\u003e"}