API Reference
Supplier Bank Accounts
The bank accounts COUNT pays suppliers into by batch payment, their change history, and requests to change them. New Zealand workspaces only.
Last updated 2026-11-18
Some fields work differently in US and NZ workspaces
Showing US sales tax and NZ GST rules.
Overview
Each supplier has at most one active New Zealand bank account. A supplier without one cannot have its bills put in a payment batch.
COUNT calls them suppliers; the API keeps the name vendor in its paths and fields (`/partners/vendors`, `vendorUuid`, `vendor`).
Reads return the full account number. Changes made through the API are requests: they wait for a person to approve them in COUNT, so payment details are never changed by an API call alone.
Key concepts
NZ· GSTNew Zealand only
COUNT pays suppliers by New Zealand batch payment, so these routes work in NZ workspaces only. Any other workspace gets 400.
Changes wait for approval
POST /{uuid}/changes creates a `pending` change, even in a workspace that applies its own changes at once. Someone other than the requester approves or rejects it in COUNT; there is no approve route. Only one change can wait per vendor: another request returns 409 until it is decided. In a workspace with a single person who manages vendors, add the account in COUNT instead.
The change object
Each change has an `id`, `changeType` (`create`, `update` or `deactivate`), `status` (`pending`, `approved`, `rejected` or `cancelled`), `fromBankAccount` and `toBankAccount` (the bank account fields before and after; null when adding or removing), `reason`, `requestedBy` and `approver` (`firstName`, `lastName`, `email`; the approver is the suggested reviewer while pending and who decided afterwards), `decidedAt`, `rejectionReason` and `createdAt`.
Keeping in sync
List with `updatedSince` returns the accounts created or changed since then, oldest first, including accounts replaced or removed since (`status: "inactive"`). Accounts of deleted vendors are left out; the vendor's deletion shows on List vendors with `includeDeleted=true`. Store `nextUpdatedSince` for the next poll.
The supplier bank account object
Attributes
iduuidBank account UUID.
vendorobjectThe supplier paid into this account.
iduuidSupplier UUID.
namestringSupplier name.
bankCountrystringAlways `NZ`.
railTypestringAlways `nz_direct_credit`.
nzBankAccountstringThe whole account number, `BB-bbbb-AAAAAAA-SSS`.
nzBankNumberstringBank (2 digits).
nzBranchNumberstringBranch (4 digits).
nzAccountNumberstringAccount (7 digits).
nzAccountSuffixstringSuffix (2 or 3 digits).
accountNamestringAccount holder name as registered at the bank.
defaultParticularsstringParticulars pre-filled on every batch payment line for this supplier (up to 12 characters).
defaultCodestringCode pre-filled on every batch payment line (up to 12 characters).
defaultReferencestringReference pre-filled on every batch payment line (up to 12 characters).
statusenum`inactive` once the account was replaced or removed.
One of: active, inactive
createdAtdatetimeISO 8601 creation timestamp.
updatedAtdatetimeISO 8601 last update timestamp.
{
"id": "0193a1c2-7b4d-7e10-9a2f-5c6d7e8f9a01",
"vendor": {
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"name": "Harbourside Office Supplies Ltd"
},
"bankCountry": "NZ",
"railType": "nz_direct_credit",
"nzBankAccount": "12-3456-7890123-001",
"nzBankNumber": "12",
"nzBranchNumber": "3456",
"nzAccountNumber": "7890123",
"nzAccountSuffix": "001",
"accountName": "Harbourside Office Supplies",
"defaultParticulars": "Acme Ltd",
"defaultCode": "INV",
"defaultReference": "ACME-001",
"status": "active",
"createdAt": "2026-01-15T10:30:00.000Z",
"updatedAt": "2026-01-28T14:22:30.000Z"
}Scope and permissions
Needs the `vendor-bank-accounts` scope: `vendor-bank-accounts:read` to read, `vendor-bank-accounts:write` to request a change. Neither `vendors:*` nor a bare `read` / `write` grant includes it, for apps and firm keys alike; only COUNT's own MCP connector has it with full access. The connecting user needs View Vendor Bank Details to read and Manage Vendors to request a change.MCP equivalent
COUNT_list_vendor_bank_accounts, COUNT_get_vendor_bank_account, COUNT_list_vendor_bank_account_changes and COUNT_request_vendor_bank_account_change. They are not offered inside COUNT AI chat.Related
Recent changes
Supplier bank accounts
In New Zealand workspaces, GET /partners/vendor-bank-accounts lists the bank accounts suppliers are paid into by batch payment (optionally one supplier, or those changed since `updatedSince`), GET /partners/vendor-bank-accounts/{vendorUuid} returns one supplier's account, and GET /partners/vendor-bank-accounts/{vendorUuid}/changes its change history. POST /partners/vendor-bank-accounts/{vendorUuid}/changes asks to add, replace or remove the account: the change waits for someone other than the requester to approve it in COUNT, and only one can wait per supplier (409). Reads return the full account number. These routes need the new `vendor-bank-accounts` scope, which neither `vendors` nor a bare `read` / `write` grant includes (COUNT's own MCP connector excepted), plus View Vendor Bank Details to read and Manage Vendors to request. The same routes work on client workspaces under /firm-partners/workspace. The MCP catalog adds COUNT_list_vendor_bank_accounts, COUNT_get_vendor_bank_account, COUNT_list_vendor_bank_account_changes and COUNT_request_vendor_bank_account_change, which are not offered inside COUNT AI chat.
Endpoints
/partners/vendor-bank-accountsLists the active supplier bank accounts, or those changed since a point in time.
/partners/vendor-bank-accounts/{uuid}Returns the supplier's active bank account, or null when it has none.
/partners/vendor-bank-accounts/{uuid}/changesLists every change requested to the supplier's bank account, newest first.
/partners/vendor-bank-accounts/{uuid}/changesAsks to add, replace or remove the supplier's bank account. The change waits for approval in COUNT.
