Supplier Bank AccountsRequest a supplier bank account change

Request a supplier bank account change

POSTNZ· GST/partners/vendor-bank-accounts/{uuid}/changes

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

HMAC signature + Bearer access token
Try this request

Path parameters

uuiduuidrequired

The supplier's UUID: its `id` from List vendors. A supplier has at most one active bank account.

Request body

changeTypeenum

Send `deactivate` to remove the active account. Omit it to add or replace one.

One of: deactivate

reasonstring

Why the change is needed, shown to the approver.

bankAccountobject

The new account. Required unless `changeType` is `deactivate`, and refused with it.

nzBankAccountstringrequired

The account number, `BB-bbbb-AAAAAAA-SSS` (e.g. 12-3456-7890123-00).

accountNamestring

Account holder name.

defaultParticularsstring

Up to 12 characters.

defaultCodestring

Up to 12 characters.

defaultReferencestring

Up 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`).
404Supplier not found, or a removal for a supplier with no active account.
409Another change for this supplier is still waiting for approval.
401Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token. Troubleshoot
403The credential does not have access to this workspace or resource. Troubleshoot
429Rate limit exceeded (100 requests per minute per user of each app, or 10,000 per minute per app). Retry after the Retry-After header. Troubleshoot
POSThttps://api.getcount.com/partners/vendor-bank-accounts/{uuid}/changes
Request
import 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 ACCESS_TOKEN = process.env.COUNT_ACCESS_TOKEN;

const method = 'POST';
const signingPath = '/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}/partners/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',
    Authorization: `Bearer ${ACCESS_TOKEN}`,
  },
  body: bodyString,
});

console.log(await response.json());
Response · 201
{
  "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"
    }
  }
}