Create credit note refund

Create credit note refund in the credential-bound company. Call creditNote.refund.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 credit note refund, including the confirmation token returned by creditNote.refund.preview.

uuid

A money-out line your bank sent: the refund settles it instead of
recording a new line. Omit it to record a new line.

uuid
number

With bank_transaction_id: leave it out for one credit note in the line's
currency (the whole line); beside credit_notes, this credit note's part of
the line; for a credit note in another currency, what it settles in its own
currency (all that is open, or the line's worth at the day's rate).

date
string | null
string | null
string
required
length ≤ 8192
exchange_rate
object
credit_notes
array of objects
length between 1 and 19

With bank_transaction_id only: the same customer's other credit notes
the line refunds, each with its part; the parts add up to the line.

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