SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Invoicing

List invoices with filters.

List invoices with filters.

GEThttps://app.softsolz.uk/api/v1/services/invoicing/invoices

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.

Query Params

statusstring

Filter by invoice status.

customer_idinteger

Filter to one customer.

date_fromstring

Inclusive lower bound on issue_date (YYYY-MM-DD).

date_tostring

Inclusive upper bound on issue_date (YYYY-MM-DD).

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Pagination offset (default 0).

Response

Response Body · array of objects

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_paidstringAmount paid so far, 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 GET \
--url https://app.softsolz.uk/api/v1/services/invoicing/invoices \
--header 'Authorization: Bearer sk_live_your_key'

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",
"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"
}
],
"meta": {
"limit": 50,
"offset": 0,
"total": 1,
"has_more": false
}
}