API Reference

Recurring Invoice Templates

Recurring invoice templates define a schedule that automatically generates invoices (or estimates) in a workspace. Each template stores the invoice payload, recurrence cadence, and next run date. Credit memos cannot be recurring.

Last updated 2026-11-18

Some fields work differently in US and NZ workspaces

Showing US sales tax and NZ GST rules.

Overview

The Recurring Invoice Templates API lets your integration list, create, update, pause, resume, and delete scheduled invoice templates. A template holds the same invoice-shaped fields as a one-off invoice — customer, line items, taxes, and totals — plus recurrence settings that control when new invoices are generated.

Templates are identified by a UUID returned as `id` in partner responses. Pause stops generation by clearing `nextInvoiceDate`; resume requires you to supply a new `nextInvoiceDate` in the request body. Credit memos (`invoiceType: "memo"`) are rejected on create — use the Invoices API for memos.

Key concepts

Identification

A template is referenced by its UUID, returned as `id`. Pass that value in the path for retrieve, update, pause, resume, and delete.

Create payload

POST uses the same UUID field rules as invoice create (`customerUuid`, product UUIDs on line items, `tagUuids`) plus a required `recurrencePattern`. Optional `inAdvanceCreationDays`, `recurrenceInterval`, `recurrenceEndDate`, and `emailCustomer` control scheduling.

Draft and pause

New templates default to draft (`isDraft: true`) and are paused until you resume them with a `nextInvoiceDate`. POST `/{uuid}/pause` sets `nextInvoiceDate` to null and stops generation without deleting the template.

Resume requires nextInvoiceDate

POST `/{uuid}/resume` must include `nextInvoiceDate` (ISO date) in the JSON body. The API returns 400 if it is missing.

Credit memos excluded

Setting `invoiceType` to `memo` on create returns 400. Credit memos are one-off documents created through POST /partners/invoices.

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.

The recurring invoice template object

Fields returned on a template. Recurrence-specific settings are nested under `createdInvoiceTemplate`; line items appear as `invoiceProducts`.

Attributes

iduuid

Template identifier (UUID). Use in path parameters.

invoiceTitlestring

Display title for generated invoices.

summarystring

Optional summary or memo line on generated invoices.

emailstring

Customer email used when emailing generated invoices.

currencystring

ISO 4217 currency code.

subtotalnumber

Subtotal before tax.

taxTotalnumber

Total tax amount.

totalnumber

Grand total including tax.

invoiceTypeenum

Document type generated from this template. Cannot be memo.

One of: invoice, estimate

customerobject

Embedded customer record with billing details.

invoiceProductsarray

Line items (products/services) on each generated invoice.

createdInvoiceTemplateobject

Recurrence schedule and generation settings.

recurrencePatternenum

Cadence unit. Aliases like biweekly and quarterly are normalized on save.

One of: daily, weekly, monthly, yearly

recurrenceIntervalinteger

Interval multiplier for the pattern (for example every 2 months when pattern is monthly and interval is 2).

occurrenceCountinteger

Total number of occurrences when limited; null for open-ended schedules.

remainingOccurrenceinteger

Occurrences left before the schedule ends.

recurrenceEndDatedate

Optional end date for the schedule (ISO).

nextInvoiceDatedate

Next invoice date (ISO). Null when the template is paused.

inAdvanceCreationDaysinteger

Days before each scheduled date that the invoice instance is created.

creationDatedate

Date the next invoice instance will be created (ISO).

emailCustomerboolean

When true, generated invoices are emailed to the customer automatically.

projectobject

Linked project, when set, or null.

attachmentsarray

Attachments copied to each generated invoice.

tagsarray

Tags applied to generated invoices.

createdAtdatetime

ISO 8601 creation timestamp.

updatedAtdatetime

ISO 8601 last update timestamp.

