Preview credit note refund

Preview credit note refund 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 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

Proposed values used to preview credit note refund without persisting changes.

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