List Expected Deposit Milestones
GET/api/vendor-deposits/expected-milestones
List expected deposit milestones derived from the payment-term schedules of draft and open purchase orders. Each milestone describes an installment: its trigger event, expected amount, due date, and lifecycle status — expected (trigger not reached), ready_to_create (trigger reached, no deposit yet), created (linked to a deposit), or out_of_sync (linked deposit no longer matches the schedule).
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Use unlinked_only=1 to list only milestones that should create a deposit but have none linked yet.
Final-goods-invoice lines report two additional statuses: awaiting_invoice (trigger reached, amount owed, settles when the supplier's bill is entered) and invoiced (a purchase invoice covers the milestone — see linked_purchase_invoice_id / linked_purchase_invoice_number). These lines never become vendor deposits. The summary block includes awaiting_invoice_count and invoiced_count.
Request
Responses
- 200
- 401
- 403
- 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.
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.