Mark an invoice as paid with a manual payment record.

POSThttps://staging.softsolz.uk/api/v1/services/invoicing/invoices/{id}/mark-paid

Recent Requests

TimeStatusUser Agent

Make a request to see history.

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

amountnumber | string

Payment amount in major currency units (> 0, max 2 decimal places; a numeric string like "120.00" avoids float precision). Cannot exceed the outstanding balance.

methodstring

Payment method (default "manual").

referencestring | null

External payment reference (e.g. cheque or transfer id); stored on the payment record.

received_atstring | null

When payment was received. Defaults to now.

Response

Response Body

paymentIdintegerNew payment id.

invoiceIdintegerInvoice id.

finalStatusstringInvoice status after the payment.

invoiceobjectThe updated invoice (invoice detail shape).

Request

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

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

const result = await client.invoicing.markInvoicePaid('<id>', {});
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": {
    "paymentId": 0,
    "invoiceId": 0,
    "finalStatus": "string",
    "invoice": {}
  }
}