COUNTCOUNT
Sign Up
CustomersGet customer revenue overview

Get customer revenue overview

GET/partners/customers/{uuid}/revenue-overview

Returns 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 + Bearer access token
Try this request
Invoices APIProjects APIRecurring Invoice Templates API

Path parameters

uuiduuidrequired

The customer UUID.

Responses

200The revenue overview, returned under `result`.
404Customer not found.
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 clientId). Retry after the Retry-After header. Troubleshoot
GEThttps://api.getcount.com/partners/customers/{uuid}/revenue-overview
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 = 'GET';
const signingPath = '/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}/partners/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/revenue-overview`, {
  method,
  headers: {
    'x-client-id': CLIENT_ID,
    'x-timestamp': timestamp,
    'x-signature': signature,
    Authorization: `Bearer ${ACCESS_TOKEN}`,
  },
});

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
    }
  }
}