Create From Bank Line credit note

Create From Bank Line credit note in the credential-bound company. Call creditNote.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 credit-notes: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 create from bank line credit note, including the confirmation token returned by creditNote.createFromBankLine.preview.

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

string
enum
required

money_back: a credit note on the invoice, settled by the line. paid_too_much: the line to Refunds owed for the customer, No VAT, no credit note.

Allowed:
uuid
required

The customer's invoice paid in full, in the line's currency.

string | null

money_back, an invoice of several lines: the line that came back, or whole.

string | null
enum

money_back over 3 years after the sale's VAT period (needs manage_period_lock): keep or reverse.

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