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

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