Example
{
  "id": "c4d5e6f7-a8b9-0123-cdef-456789012345",
  "invoiceTitle": "Monthly consulting retainer",
  "summary": "Recurring monthly invoice for Acme Corporation",
  "email": "contact@acme.com",
  "currency": "USD",
  "subtotal": 1000,
  "taxTotal": 85,
  "total": 1085,
  "invoiceType": "invoice",
  "customer": {
    "id": "dfa3219e-6af8-4c53-997a-037534f63a35",
    "customer": "Acme Corporation",
    "email": "contact@acme.com",
    "contactName": "John Doe"
  },
  "invoiceProducts": [
    {
      "id": "d5e6f7a8-b9c0-1234-defa-567890123456",
      "productServiceId": "aa11bb22-cc33-dd44-ee55-ff6677889900",
      "description": "Consulting services",
      "quantity": 10,
      "unitPrice": 100,
      "price": 100,
      "nonTaxable": false
    }
  ],
  "createdInvoiceTemplate": {
    "recurrencePattern": "monthly",
    "recurrenceInterval": 1,
    "occurrenceCount": null,
    "remainingOccurrence": null,
    "recurrenceEndDate": null,
    "nextInvoiceDate": "2026-04-01",
    "inAdvanceCreationDays": 0,
    "creationDate": "2026-04-01",
    "emailCustomer": true
  },
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-01-28T14:22:30.000Z"
}

List excludes draft templates by default

GET /partners/recurring-invoice-templates returns only non-draft templates (`isDraft: false`) unless you pass `isDraft=true` or `isDraft=all`. A template stays `isDraft: true` (and is skipped by the recurrence job) until its seed invoice is approved.

Search

The `search` query parameter matches invoice title, summary, email, customer name, and rounded total amounts.

Supported recurrence patterns

Accepted values include daily, weekly, biweekly, monthly, quarterly, and yearly. Unsupported patterns return 400 with a descriptive message.

Recent changes

2026-11-18

Incremental sync: updatedSince on every list endpoint, includeDeleted, and the deleted-records feed

Every Partner API list endpoint now takes updatedSince, so an integration can pull only what changed instead of re-reading whole lists. Pass an ISO 8601 date-time and the list returns the records created or changed at or after it, oldest change first, with nextUpdatedSince and hasMore beside the rows; pass nextUpdatedSince back as updatedSince to read the next page, and keep it for the next poll once hasMore is false. Paging by cursor means a record changed mid-walk can no longer move between pages and be skipped, so updatedSince cannot be combined with page above 1 or a sort. includeDeleted=true returns deleted records with isDeleted: true on vendors, customers, products, people, taxes, projects, project tasks, tasks, time entries, recurring invoice templates, the chart of accounts, transactions, invoices, and bills. The chart of accounts returns a flat list of changed accounts in this mode, each naming its parent in parentAccountUuid. Records removed outright — tags, tag groups, journal entry lines, expense receipts, customer contacts, addresses and notes, budgets, and any other hard delete — are listed by the new GET /partners/deleted-records, which keeps 90 days. updatedFrom and updatedTo stay on transactions, invoices, and bills, now read as UTC when they carry no offset. The new Keeping in Sync guide (/guides/keeping-in-sync) puts the pieces together into a 15-minute poll with a sync-now button. The MCP catalog adds COUNT_list_deleted_records, and every list tool takes updatedSince (and includeDeleted where it applies) under query.

2026-11-18

Line taxes on invoices and bills, split by US and NZ

Documented the line tax fields the reference was missing and how each behaves in US and NZ workspaces. Bill lines take one tax code in `lineItems[].taxUuid` (NZ: the GST code; US: ignored, bills carry no tax), and bill responses show it as `appliedTax`. Invoice, credit memo and recurring template lines take tax code UUIDs in `taxes`, the document takes `productsPriceType` (`tax-exclusive` or `tax-inclusive`), and `nonTaxable` and `customerExemptionOverridden` now say what they do in each country: in the US a Non-Taxable line keeps its code, in NZ it is cleared. The Taxes page lists the five NZ GST codes, where each reports on the GST return (Zero Rated in boxes 5 and 6, No GST nowhere), and which accounts each fits. Customer `taxExcluded` is a tax exemption, not tax-exclusive pricing, and customer and account `taxes` take tax UUIDs. A US / NZ switch in the header, and on every page with country-specific rules, shows one country's notes at a time; links can open in either view with `?region=us` or `?region=nz`.

