Create a recurring invoice template
/firm-partners/workspace/recurring-invoice-templatesCreates a draft invoice plus a recurring template with the supplied schedule.
Same UUID payload rules as invoice create, plus required `recurrencePattern`. `invoiceType` defaults to invoice; memo is rejected, which also makes `dueDate` effectively required. `isDraft` defaults to true, so `customerUuid` is not required unless `isDraft` is set to false — resume the template to start generation.
Some fields work differently in US and NZ workspaces
Showing US sales tax and NZ GST rules.
Headers
count-workspace-iduuidrequiredUUID of the client workspace to act on. It must be one of your firm's client workspaces (or the firm's own workspace) and within the API key's client workspaces.
Request body
customerUuiduuidUUID of the customer billed on each generated invoice. Required only when isDraft is false.
recurrencePatternstringrequiredSchedule cadence: daily, weekly, biweekly, monthly, quarterly, or yearly.
invoiceTypeenumDocument type. Defaults to invoice. Must not be memo.
One of: invoice, estimate
invoiceNumberstringrequiredInvoice number shown on the generated invoice.
datedaterequiredInitial invoice date (ISO).
dueDatedaterequiredDue date on generated invoices (ISO). Effectively required because memo invoiceType is rejected on this endpoint.
currencystringISO 4217 currency code. Defaults to workspace currency.
recurrenceIntervalintegerInterval multiplier for the pattern. Defaults to 1.
recurrenceEndDatedateOptional end date for the schedule (ISO).
occurrenceCountintegerLimit total occurrences when set.
inAdvanceCreationDaysintegerDays before each scheduled date to create the invoice instance.
emailCustomerbooleanEmail the customer when each invoice is generated.
isDraftbooleanWhen true (default), the template is paused until resumed.
productsarrayrequiredProducts or services on each generated invoice.
productUuiduuidProduct UUID from list_products. `uuid` is accepted as an alias.
descriptionstringLine description.
quantitynumberrequiredQuantity billed.
unitPricenumberrequiredPrice per unit.
taxesarrayTax code UUIDs from List tax codes. Omit it and the line takes the product's tax codes; send `[]` for a line with no tax. A free-text line takes only the codes it names.
- US· Sales taxThe sales tax codes to charge on the line.
- NZ· GSTThe line's GST code: `15% GST on Income` for a standard-rated sale, `Zero Rated` for a zero-rated supply, or `No GST` for a sale outside GST. An Income account takes `15% GST on Income` or `Zero Rated`, never `15% GST on Expenses`.
nonTaxablebooleanRaise the line without charging tax.
- US· Sales taxThe line keeps its tax code, charges no tax, and reports as a Non-Taxable sale under that code.
- NZ· GSTClears the line's tax codes, the same as `taxes: []`. It does not zero-rate the line; send the `Zero Rated` code in `taxes` for that.
customerExemptionOverriddenbooleanCharge tax on this line even though the customer is tax-exempt (`taxExcluded`).
- US· Sales taxWithout it, a tax-exempt customer's taxed lines are raised Non-Taxable.
- NZ· GSTIgnored. Every line for a tax-exempt customer is raised with no tax.
productsPriceTypeenumHow every line's `unitPrice` is read against its tax codes. `tax-exclusive` (the workspace default when omitted) adds the tax on top of `unitPrice`; `tax-inclusive` treats `unitPrice` as already containing it. A credit memo must repeat the original invoice's setting or it credits a different net amount. For a document with no tax, send `taxes: []` on each line.
One of: tax-exclusive, tax-inclusive
tagUuidsarrayTag UUIDs to attach to generated invoices.
projectUuiduuidOptional project UUID.
Responses
201Template and draft invoice created.400Validation failed — missing recurrencePattern, invoiceNumber, date, or dueDate; memo invoiceType; or invalid UUID references.401Missing signing headers, an invalid HMAC signature, or a timestamp more than 5 minutes off. Troubleshoot403The key is inactive or its scope does not allow this request, the workspace is not managed by your firm or is outside the key's client workspaces, the workspace has no active subscription, or it is portal-only and the route needs bookkeeping. Troubleshoot404No workspace exists with the `count-workspace-id` UUID.429Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). Troubleshoothttps://api.getcount.com/firm-partners/workspace/recurring-invoice-templatesimport crypto from 'node:crypto';
const BASE_URL = 'https://api.getcount.com';
const CLIENT_ID = process.env.COUNT_CLIENT_ID;
const CLIENT_SECRET = process.env.COUNT_CLIENT_SECRET;
const method = 'POST';
const signingPath = '/workspace/recurring-invoice-templates';
const timestamp = Math.floor(Date.now() / 1000).toString();
const body = {
"customerUuid": "dfa3219e-6af8-4c53-997a-037534f63a35",
"invoiceType": "invoice",
"invoiceNumber": "INV-1042",
"date": "2026-03-01",
"dueDate": "2026-03-31",
"currency": "USD",
"recurrencePattern": "monthly",
"recurrenceInterval": 1,
"inAdvanceCreationDays": 0,
"emailCustomer": true,
"isDraft": true,
"products": [
{
"productUuid": "aa11bb22-cc33-dd44-ee55-ff6677889900",
"description": "Consulting services",
"quantity": 10,
"unitPrice": 100,
"nonTaxable": false
}
]
};
const bodyString = JSON.stringify(body);
const bodyHash = crypto.createHash('sha256').update(bodyString).digest('hex');
const baseString = `${method}:${signingPath}:${timestamp}:${bodyHash}`;
const signature = crypto.createHmac('sha256', CLIENT_SECRET).update(baseString).digest('hex');
const response = await fetch(`${BASE_URL}/firm-partners/workspace/recurring-invoice-templates`, {
method,
headers: {
'x-client-id': CLIENT_ID,
'x-timestamp': timestamp,
'x-signature': signature,
'Content-Type': 'application/json',
'count-workspace-id': '5e4d3c2b-1a09-4f8e-8d7c-6b5a49382716',
},
body: bodyString,
});
console.log(await response.json());{
"status": "success",
"message": "Invoice and recurring template created",
"data": {
"invoice": {
"id": "f6a7b8c9-d0e1-2345-fabc-456789012345",
"invoiceNumber": "INV-1042"
},
"recurringTemplate": {
"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"
}
}
}