Issue a credit note against a posted invoice. If an approval policy matches, responds 202 with { pending_approval: true, approval_instance_id, approval_status_url, message }; poll GET /approvals/:id.

POSThttps://app.softsolz.uk/api/v1/services/invoicing/credit-notes

Recent Requests

Kept only in this browser

TimeStatusTook

Send a request with Try it to see it here.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

invoice_idintegerrequired

Source invoice id (posted, not void/written_off).

amountnumber | stringrequired

Credit amount in major units (> 0, max 2 decimal places, <= outstanding balance; numeric strings accepted).

issue_datestring

Issue date; defaults to today.

reasonstring | null

Optional reason.

Response

Response Body

idintegerCredit note id.

credit_note_numberstringHuman credit-note number.

source_invoice_idintegerSource invoice id.

amountstringCredit amount, numeric string.

statusstringCredit-note status.

created_atstringCreation timestamp.

Request

curl --request POST \
  --url https://app.softsolz.uk/api/v1/services/invoicing/credit-notes \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoice_id": 1001,
  "amount": "50.00",
  "issue_date": "2026-01-25",
  "reason": "Goodwill adjustment"
}'

Credentials

Authorization

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 201

{
  "data": {
    "id": 3001,
    "credit_note_number": "CN-0008",
    "source_invoice_id": 1001,
    "amount": "50.00",
    "status": "issued",
    "created_at": "2026-01-25T11:00:00.000Z"
  }
}