2026-11-18Breaking

Every attachment in COUNT through the API and MCP

Attachments can now be listed, added, read back and removed through the Partner API on bills, invoices, recurring invoice templates, transaction receipts, manual journal entries, tasks, expense receipts, Documents and reconciliation bank statements. Each record type gains an `attachments` (or `receipts` / `bank-statement`) route that takes JSON entries, either `{ url }` (COUNT downloads and keeps its own copy) or `{ fileName, contentBase64, contentType? }`, plus an `/upload` route for multipart files. Files are capped per route (5 MB for invoices, templates, transaction receipts and Documents, 10 MB for expense receipts, 20 MB for bills, journal entries and tasks, 25 MB for bank statements), at most 10 per request, virus-scanned, and saved together or not at all. A new `/content` route on each returns one file base64-encoded (up to 10 MB), and GET /partners/documents/{uuid}/download-links returns signed view and download links. Breaking: `documentUrl`, `receiptUrl`, `pdfUrl` and `bankStatementUrl` in responses are now short-lived signed links, and `null` when COUNT cannot prove the file is the workspace's. POST /partners/invoices/{uuid}/attachments now stores a copy of each file and answers 201 with `data.attachments` instead of 200 with `data.invoice`. Invoice upload responses no longer include internal ids (`invoiceId`, `defaultInvoiceAttachmentId`, `recurringInvoiceTemplateId`, `uploadedBy`). Bill create and update accept inline content in `attachments`, and an empty list adds nothing. Attachment adds and content reads are limited to 40 a minute per client and workspace. The MCP catalog adds 35 tools, including a Documents category, and content tools deliver the file as an embedded resource rather than as text.

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

Endpoints

GET
List recurring invoice templates/partners/recurring-invoice-templates

Returns a paginated list of recurring invoice templates in the workspace.

POST
Create a recurring invoice template/partners/recurring-invoice-templates

Creates a draft invoice plus a recurring template with the supplied schedule.

GET
Get a recurring invoice template/partners/recurring-invoice-templates/{uuid}

Retrieves a single recurring invoice template by its UUID.

PATCH
Update a recurring invoice template/partners/recurring-invoice-templates/{uuid}

Updates an existing recurring invoice template. Only sent fields are changed.

DELETE
Delete a recurring invoice template/partners/recurring-invoice-templates/{uuid}

Removes a recurring invoice template and stops future generation.

POST
Pause a recurring invoice template/partners/recurring-invoice-templates/{uuid}/pause

Pauses generation by clearing nextInvoiceDate.

POST
Resume a recurring invoice template/partners/recurring-invoice-templates/{uuid}/resume

Resumes generation by setting nextInvoiceDate.

GET
List template attachments/partners/recurring-invoice-templates/{uuid}/attachments

Lists the files attached to a recurring invoice template.

POST
Add template attachments/partners/recurring-invoice-templates/{uuid}/attachments

Adds files to a recurring invoice template from public URLs or inline base64 content.

POST
Upload template attachment/partners/recurring-invoice-templates/{uuid}/attachments/upload

Uploads one file to a recurring invoice template via multipart form data.

PATCH
Rename template attachment/partners/recurring-invoice-templates/{uuid}/attachments/{attachmentUuid}

Changes the display title of one template attachment.

DELETE
Delete template attachment/partners/recurring-invoice-templates/{uuid}/attachments/{attachmentUuid}

Removes one file from a recurring invoice template.

GET
Get template attachment content/partners/recurring-invoice-templates/{uuid}/attachments/{attachmentUuid}/content

Returns one template attachment's file, base64-encoded.