Shop credit note request

post/invoices/{id}/credit-notes

Ask for a credit note against a numbered invoice (the whole invoice or chosen lines). A person issues it.

Before you call

Credential: Authorization: Bearer $KEY
Scope: shop:write
Mcp: rivier_invoices_credit_note_request
Graphql: Mutation.requestCreditNote
Sdk: shop.creditNote.request
Cli: shop credit note request

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

reasonstringrequired
At most 300 characters.
fullboolean
Default: false.
lineslist of object
Default: [].
- descriptionstringrequired
  At most 500 characters.
- quantitynumber
  Default: 1. At most 1000000.
- unitstring
  Default: C62. At most 10 characters.
- unitAmountMinorintegerrequired
  At least 0. At most 99999999999.
- discountMinorinteger
  Default: 0. At least 0. At most 99999999999.
- taxRateBpinteger
  At least 0. At most 10000.
- taxCategorystring
  One of: S, Z, E, AE, K, G, O, L, M. Default: S.
- productIdstring (uuid)
- sourceobject
  - kindstringrequired
    At most 40 characters.
  - idstringrequired
    At most 120 characters.
idempotencyKeystringrequired
At most 120 characters.

Responses

201application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/invoices/{id}/credit-notes' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "reason": "string",
  "idempotencyKey": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown