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://staging.softsolz.uk/api/v1/services/invoicing/credit-notes

Recent Requests

TimeStatusUser Agent

Make a request to see history.

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_idinteger

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

amountnumber | string

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

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.invoicing.createCreditNote({});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 201

{
  "data": {
    "id": 0,
    "credit_note_number": "string",
    "source_invoice_id": 0,
    "amount": "string",
    "status": "string",
    "created_at": "string"
  }
}