Preview supplier refund from bank line

Preview supplier refund from bank line in the credential-bound company. This preview validates and describes the proposed effects without writing changes. The required Idempotency-Key coordinates this operation but does not provide durable response replay. Requires the vendor-credits:action OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Proposed values used to preview supplier refund from bank line without persisting changes.

vendorCredit.createFromBankLine.preview: money a supplier sent back on a
bank line (reconcile round 5 A39c; A33, A33b).

string
enum
required

money_back: a supplier credit from the bill's own lines. paid_too_much: a payment made too much. credit_note: their credit note from the inbox.

Allowed:
uuid | null

money_back and credit_note: the supplier's bill the money is for.

uuid | null

money_back: the one bill line that came back.

boolean | null

money_back: the whole bill in proportion across its lines; never with bill_line_id.

string | null
enum

money_back, a bill whose VAT period ended over 3 years ago (needs manage_period_lock).

Allowed:
number | null

The bank line's amount, as a check: any other is refused.

uuid | null

paid_too_much: the supplier who sent it.

uuid | null

credit_note: their credit note in the inbox.

Headers
string
required
length ≤ 191

Required operation-specific request key. This requirement does not imply durable public API response replay.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*