Preview Schedule Impact
POST/api/payment-terms/:payment_term/schedule-impact-preview
Dry-run a proposed vendor-deposit schedule against every non-terminal vendor deposit already created from this payment term, BEFORE saving the edit. Accepts the same vendor_deposit_schedule array as the update endpoint (payment_schedule alias also accepted; requires payment_terms.update permission).
Per affected deposit the outcome is:
will_realign— draft/pending deposits that Review & Resync can realign after savingshortfall— settled deposits whose recorded amount is now below the new expectationoverage— settled deposits whose recorded amount now exceeds the new expectationunchanged— settled deposits whose amount still matches
Settled deposits are never mutated — shortfalls/overages surface on the vendor-deposit cash-flow report.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.