Get customer revenue overview
GET
/firm-partners/workspace/customers/{uuid}/revenue-overviewReturns billing totals and payment behaviour for one customer.
Aggregates the customer’s posted invoices and categorised transactions into the figures the customer profile screen shows. Only records in the workspace’s own currency are counted, and draft invoices are excluded. Every amount is rounded to two decimal places.
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.
Path parameters
uuiduuidrequiredThe customer UUID.
Responses
200The revenue overview, returned under `result`.400The `count-workspace-id` header is missing.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. Troubleshoot404Customer not found.429Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). TroubleshootGET
https://api.getcount.com/firm-partners/workspace/customers/{uuid}/revenue-overviewRequest
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 = 'GET';
const signingPath = '/workspace/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/revenue-overview';
const timestamp = Math.floor(Date.now() / 1000).toString();
const bodyString = '';
const bodyHash = '';
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/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/revenue-overview`, {
method,
headers: {
'x-client-id': CLIENT_ID,
'x-timestamp': timestamp,
'x-signature': signature,
'count-workspace-id': '5e4d3c2b-1a09-4f8e-8d7c-6b5a49382716',
},
});
console.log(await response.json());Response · 200
{
"status": "success",
"message": "success on getting revenue overview",
"data": {
"result": {
"currency": "USD",
"totalRevenue": 48250,
"pendingPayments": 1500,
"invoicePaid": 12,
"invoiceUnpaid": 3,
"totalPaid": 44750,
"totalOverdueCount": 1,
"totalUnpaidAmount": 2000,
"totalGrossUnpaidAmount": 2500,
"totalOverdueAmount": 900,
"customerCreditBalance": 500,
"totalNetOutstandingAmount": 2000,
"averageDaysToPay": 18.4,
"incomingTransaction": 14,
"outgoingTransaction": 2,
"invoiceSent": 15
}
}
}