Skip to main content

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).

Required scope: settings:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Per affected deposit the outcome is:

  • will_realign — draft/pending deposits that Review & Resync can realign after saving
  • shortfall — settled deposits whose recorded amount is now below the new expectation
  • overage — settled deposits whose recorded amount now exceeds the new expectation
  • unchanged — settled deposits whose amount still matches

Settled deposits are never mutated — shortfalls/overages surface on the vendor-deposit cash-flow report.

Sales mode: send {"mode": "sales"} instead of a vendor-deposit schedule to list the open sales orders (not draft, closed or cancelled) whose billing schedule was taken from this term. Editing the term's sales billing schedule bumps its revision and these orders keep the revision they were created with. Returns mode, current_revision, open_orders_count and the first 20 order_numbers.

Request​

Responses​

OK

Response Headers
    Content-Type