Create a payment batch
POSTNZ· GST
/firm-partners/workspace/payment-batchesCreates an empty draft batch.
HMAC signature only
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.
Request body
fromAccountUuiduuidrequiredThe bank account paying, from the Chart of Accounts.
paymentDatedaterequiredWhen the bank should pay, YYYY-MM-DD.
bankenumThe bank file format. Taken from the paying account when omitted.
One of: asb, bnz, anz, kiwibank, westpac, generic
statementDetailsstringWhat appears on your own statement.
fromAccountNumberstringYour own account number. Taken from the paying account when omitted; the BNZ, Kiwibank and Westpac formats need it.
Responses
201The batch.400Not a New Zealand workspace, an invalid date, or a bank format that needs your account number and has none.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. Troubleshoot404Paying account not found.429Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). TroubleshootPOST
https://api.getcount.com/firm-partners/workspace/payment-batchesRequest
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 method = 'POST';
const signingPath = '/workspace/payment-batches';
const timestamp = Math.floor(Date.now() / 1000).toString();
const body = {
"fromAccountUuid": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a10",
"paymentDate": "2026-11-20"
};
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/payment-batches`, {
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());Response · 201
{
"status": "success",
"message": "Payment batch created",
"data": {
"paymentBatch": {
"id": "0193a1c2-7b4d-7e10-9a2f-5c6d7e8f9b01",
"reference": "BATCH-261120-01",
"status": "draft",
"paymentDate": "2026-11-20",
"fromAccount": {
"id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a10",
"name": "ASB Business"
},
"fromAccountNumber": "12-3456-7890123-00",
"bank": "asb",
"bankCountry": "NZ",
"statementDetails": "Supplier run",
"total": "1250.0000",
"createdBy": {
"id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a03",
"firstName": "Ana",
"lastName": "Reyes",
"email": "ana@example.com"
},
"downloadedAt": null,
"sentAt": null,
"paidAt": null,
"reconciledAt": null,
"createdAt": "2026-01-15T10:30:00.000Z",
"updatedAt": "2026-01-28T14:22:30.000Z",
"lines": [
{
"id": "0193a1c2-7b4d-7e10-9a2f-5c6d7e8f9b02",
"bill": {
"id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a01",
"billNumber": "INV-0042"
},
"vendor": {
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"name": "Harbourside Office Supplies Ltd"
},
"payeeBankAccount": {
"nzBankAccount": "12-3456-7890123-001",
"accountName": "Harbourside Office Supplies"
},
"particulars": "Acme Ltd",
"code": "INV-0042",
"reference": "ACME-001",
"dueAmount": "1250.0000",
"paymentAmount": "1250.0000",
"reconciledAt": null
}
],
"approvers": [
{
"user": {
"id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a02",
"firstName": "Ben",
"lastName": "Ito",
"email": "ben@example.com"
},
"status": "pending",
"assignedAt": "2026-01-28T14:22:30.000Z",
"approvedAt": null,
"rejectedAt": null,
"rejectionReason": null
}
]
}
}
}