Practice Manager API

Credit Memos

Credit memos reduce what a customer owes. They are invoice records with invoiceType memo and use the same /firm-partners/workspace/invoices routes as invoices and estimates. Apply approved memos to open invoices with the credit-application endpoints.

Last updated 2026-11-18

Some fields work differently in US and NZ workspaces

Showing US sales tax and NZ GST rules.

Overview

Credit memos are customer credits issued against prior billing. In COUNT they are stored as invoice-shaped records with `invoiceType: "memo"`. There is no separate `/partners/credit-memos` base path — every memo operation uses the Invoices API routes documented here with memo-specific examples.

Partner responses expose each memo UUID as `id`. Create memos with `invoiceType: "memo"` and optionally link them to an open invoice at create time via `appliedToInvoiceUuid`. Credit memos cannot be recurring; use Recurring Invoice Templates for scheduled invoices only.

Key concepts

Shared routes with invoices

List, retrieve, create, update, approve, delete, and apply credit using `/firm-partners/workspace/invoices` paths. Filter lists with `invoiceType=memo`.

Create with appliedToInvoiceUuid

POST /firm-partners/workspace/invoices with `invoiceType: "memo"` and optional `appliedToInvoiceUuid` links the memo to an open invoice when created.

Approve before applying

A memo must be approved before its balance can be applied to invoices. PATCH /{uuid}/approve takes no request body, the same as invoice approve.

Applying credit

Apply one memo to many invoices with apply-credit-to-multiple-invoices (path is the memo UUID). Apply many memos to one invoice with apply-multiple-credit-to-invoice (path is the target invoice UUID).

Refunding a memo

Record a refund paid out to the customer with PATCH /firm-partners/workspace/invoices/{memoUuid}/add-transactions and Expense transactions. It is the only refund route: assign-to-bills-invoices rejects credit memos. MCP equivalent: COUNT_record_credit_memo_refund.

Cannot recur

Credit memos cannot be recurring templates. Attempting invoiceType memo on recurring template create returns 400.

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 credit memo object

Same core shape as an invoice object, with invoiceType memo and optional appliedToInvoiceUuid linking to the credited invoice.

Attributes

iduuid

Credit memo identifier (UUID). Use in path parameters.

invoiceNumberstring

Human-readable memo number (for example CM-0042).

invoiceTypeenum

Always memo for credit memos.

One of: memo

customerUuiduuid

UUID of the customer receiving the credit.

appliedToInvoiceUuiduuid

Optional UUID of the invoice this memo credits at create time.

datedate

Memo date (ISO).

currencystring

ISO 4217 currency code.

statusstring

Derived lifecycle status (draft, approved, sent, unpaid, partial, paid, void, etc.).

isDraftboolean

Whether the memo is still a draft.

approvedboolean

Whether the memo has been approved.

paymentStatusstring

Raw payment/application status.

subtotalnumber

Subtotal before tax.

taxTotalnumber

Total tax amount.

totalnumber

Total credit amount.

amountDuenumber

Remaining credit balance available to apply.

productsarray

Products or services on the memo.

createdAtdatetime

ISO 8601 creation timestamp.

updatedAtdatetime

ISO 8601 last update timestamp.

Example
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "invoiceNumber": "CM-0042",
  "invoiceType": "memo",
  "customerUuid": "dfa3219e-6af8-4c53-997a-037534f63a35",
  "appliedToInvoiceUuid": "f6a7b8c9-d0e1-2345-fabc-456789012345",
  "date": "2026-03-01",
  "dueDate": null,
  "currency": "USD",
  "status": "approved",
  "isDraft": false,
  "approved": true,
  "isSent": false,
  "paymentStatus": "unpaid",
  "subtotal": 500,
  "taxTotal": 0,
  "total": 500,
  "amountDue": 500,
  "products": [
    {
      "productUuid": "aa11bb22-cc33-dd44-ee55-ff6677889900",
      "description": "Credit for overbilling on prior invoice",
      "quantity": 1,
      "unitPrice": 500,
      "nonTaxable": true
    }
  ],
  "createdAt": "2026-03-01T09:00:00.000Z",
  "updatedAt": "2026-03-02T11:15:00.000Z"
}

Same handlers as invoices

Memo retrieve, update, approve, and delete use the same backend handlers as invoices. Response envelopes and derived status rules match the Invoices API.

All IDs in apply bodies are UUIDs

In credit-application requests, every id and memoId is the partner UUID from the id field on invoice or memo objects — not internal numeric ids.

Endpoints