List Expected Vendor Deposit Milestones
GET/api/purchase-orders/:purchase_order/expected-vendor-deposit-milestones
List the expected payment milestones for a purchase order, derived from its payment-term deposit schedule.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns one row per schedule line. Per-shipment lines fan out into one row per inbound shipment (key line-{n}-shipment-{id}), plus a line-{n}-remainder row for PO value not yet assigned to a shipment. If the payment term has no schedule, a single synthesized Final Invoice Balance milestone (key synthesized-final-balance) covers the un-deposited remainder.
Each milestone's status is one of:
expected— planned but the trigger event has not happened yetready_to_create— the trigger has been reached; the milestone can be turned into a vendor depositcreated— a vendor deposit is already linked (linked_vendor_deposit_id)out_of_sync— the linked deposit no longer matches the schedule (amount, due date, trigger, or shipment changed); seestatus_reasons
Use the key value with Create Vendor Deposit from Milestone to materialize a ready_to_create milestone.
Read-only. Requires the purchase-orders:read token scope.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.