TransactionsAssign to bills or invoices

Assign to bills or invoices

POST/firm-partners/workspace/transactions/{uuid}/assign-to-bills-invoices

Applies a transaction as payment against one or more bills or invoices.

HMAC signature only

Headers

count-workspace-iduuidrequired

UUID 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

uuiduuidrequired

The UUID of the transaction (the payment).

Request body

matchingTypeenumrequired

Whether to apply against bills or invoices.

One of: bill, invoice

recordsarrayrequired

Targets to apply the transaction against.

iduuidrequired

UUID of the bill or invoice.

paymentAmountnumberrequired

Amount of this transaction to apply to the target.

withCautionboolean

When true, skips some reconciliation guards. Use sparingly.

Responses

200Transaction assigned.
400Bad request — assignment amount exceeds the transaction or target balance.
401Missing signing headers, an invalid HMAC signature, or a timestamp more than 5 minutes off. Troubleshoot
403The 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. Troubleshoot
404No workspace exists with the `count-workspace-id` UUID.
429Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). Troubleshoot
POSThttps://api.getcount.com/firm-partners/workspace/transactions/{uuid}/assign-to-bills-invoices
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 method = 'POST';
const signingPath = '/workspace/transactions/3fa85f64-5717-4562-b3fc-2c963f66afa6/assign-to-bills-invoices';
const timestamp = Math.floor(Date.now() / 1000).toString();
const body = {
  "matchingType": "invoice",
  "records": [
    {
      "id": "f6a7b8c9-d0e1-2345-fabc-456789012345",
      "paymentAmount": 150
    }
  ],
  "withCaution": false
};
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/transactions/3fa85f64-5717-4562-b3fc-2c963f66afa6/assign-to-bills-invoices`, {
  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 · 200
{
  "status": "success",
  "message": "Transaction assigned."
}