Get Purchase Order Cash Flow Schedule
GET/api/purchase-orders/cash-flow-schedule
Get the purchasing cash-flow schedule — expected vendor payments derived from all open, non-archived purchase orders.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Each expected payment row is built from the best available source, reported as forecast_source:
scheduled— the PO's own payment-term deposit schedule (high confidence)inferred— the supplier's default payment-term schedule or default deposit percentage (medium confidence)heuristic— a due date estimated from PO/shipment ETD or ETAunscheduled— no schedule and no usable date; rows with a nulldue_dateare always included regardless of the date window
If a milestone already has a linked vendor deposit, the row amount reflects that deposit's remaining open exposure and the deposit's own due date takes precedence. Fully settled milestones are omitted.
The response contains time buckets (by the chosen granularity), per-source sections with full rows, a per-source summary, and overall exposure totals including overdue and due-in-7/30-day figures.
Read-only. Requires the purchase-orders:read token scope.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.