Preview customer refund from bank line

Preview customer 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 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 customer refund from bank line without persisting changes.

creditNote.createFromBankLine.preview: money paid out to a customer on a
bank line (reconcile round 5 A39b, A35b).

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