Search Payable Invoices
Lists payable (open) invoices, optionally filtered by a free-text query.
Authentication: X-API-KEY header (see Authentication).
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | No | Exact invoice id. When provided, returns just that invoice (ignores query). |
| query | string | No | An exact client name. Returns that client's outstanding invoices. Omit to list all outstanding invoices. |
query here is not free text — it is matched to a client by name. If no client with that exact name exists, an empty array is returned.
Request
curl -X GET https://api.withmoxie.com/public/action/payableInvoices/search?query=VALUE \
-H "X-API-KEY: your_api_key_here"
Response
Returns an array of InvoiceMini objects, each including id, invoiceNumber, invoiceNumberFormatted, clientId, status, totals, tax, taxPercentage, taxRule, taxBreakdown, currency, viewOnlineUrl, payments, and a lineItems array (see below).
[
{
"id": "66b0f2a1c3a9e40012ab34cd",
"invoiceNumber": 1042,
"invoiceNumberFormatted": "E-2026-042",
"clientId": "66b0f2a1c3a9e40012ab3400",
"status": "SENT",
"invoiceType": "STANDARD",
"currency": "HUF",
"subTotal": 100.00,
"tax": 15.47,
"taxPercentage": 15.47375,
"taxRule": {
"id": "gst-pst",
"name": "GST + PST",
"source": "MOXIE",
"providerId": null,
"effectiveRate": 15.47375,
"components": [
{
"name": "GST",
"rate": 5.0,
"order": 0,
"compound": false,
"compoundOnOrder": null
},
{
"name": "PST",
"rate": 9.975,
"order": 1,
"compound": true,
"compoundOnOrder": null
}
]
},
"taxBreakdown": [
{
"name": "GST",
"rate": 5.0,
"order": 0,
"compound": false,
"taxableAmount": 100.00,
"amount": 5.00
},
{
"name": "PST",
"rate": 9.975,
"order": 1,
"compound": true,
"taxableAmount": 105.00,
"amount": 10.47
}
],
"total": 115.47,
"amountDue": 115.47,
"viewOnlineUrl": "https://pay.withmoxie.com/i/...",
"payments": [],
"lineItems": [
{
"id": "line_1",
"description": "Website design",
"quantity": 1,
"unitPrice": 100.00,
"unit": "project",
"taxable": true,
"lineTotal": 100.00,
"type": "ADHOC",
"visible": true,
"projectId": "66b0f4c3c3a9e40012ab6611",
"projectName": "Website Redesign",
"deliverableName": null
}
]
}
]
Line item (lineItems[])
| Field | Type | Description |
|---|---|---|
id | string | Line item id. |
description | string | Line description. |
quantity | number | Quantity. |
unitPrice | number | Price per unit. |
unit | string | Unit label (from the linked product, if any). |
taxable | boolean | Whether the line is taxable. |
lineTotal | number | quantity × unitPrice. |
type | enum | DEPOSIT, HOURS, RETAINER, OVERAGE, ADHOC, PROJECT, EXPENSE, TAX, DEPOSIT_APPLIED, LATE_FEE, … |
visible | boolean | Whether the line is shown on the rendered invoice. |
projectId, projectName, deliverableName | string | Project/deliverable context, when the line derives from one. |
Each line's taxable flag determines whether it contributes to the invoice's taxable base. Manual or basic tax uses taxPercentage. When a tax rule is selected—whether single, stacked, or compounded—it appears in taxRule, and taxBreakdown is the authoritative calculation for its components. Moxie does not allocate the calculated tax back to individual line items.
The create endpoints already return the invoice id and invoiceNumber, so store those at creation for the most reliable payment matching.