API Reference

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-10-03

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 `/partners/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. Taxes are backfilled from the product when the line is taxable. Set `nonTaxable: true` to clear taxes on a line.

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

iduuid

Document identifier (UUID). Use in path parameters.

invoiceNumberstring

Human-readable document number.

invoiceTypeenum

Document type.

One of: invoice, estimate, memo

customerUuiduuid

UUID of the customer this document belongs to.

datedate

Document date (ISO).

dueDatedate

Due date (ISO), when applicable.

currencystring

ISO 4217 currency code.

statusstring

Derived lifecycle status (draft, approved, sent, unpaid, partial, paid, overdue, void, etc.).

isDraftboolean

Whether the document is still a draft.

approvedboolean

Whether the document has been approved.

isSentboolean

Whether the document has been emailed to the customer.

paymentStatusstring

Raw payment status (unpaid, partial, paid, etc.).

subtotalnumber

Subtotal before tax.

taxTotalnumber

Total tax amount.

totalnumber

Grand total including tax.

amountDuenumber

Outstanding balance.

productsarray

Products or services billed on this document.

createdAtdatetime

ISO 8601 creation timestamp.

updatedAtdatetime

ISO 8601 last update timestamp.

Example

{
  "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.

Recent changes

2026-10-03

Bill submit and refunds, reconciliation drafts, report filters, 30 MCP tools, and the Claude plugin

Documented the five partner routes the reference was missing: POST /partners/bills/{uuid}/submit, POST /partners/bills/{uuid}/assign-transaction (pay a bill, or refund a vendor memo with an income transaction), PATCH /partners/invoices/{uuid}/add-transactions (including credit memo refunds), and PATCH and DELETE /partners/reconciliations/{uuid} for correcting or discarding a draft. The account transactions report gains a reference-number range (checkNumberFrom/checkNumberTo) and the unknown-counterparty drill-down (unknownCustomerAr/unknownVendorAp), both accrual-only. Invoice and credit memo lines accept free-text Custom lines with categoryAccountUuid and name. Corrected the reference where it disagreed with the backend: dueDate is required on invoices and estimates, bills move through submitted and rejected as well as draft and approved, and a bill does have its own assign-transaction route. npm run check:parity now reports 178 documented routes against 178 backend routes. The MCP catalog adds 30 tools — customer contacts, addresses, notes, merge and revenue overview, GST settings, bill submit and memo refunds, reconciliation draft update/delete, COUNT_find_tool, COUNT_report_problem, and saved AI skills — moving the advertised count from 180 to 210. New pages cover the COUNT Claude plugin (/tools/claude-plugin) and the MCP brain, workspace memory and problem reports (/guides/mcp-brain-and-memory), and the FAQ gains the connector and API topics COUNT_knowledge serves to agents.

2026-09-22

Customer sub-resources, merge, GST settings, and the last bulk routes

Closed every remaining gap between the reference and the backend partner routes — 20 endpoints that existed in count-dev but had no documentation. Customers gained its sub-resources: contacts, addresses, and notes each get full list/create/update/delete coverage, plus GET /partners/customers/{uuid}/revenue-overview and the two-step merge flow (POST /partners/customers/merge/preview, then POST /partners/customers/merge), which repoints every record onto a target customer and cannot be undone through the API. Workspace gained GET and PATCH /partners/workspace/gst-settings, including the manage_settings permission the PATCH requires and the 409 that locks the accounting basis after a return is filed. Also documented GET /partners/invoices/generate/number, POST /partners/projects/bulk, and POST /partners/transactions/review-bulk. npm run check:parity now reports 173 documented routes against 173 backend routes.

2026-09-07

Accounting Playbooks and Ledger Semantics published as documentation

The workflows and behaviour rules the MCP server serves to agents through COUNT_playbooks and COUNT_knowledge are now readable documentation. Accounting Playbooks (/guides/playbooks) covers nine ordered workflows across 54 steps — invoicing, credit memos, recurring templates, vendor bill payment, chart-of-accounts setup, migration imports, budget planning and round-trip, and month-end review — each naming the exact tool per step. Ledger Semantics & Lifecycles (/guides/ledger-semantics) documents 33 confirmed behaviours across twelve resources: the state each operation is valid in, the fields accepted and then ignored, and the calls that cannot be undone, with every irreversible behaviour collected in one table at the top of the page. Both pages carry the COUNT_playbooks and COUNT_knowledge ids they were ported from so the agent-facing and human-facing copies stay in step. Playbooks, lifecycle sections, and individual behaviour rules are indexed into site search.

2026-07-28

Connections, reconciliations, opening balance, workspace cutover, and transaction bulk ops

Documented Partner API groups for bank Connections (including Plaid Hosted Link connect/complete/reconnect), Reconciliations (create draft + complete), Opening Balance (get/set conversion balance), and Workspace (PATCH cutoverDate). Added PATCH /partners/transactions/change-category-bulk and exclude-bulk. Removed non-existent POST /partners/bills/bulk and /partners/invoices/bulk from the reference. Extended the MCP tool catalog with the matching COUNT_* tools plus remote-only COUNT_get_bulk_task_status and COUNT_remember/recall/forget.

2026-06-29

Budgets API and documentation parity

Added the Budgets API reference (14 endpoints), invoice send-history, and account sub-types list. Introduced an automated parity check (`npm run check:parity`) that compares documented routes against count-dev. Normalized customer path parameters to `{uuid}` and fixed the documents chunk-upload progress path.

2026-06-21

Complete Partner API reference

Documented all remaining API reference groups: Chart of Accounts, Vendors, Products & Services, Recurring Invoice Templates, Credit Memos, Bills, Journal Entries, Tags, People, Projects, Tasks, Time Entries, Expense Receipts, Reports, and Workspace Stats. Added missing invoice endpoints (audit log, attachments, credit application, remove transaction) and group overviews for Invoices and Transactions.