Practice Manager API
Invoices
Invoices, estimates, and credit memos share the same routes, distinguished by invoiceType. Every invoice object includes a derived status field (draft, approved, sent, unpaid, partial, paid, overdue, void) alongside the raw isDraft / approved / isSent / paymentStatus flags. All references use UUIDs.
Last updated 2026-11-18
Some fields work differently in US and NZ workspaces
Showing US sales tax and NZ GST rules.
Overview
The Invoices API lets your integration create, list, update, approve, send, and delete invoices, estimates, and credit memos in a workspace. All document types share the same `/firm-partners/workspace/invoices` routes and are distinguished by `invoiceType` (`invoice`, `estimate`, or `memo`).
Every invoice-shaped object includes a derived `status` field (for example draft, approved, sent, unpaid, partial, paid, overdue, void) computed from `isDraft`, `approved`, `isSent`, and `paymentStatus`. Partner responses expose UUIDs as `id` and strip internal numeric foreign keys. For migrations you may pass inline `customer` or per-line `product` objects instead of UUIDs, or set `isDraft: false` to post revenue journals in one step.
Key concepts
Document types
Set `invoiceType` to `invoice` (default), `estimate`, or `memo` (credit memo). Credit memos cannot be recurring — use Recurring Invoice Templates for scheduled invoices only.
Derived status
Partner responses include a computed `status` alongside raw flags. After send, an open unpaid invoice may surface as `sent` rather than `unpaid`. See the backend `computePartnerInvoiceStatus` helper for the full mapping.
Line item taxes
On create, `unitPrice` is copied to `price` when omitted. A line's tax codes go in `taxes` (tax UUIDs from List tax codes); omit it to take the product's codes. `nonTaxable` behaves differently in US and NZ workspaces — see the US and NZ cards.
US· Sales taxLine taxes
Each line charges the sales tax codes in its `taxes` array, or the product's codes when `taxes` is omitted. `nonTaxable: true` keeps the code but charges no tax, so the sale reports as Non-Taxable under that code. A tax-exempt customer's taxed lines are raised Non-Taxable unless the line sends `customerExemptionOverridden: true`.
NZ· GSTLine GST codes
Each line carries a GST code in `taxes`: `15% GST on Income` (standard-rated), `Zero Rated` (counted in GST return boxes 5 and 6), or `No GST` (left off the GST return). Zero Rated and No GST are both 0% but are different codes. Pick them by UUID from List tax codes. `nonTaxable: true` and `taxes: []` both raise the line with no code at all, which is never a zero-rated supply.
Foreign-currency rate
A document in another currency is booked at the spot rate for its date, from Open Exchange Rates unless the workspace has its own rate for that currency. To use your rate instead, send `bookingExchangeRate` with `exchangeRateSource: "user"`. The document keeps its face amounts in its own currency; responses also carry `bookingExchangeRate`, `exchangeRateDate`, `exchangeRateSource` (`OXR`, `user`, `bank` or `date_override`) and `baseTotal`, the total in the workspace currency.
Revaluation and currency gains
COUNT revalues open foreign-currency AR, AP and foreign-currency accounts at the closing rate at each month end, posting to Unrealised Currency Gain/Loss and reversing on the first day of the next month. When a payment settles a foreign document at a different rate, the difference posts to Realised Currency Gain/Loss. Both accounts are created automatically, so there is nothing to post yourself.
Free-text lines
A line with no `productUuid` is a free-text line — the app's "Custom" line. It needs `categoryAccountUuid` (the income account it posts to), carries its item name in `name` and any detail in `description`, and takes only the taxes it names. Product lines may also send `categoryAccountUuid` to post to a different income account than the product's own. Unrecognized line fields are ignored and reported in `_partnerWarnings`.
Lifecycle and allowed operations
Typical flow: create (draft) → approve → send → pay via assign-to-bills-invoices. update/delete work on drafts only; send requires approval; there is no revert-to-draft API — use credit memos to correct approved invoices.
Credit application
Apply credit memos to invoices with the apply-multiple-credit and apply-credit-to-multiple-invoices routes. All IDs in those bodies are partner invoice UUIDs (the `id` field on invoice/memo objects).
The invoice object
Core fields returned on invoice, estimate, and credit memo records.
Attributes
iduuidDocument identifier (UUID). Use in path parameters.
invoiceNumberstringHuman-readable document number.
invoiceTypeenumDocument type.
One of: invoice, estimate, memo
customerUuiduuidUUID of the customer this document belongs to.
datedateDocument date (ISO).
dueDatedateDue date (ISO), when applicable.
currencystringISO 4217 currency code.
statusstringDerived lifecycle status (draft, approved, sent, unpaid, partial, paid, overdue, void, etc.).
isDraftbooleanWhether the document is still a draft.
approvedbooleanWhether the document has been approved.
isSentbooleanWhether the document has been emailed to the customer.
paymentStatusstringRaw payment status (unpaid, partial, paid, etc.).
subtotalnumberSubtotal before tax.
taxTotalnumberTotal tax amount.
totalnumberGrand total including tax.
amountDuenumberOutstanding balance.
productsarrayProducts or services billed on this document.
createdAtdatetimeISO 8601 creation timestamp.
updatedAtdatetimeISO 8601 last update timestamp.
{
"id": "f6a7b8c9-d0e1-2345-fabc-456789012345",
"invoiceNumber": "INV-1042",
"invoiceType": "invoice",
"customerUuid": "dfa3219e-6af8-4c53-997a-037534f63a35",
"date": "2026-03-01",
"dueDate": "2026-03-31",
"currency": "USD",
"status": "sent",
"isDraft": false,
"approved": true,
"isSent": true,
"paymentStatus": "unpaid",
"subtotal": 1000,
"taxTotal": 85,
"total": 1085,
"amountDue": 1085,
"products": [
{
"productUuid": "aa11bb22-cc33-dd44-ee55-ff6677889900",
"description": "Consulting services",
"quantity": 10,
"unitPrice": 100,
"nonTaxable": false
}
],
"createdAt": "2026-03-01T09:00:00.000Z",
"updatedAt": "2026-03-02T11:15:00.000Z"
}Credit memos share these routes
Credit memos use the same endpoints with `invoiceType: "memo"`. See the Credit Memos API reference for memo-focused examples.Non-draft edits are restricted
Updates to approved or sent invoices are field-specific. Many invalid changes return 400. Concurrent updates may fail with a lock error.Three ways to send a file
JSON `attachments` entries take a public `url` (COUNT downloads and keeps a copy) or the file inline as `contentBase64` (up to 10 MB). The `/upload` routes take `multipart/form-data`. All three are held to the same per-file cap and file types, at most 10 files a request, and every file is virus-scanned before anything is saved. To read a file back without following a link, call the attachment's `/content` route, which returns it base64-encoded.File links are signed per response
Any `documentUrl`, `receiptUrl`, `pdfUrl` or `bankStatementUrl` on COUNT storage comes back as a short-lived signed link, minted only after COUNT proves the file belongs to this workspace. Use it straight away and call again for a fresh one; do not store it. A file COUNT cannot prove is the workspace's comes back as `null`. A link you attached to an outside file is returned exactly as you sent it.Related
Endpoints
/firm-partners/workspace/invoicesReturns a paginated list of invoices, estimates, or credit memos.
/firm-partners/workspace/invoices/{uuid}Retrieves a single invoice, estimate, or credit memo by its UUID.
/firm-partners/workspace/invoices/generate/numberReturns the number COUNT would assign to the next invoice, estimate, or credit memo.
/firm-partners/workspace/invoicesCreates an invoice, estimate, or credit memo (invoiceType: "memo").
/firm-partners/workspace/invoices/{uuid}Updates an invoice. Edits to non-draft invoices are field-specific and may be rejected.
/firm-partners/workspace/invoices/{uuid}/approveApproves a draft invoice or credit memo.
/firm-partners/workspace/invoices/{uuid}/sendEmails the invoice to the customer. Requires a non-draft invoice with a customer and products.
/firm-partners/workspace/invoices/{uuid}/public-linkReturns a shareable public link for the invoice, creating the public token if needed.
/firm-partners/workspace/invoices/{uuid}/audit-logReturns the audit history for an invoice, estimate, or credit memo.
/firm-partners/workspace/invoices/{uuid}/send-historyReturns email send history and public-view analytics for an invoice, estimate, or credit memo.
/firm-partners/workspace/invoices/{uuid}/attachmentsLists the files attached to an invoice, estimate or credit memo.
/firm-partners/workspace/invoices/{uuid}/attachmentsAttaches files to an invoice from public URLs or inline base64 content.
/firm-partners/workspace/invoices/{uuid}/attachments/uploadUploads one file attachment via multipart form data.
/firm-partners/workspace/invoices/{uuid}/attachments/{attachmentUuid}Changes the display title of one invoice attachment.
/firm-partners/workspace/invoices/{uuid}/attachments/{attachmentUuid}Removes one file from an invoice.
/firm-partners/workspace/invoices/{uuid}/attachments/{attachmentUuid}/contentReturns one invoice attachment's file, base64-encoded.
/firm-partners/workspace/invoices/{uuid}/apply-multiple-credit-to-invoiceApplies one or more credit memos to the target invoice.
/firm-partners/workspace/invoices/{uuid}/apply-credit-to-multiple-invoicesApplies a credit memo to one or more target invoices.
/firm-partners/workspace/invoices/{uuid}/remove-creditUnapplies a credit memo from an invoice.
/firm-partners/workspace/invoices/{uuid}/add-transactionsSettles whole transactions against an invoice, or records a refund paid out on a credit memo.
/firm-partners/workspace/invoices/{uuid}/remove-transactionUnassigns a payment transaction from an invoice.
/firm-partners/workspace/invoices/{uuid}Deletes an invoice, estimate, or credit memo.
