search_flows
Search flows in the Approved Platform by filtering on flow type, status, processing rule, period, or tracking ID. Paginate results using the nextUpdatedAfter field.
Instructions
Search flows (invoices, statuses, e-reportings) in the Approved Platform by criteria: flow type, status, processingRule, period, trackingId. Pagination via updatedAfter: use the 'nextUpdatedAfter' field from the response as the updated_after parameter value to get the next page.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| processing_rule | No | Filter by processing rule: B2B, B2BInt, B2C, OutOfScope, ArchiveOnly, NotApplicable. | |
| flow_type | No | Filter by flow type: Invoice, CreditNote, EReportingB2B, EReportingB2C, LifecycleStatus, etc. | |
| status | No | Filter by flow status. Examples: Deposited, Processing, Delivered, Rejected, Approved, Refused. Refer to the AP documentation for the complete list. | |
| updated_after | No | Pagination: only return flows updated after this date/time (ISO 8601 format, e.g. 2024-09-01T00:00:00Z). Use the 'nextUpdatedAfter' value from the previous response to paginate. | |
| tracking_id | No | Filter by trackingId (sender free-form identifier, maxLength 36). | |
| limit | No | Maximum number of flows to return (1-500, default 50). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||