API Reference

Products & Services

Products and services are the catalog items you sell on invoices and estimates. Each record carries pricing, optional inventory tracking, income and purchase category accounts, and tax configuration.

Last updated 2026-11-18

Some fields work differently in US and NZ workspaces

Showing US sales tax and NZ GST rules.

Overview

The Products & Services API lets your integration list, retrieve, create, update, and delete catalog items in a workspace. These records appear as line items on invoices, estimates, and credit memos.

Partner responses expose each product UUID as `id`. When creating or updating, pass account and tax references as UUIDs (`categoryAccountUuid`, `purchaseCategoryAccountUuid`, `taxUuids`) — not numeric internal ids.

Key concepts

Identification

Products are referenced by UUID returned as `id`. Pass that value in invoice `products[]` line items as `productUuid` (or the `uuid` alias).

Category accounts

Link income and purchase posting accounts with `categoryAccountUuid` and `purchaseCategoryAccountUuid` from the chart of accounts list. Do not pass UUID-shaped values in numeric `categoryAccountId` fields.

Taxes

Pass `taxUuids` (from the taxes list) on create and update. The server resolves UUIDs to internal tax ids automatically.

Pricing method

`pricingMethod` is `hour` for time-based services and `item` for fixed-quantity products. Defaults to `item`.

The product object

Fields returned on a product or service. Category accounts and taxes are embedded on partner list and get responses.

Attributes

iduuid

Product identifier (UUID). Use in path parameters.

namestring

Product or service name. Required on create.

codestring

Optional SKU or item code.

descriptionstring

Longer description shown on invoice lines.

unitPricenumber

Default sell price per unit or hour.

purchasePricenumber

Default purchase/cost price, when tracked.

totalnumber

Unit price plus embedded tax percentage.

taxnumber

Aggregate tax percentage applied to the product.

currencystring

ISO 4217 currency code.

statusenum

Product status.

One of: active, inactive

pricingMethodenum

Whether the item is priced per hour or per item.

One of: hour, item

hiddenboolean

When true, hidden from default product pickers.

stockQuantityinteger

On-hand quantity when inventory tracking is enabled, otherwise null.

timeEntryTaskboolean

Whether this item is available as a time-entry task.

categoryAccountobject

Income category account (chart of accounts), or null.

purchaseCategoryAccountobject

Expense/purchase category account, or null.

taxesarray

Tax rates linked to the product.

iduuid

Tax identifier (UUID on partner responses).

namestring

Tax name.

percentagenumber

Tax rate percentage.

createdAtdatetime

ISO 8601 creation timestamp.

updatedAtdatetime

ISO 8601 last update timestamp.

Example
{
  "id": "aa11bb22-cc33-dd44-ee55-ff6677889900",
  "name": "Consulting — hourly",
  "code": "SVC-001",
  "description": "Consulting services",
  "unitPrice": 150,
  "purchasePrice": null,
  "total": 150,
  "tax": 0,
  "currency": "USD",
  "status": "active",
  "pricingMethod": "hour",
  "hidden": false,
  "stockQuantity": null,
  "timeEntryTask": false,
  "categoryAccount": {
    "id": "c8d9e0f1-a2b3-4567-cdef-789012345678",
    "name": "Professional Services Income",
    "type": "Income"
  },
  "purchaseCategoryAccount": null,
  "taxes": [],
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-01-28T14:22:30.000Z"
}

Hidden products

By default, list excludes hidden products. Pass `includeHidden=true` to include them, or `hidden=true` / `hidden=false` to filter explicitly.

Invoice line references

When creating invoices, reference products by UUID in each line (`productUuid` or `uuid` depending on the invoice payload shape).

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