Retrieves the collection of CollectionOrder resources.

This endpoint allows you to retrieve a paginated list of collection orders. ### Filters You can filter the results using the following query parameters: | Filter | Description | Example | |--------|-------------|---------| | debtor_number | Exact match on debtor number | ?debtor_number=123456 | | payment_reference | Exact match on payment reference | ?payment_reference=REF001 | | status | Filter by status (single value) | ?status=active | | status[] | Filter by status (multiple values) | ?status[]=active&status[]=paid | | status_datetime | Filter by status date (YYYY-MM-DD) | ?status_datetime=2025-06-01 | | created_datetime | Filter by creation date (YYYY-MM-DD) | ?created_datetime=2025-06-01 | ### Collection Order Status The status of a collection order can be one of the following: - active — The collection order is active and in progress - paid — Full amount has been paid - agreed — A payment agreement has been reached - pause — The collection order is paused - cancel — The collection order has been cancelled - withdraw — The collection order has been withdrawn - processing — The collection order is being processed - settlement — A settlement has been reached - merged — The collection order has been merged with another - payment_scheduled — A payment has been scheduled - end — The collection order has ended ### Pagination Results are paginated. Use page and itemsPerPage query parameters to navigate. The response includes total_items, items_per_page, and page_count metadata. ### Response fields Each collection order in the response contains: | Field | Description | |-------|-------------| | collection_order_id | Unique identifier of the collection order | | status | Current status of the collection order | | flow_id | The ID of the flow assigned to this collection order | | flow_step | The current step number in the flow | | amount | Total amount in cents | | status_datetime | Date and time of the last status change | | created_datetime | Date and time the collection order was created | | debtor_number | Identifier for the debtor | | payment_reference | Identifier for the payment request | For full details of a specific collection order, use the /v3/collection_orders/{id}/detail endpoint.