API Reference

Projects

Projects group work for a customer with a status, schedule, and associated tasks. Partner responses use UUIDs; numeric `customerId` and `statusId` fields are stripped.

Last updated 2026-11-18

Overview

The Projects API lets your integration list project statuses, create and manage projects, and list the tasks attached to a project. Projects optionally link to a customer and always carry a workspace-defined status.

Use `GET /partners/projects/statuses` to discover status UUIDs before creating or filtering projects. Soft-deleted projects return 404 and are excluded from list results. Updates use PATCH (not PUT).

Key concepts

Status discovery

Call List project statuses first. Pass the returned UUID as `statusUuid` on create/update, or filter list with `statusUuids` (comma-separated).

Customer linking

Pass `customerUuid` from the Customers API on create. On update, pass a UUID to set the customer, `null` or empty string to clear, or omit to leave unchanged.

Archiving

DELETE archives the project. Archived projects are excluded from list and return 404 on retrieve.

Project tasks

Tasks linked to a project are listed via `GET /partners/projects/{uuid}/tasks` with the same sanitized task shape as the Tasks API.

The project object

Fields returned on a project. Customer and projectStatus associations expose UUIDs.

Attributes

iduuid

Project identifier (UUID).

namestring

Project name. Required on create.

descriptionstring

Free-text description.

customIdstring

Optional external reference id.

startDatedate

Project start date (ISO).

endDatedate

Project end date (ISO).

customerobject

Linked customer, or null when the project is not customer-specific.

uuiduuid

Customer UUID.

customerstring

Customer display name.

projectStatusobject

Current project status.

uuiduuid

Status UUID.

namestring

Status label.

colorstring

Display color.

createdAtdatetime

ISO 8601 creation timestamp.

updatedAtdatetime

ISO 8601 last update timestamp.

Example
{
  "id": "11223344-5566-7788-99aa-bbccddeeff00",
  "name": "Website Redesign",
  "description": "Redesign the marketing website for Acme Corporation.",
  "customId": "PRJ-2026-001",
  "startDate": "2026-02-01",
  "endDate": "2026-06-30",
  "customer": {
    "uuid": "dfa3219e-6af8-4c53-997a-037534f63a35",
    "customer": "Acme Corporation"
  },
  "projectStatus": {
    "uuid": "aabbccdd-eeff-4012-8000-001122334455",
    "name": "In Progress",
    "color": "#E48642"
  },
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-01-28T14:22:30.000Z"
}

Use UUID filter params

List filters accept `customerUuids` and `statusUuids` (comma-separated). Legacy numeric `customers` and `statusIds` query params are stripped server-side.

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

Cash flow forecast, GST return and audit report, tax codes, workspace events, and 17 MCP tools

Documented the six partner routes the reference was missing. POST /partners/reports/cash-flow-forecast forecasts cash for the next 13 weeks, with an optional what-if scenario (customer payment delays, bill payment dates and one-off or repeating adjustments) returned as scenarioForecast. GET /partners/reports/gst-return calculates an NZ GST return without filing it, including the reconciliation that decides whether COUNT would let it file, and GET /partners/reports/gst-audit-report lists the transactions behind it, flags the ones with a GST issue, and pages 200 rows at a time. GET /partners/taxes lists the workspace tax codes and their UUIDs. GET /partners/workspace-events returns what changed since the user last checked: invoices paid, failed invoice payments, new bills and bank feed syncs. GET /partners/journal-entries/{uuid} returns one posting with every line. Taxes and workspace events are also reachable through the Practice Manager client-workspace routes. npm run check:parity now reports 186 documented routes against 186 backend routes. The MCP catalog adds COUNT_list_taxes, COUNT_list_workspace_events, COUNT_get_journal_entry, COUNT_generate_cash_flow_forecast, COUNT_get_gst_return, COUNT_get_gst_audit_report, COUNT_propose_transaction_categories, four position tools (COUNT_get_all_positions, COUNT_create_position, COUNT_update_position, COUNT_delete_position), and five firm tools for client status and client questionnaires. COUNT_delete_project is now COUNT_archive_project, and DELETE /partners/projects/{uuid} is documented as the archive it is, with its real response (result.success). Also, COUNT_get_bulk_task_status, which the server no longer registers, is removed.

2026-10-23

Response examples checked against the live API

Every Practice Manager route was called with a firm API key and the reference corrected where it disagreed. Tasks: the due date field is deadlineDate on create and update (deadline is ignored), firm-only tasks are never returned whatever visibility you pass, and creating a task with type INTERNAL_TASK leaves it unreachable through the API, so the examples now use type custom; the task object lists the fields the API returns. Response examples now match the API for the documents list (documents and pagination) and get (data.document), the projects, tasks, time entries and customers lists, and the trial balance, profit and loss, balance sheet and aged receivables and payables reports. Documents no longer list folderPath, mimeType or fileSize, which were never returned. Firm tasks: a malformed clientWorkspaceUuids filter returns 404, and customId is numbered per client workspace. The Idempotency-Key error applies to writes only.

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