CustomersPreview a customer merge

Preview a customer merge

POST/firm-partners/workspace/customers/merge/preview

Reports what a merge would move, without changing anything.

Read-only. Returns the target and source customers plus a count of every record that would be repointed at the target, so you can show the user the blast radius before committing. Run this before Merge customers — the merge itself cannot be undone through the API.

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.

Request body

targetCustomerUuiduuidrequired

The customer that survives the merge and receives every reference.

sourceCustomerUuidsarrayrequired

Customers to fold into the target. Non-empty, capped at 100 per request. The target UUID is ignored if it also appears here, and duplicates are collapsed.

Responses

200What the merge would affect. `affectedItems` counts records on the source customers only.
400targetCustomerUuid missing, sourceCustomerUuids empty or over 100 entries, no distinct source left after the target is excluded, or a source is a firm-managed customer.
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
404The target or one of the source customers was not found in this workspace.
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/customers/merge/preview
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/customers/merge/preview';
const timestamp = Math.floor(Date.now() / 1000).toString();
const body = {
  "targetCustomerUuid": "dfa3219e-6af8-4c53-997a-037534f63a35",
  "sourceCustomerUuids": [
    "7c8d9e0f-1a2b-4c3d-8e4f-5a6b7c8d9e0f"
  ]
};
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/customers/merge/preview`, {
  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": "Successfully generated merge preview",
  "data": {
    "result": {
      "targetCustomer": {
        "id": "dfa3219e-6af8-4c53-997a-037534f63a35",
        "customer": "Acme Corporation",
        "email": "contact@acme.com",
        "mainPhone": "+1234567890",
        "website": "https://acme.com",
        "status": "active",
        "notes": "Preferred customer. Net-30 terms.",
        "paymentTerm": "net30",
        "taxNumber": null,
        "taxAutoCalculate": false,
        "taxExcluded": false,
        "contactName": "John Doe",
        "billingAddress": {
          "id": "0b2c1f5e-7a9d-4f2b-9c1e-2a4b6d8e0f12",
          "street": "123 Main St",
          "city": "San Francisco",
          "state": "CA",
          "zipCode": "94102",
          "country": "USA"
        },
        "shippingAddress": null,
        "contacts": [
          {
            "id": "a5da3577-bf85-4e3a-aa73-df85ca69bc67",
            "firstName": "John",
            "lastName": "Doe",
            "email": "john@acme.com",
            "phone": "+1234567890",
            "isPrimary": true
          }
        ],
        "taxes": [],
        "salesRep": null,
        "createdAt": "2026-01-15T10:30:00.000Z",
        "updatedAt": "2026-01-28T14:22:30.000Z"
      },
      "sourceCustomers": [
        {
          "id": "7c8d9e0f-1a2b-4c3d-8e4f-5a6b7c8d9e0f",
          "customer": "Acme Corp.",
          "email": "contact@acme.com",
          "mainPhone": "+1234567890",
          "website": "https://acme.com",
          "status": "active",
          "notes": "Preferred customer. Net-30 terms.",
          "paymentTerm": "net30",
          "taxNumber": null,
          "taxAutoCalculate": false,
          "taxExcluded": false,
          "contactName": "John Doe",
          "billingAddress": {
            "id": "0b2c1f5e-7a9d-4f2b-9c1e-2a4b6d8e0f12",
            "street": "123 Main St",
            "city": "San Francisco",
            "state": "CA",
            "zipCode": "94102",
            "country": "USA"
          },
          "shippingAddress": null,
          "contacts": [
            {
              "id": "a5da3577-bf85-4e3a-aa73-df85ca69bc67",
              "firstName": "John",
              "lastName": "Doe",
              "email": "john@acme.com",
              "phone": "+1234567890",
              "isPrimary": true
            }
          ],
          "taxes": [],
          "salesRep": null,
          "createdAt": "2026-01-15T10:30:00.000Z",
          "updatedAt": "2026-01-28T14:22:30.000Z"
        }
      ],
      "affectedItems": {
        "transactions": 18,
        "journalEntries": 2,
        "invoices": 7,
        "estimates": 1,
        "creditMemos": 0,
        "documents": 3,
        "projects": 1,
        "recurringInvoiceTemplates": 0,
        "timeEntries": 12,
        "bills": 0,
        "vendorMemos": 0,
        "smsMessages": 0,
        "customerContacts": 2,
        "customerAddresses": 1,
        "customerTaxes": 0,
        "customerStatments": 0,
        "automationActions": 0,
        "automationConditionCustomers": 0,
        "reportHistoryCustomers": 0,
        "customerNotes": 4,
        "sourceCustomersToDelete": 1
      },
      "note": "All references from Acme Corp. will be moved to Acme Corporation. Source customer(s) will be soft deleted (marked as inactive and deleted)."
    }
  }
}