SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
Invoicing

POSThttps://app.softsolz.uk/api/v1/services/invoicing/invoices/{id}/void

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

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

reasonstring | null

Optional void reason stored on the invoice.

Response

Response Body

idintegerInvoice id.
customer_idintegerCustomer id.
invoice_numberstringHuman invoice number.
issue_datestringIssue date (YYYY-MM-DD).
due_datestringDue date (YYYY-MM-DD).
currencystringISO 4217 currency code.
subtotalstringDecimal amount as a numeric string (NOT minor units).
tax_totalstringTotal tax, numeric string.
totalstringInvoice total, numeric string.
amount_paidstringMoney actually received against this invoice, numeric string. Credit notes are not included; see amount_credited.
amount_creditedstringTotal of credit notes applied to this invoice, numeric string.
balance_duestringWhat is still owed: total minus amount_paid minus amount_credited, never below zero, numeric string.
statusstringInvoice status.
linesarray of objectsInvoice line items.
paymentsarray of objectsRecorded payments; payments[].id is the payment_id used when issuing a refund.
created_atstringCreation timestamp.
updated_atstringLast update timestamp.

Request

curl --request POST \
  --url https://app.softsolz.uk/api/v1/services/invoicing/invoices/{id}/void \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "reason": "Duplicate invoice"
}'

Credentials

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 · 200

{
  "data": {
    "id": 1001,
    "customer_id": 42,
    "invoice_number": "INV-0007",
    "issue_date": "2026-01-15",
    "due_date": "2026-02-14",
    "currency": "GBP",
    "subtotal": "100.00",
    "tax_total": "20.00",
    "total": "120.00",
    "amount_paid": "0.00",
    "amount_credited": "0.00",
    "balance_due": "120.00",
    "status": "sent",
    "lines": [
      {
        "description": "Consulting, January",
        "quantity": 10,
        "unit_price": 10
      }
    ],
    "payments": [],
    "created_at": "2026-01-15T09:55:00.000Z",
    "updated_at": "2026-01-15T09:55:00.000Z"
  }
}