Skip to main content

Payment Request Routing Preview

GET 
/api/vendor-deposits/payment-request-routing

Preview where a payment request would route before submitting. Drives the "Payment request will be sent to …" indicator in the Record Proforma Invoice drawer and the draft-deposit hint.

Required scope: accounting:read

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

Routing precedence: matching approval levels → the site-wide default payer (AccountingSettings.vendor_deposit_default_payer_user_id, set in Accounting Settings) → the legacy amount threshold.

Response fields:

  • mode — approval_levels | payer | self_payer | threshold_approval | auto_approve
  • payer — {id, name, email} of the resolved site-wide payer, or null
  • payer_configured — true when a payer id is configured even if unresolvable (admins are notified in that case)
  • levels_count — matching approval levels when mode=approval_levels

auto_approve means nothing is configured: submitting will auto-approve without notifying anyone — the UI warns and links to Accounting Settings.

self_payer means the acting user is themselves the configured payer: there is no one to send a request to, so submitting approves the deposit immediately and the payment can be recorded directly.

Approval policy: When the vendor-deposit approval policy is enabled it wins over every other routing source and mode is approval_policy. The response then adds tier (matched tier name), eligible_users (who can approve the first step) and approval_policy (the full routing preview: policy_enabled, requires_approval, amount_base, base_currency, tier_name, tier_up_to_amount, steps[], warnings[], requester_can_approve_directly, blocked_reason).

amount is in your home currency: approval levels are set in the home currency, so a foreign-currency deposit is previewed at its home-currency amount.

Request​

Responses​

OK

Response Headers
    Content-Type