GET
/api/public/v1/invoices/{invoiceId}Get an invoice
One invoice with its line items and every payment recorded against it. The `id` is the capability in the public pay link — anyone holding it can pay the invoice, so treat it as a secret.
Required scope
The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.
invoices:read
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Required | Invoice ID. |
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/invoices/{invoiceId}" \
-H "Authorization: Bearer your_access_token"200Example response
json
{
"message": "Invoice retrieved successfully!",
"content": {
"invoice": {
"id": "9f1c2f4e-6b3a-4f28-9c11-0a2b3c4d5e6f",
"referenceId": 1042,
"status": "OPEN",
"counterpartyName": "Northwind Traders",
"counterpartyEmail": "ap@northwind.example",
"memo": "Website build — phase one",
"notes": null,
"dueDate": "2026-09-30T00:00:00.000Z",
"dueNowAmount": 250000,
"currency": "usd",
"legalEntityId": "le_7788",
"lineItems": [
{
"id": "ili_1",
"description": "Design and build",
"quantity": 1,
"unitAmount": 250000,
"kind": "ONE_TIME",
"dueNow": true,
"sortOrder": 0
},
{
"id": "ili_2",
"description": "Hosting and support",
"quantity": 1,
"unitAmount": 15000,
"kind": "RECURRING",
"dueNow": true,
"interval": "MONTH",
"intervalCount": 1,
"installments": 12,
"sortOrder": 1
}
],
"viewedAt": null,
"paidAt": null,
"createdAt": "2026-08-22T15:00:00.000Z",
"updatedAt": "2026-08-22T15:00:00.000Z"
}
}
}In the console
The same thing done by hand, for anyone comparing the API against the screen they already use.