Record supplier refund from bank line

Record supplier refund from bank line in the credential-bound company. Call vendorCredit.createFromBankLine.preview first and include its confirmation token when committing this action. Idempotency-Key is required and stores the terminal response for safe retries for 24 hours. If-Match is required with the latest ETag; stale versions return 412. This action posts accounting effects. 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

Confirmed values used to record supplier refund from bank line, including the confirmation token returned by vendorCredit.createFromBankLine.preview.

vendorCredit.createFromBankLine: the preview's body and token, with the same Idempotency-Key.

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.

string
required
length ≤ 8192
Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

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
*/*