Request a supplier bank account change
/firm-partners/workspace/vendor-bank-accounts/{uuid}/changesAsks to add, replace or remove the supplier's bank account. The change waits for approval in COUNT.
To add or replace, send `bankAccount`. To remove, send `changeType: "deactivate"` and no `bankAccount`. The response leaves out `fromBankAccount`, the account being replaced, since reading it needs View Vendor Bank Details; List a vendor's bank account changes has it.
Headers
count-workspace-iduuidrequiredUUID of the client workspace to act on. It must be one of your firm's client workspaces (or the firm's own workspace) and within the API key's client workspaces.
Path parameters
uuiduuidrequiredThe supplier's UUID: its `id` from List vendors. A supplier has at most one active bank account.
Request body
changeTypeenumSend `deactivate` to remove the active account. Omit it to add or replace one.
One of: deactivate
reasonstringWhy the change is needed, shown to the approver.
bankAccountobjectThe new account. Required unless `changeType` is `deactivate`, and refused with it.
nzBankAccountstringrequiredThe account number, `BB-bbbb-AAAAAAA-SSS` (e.g. 12-3456-7890123-00).
accountNamestringAccount holder name.
defaultParticularsstringUp to 12 characters.
defaultCodestringUp to 12 characters.
defaultReferencestringUp to 12 characters.
Responses
201The pending change.400Not a New Zealand workspace, an invalid account number, a field other than those listed, or `bankAccount` missing (or sent with `deactivate`).401Missing signing headers, an invalid HMAC signature, or a timestamp more than 5 minutes off. Troubleshoot403The key is inactive or its scope does not allow this request, the workspace is not managed by your firm or is outside the key's client workspaces, the workspace has no active subscription, or it is portal-only and the route needs bookkeeping. Troubleshoot404Supplier not found, or a removal for a supplier with no active account.409Another change for this supplier is still waiting for approval.429Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). Troubleshoothttps://api.getcount.com/firm-partners/workspace/vendor-bank-accounts/{uuid}/changesimport crypto from 'node:crypto';
const BASE_URL = 'https://api.getcount.com';
const CLIENT_ID = process.env.COUNT_CLIENT_ID;
const CLIENT_SECRET = process.env.COUNT_CLIENT_SECRET;
const method = 'POST';
const signingPath = '/workspace/vendor-bank-accounts/3fa85f64-5717-4562-b3fc-2c963f66afa6/changes';
const timestamp = Math.floor(Date.now() / 1000).toString();
const body = {
"reason": "New supplier",
"bankAccount": {
"nzBankAccount": "12-3456-7890123-001",
"accountName": "Harbourside Office Supplies"
}
};
const bodyString = JSON.stringify(body);
const bodyHash = crypto.createHash('sha256').update(bodyString).digest('hex');
const baseString = `${method}:${signingPath}:${timestamp}:${bodyHash}`;
const signature = crypto.createHmac('sha256', CLIENT_SECRET).update(baseString).digest('hex');
const response = await fetch(`${BASE_URL}/firm-partners/workspace/vendor-bank-accounts/3fa85f64-5717-4562-b3fc-2c963f66afa6/changes`, {
method,
headers: {
'x-client-id': CLIENT_ID,
'x-timestamp': timestamp,
'x-signature': signature,
'Content-Type': 'application/json',
'count-workspace-id': '5e4d3c2b-1a09-4f8e-8d7c-6b5a49382716',
},
body: bodyString,
});
console.log(await response.json());{
"status": "success",
"message": "Vendor bank account change requested; it applies once approved in COUNT",
"data": {
"vendorBankAccountChange": {
"id": "0193a1c2-7b4d-7e10-9a2f-5c6d7e8f9a02",
"changeType": "create",
"status": "pending",
"toBankAccount": {
"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"
},
"reason": "New supplier",
"requestedBy": {
"firstName": "Ana",
"lastName": "Reyes",
"email": "ana@example.com"
},
"approver": {
"firstName": "Ben",
"lastName": "Ito",
"email": "ben@example.com"
},
"decidedAt": null,
"rejectionReason": null,
"createdAt": "2026-01-15T10:30:00.000Z"
}
}
}