GET v1/customers/{id}/overview?showCustomerFinancialsInCustomerOverview={showCustomerFinancialsInCustomerOverview}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required
showCustomerFinancialsInCustomerOverview		boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

Common.Dto.Get.CustomerOverview

Name	Type	Additional information
title	string	None.
firstName	string	None.
middleName	string	None.
lastName	string	None.
suffix	string	None.
primaryEmail	string	None.
primaryPhone	string	None.
secondaryEmail	string	None.
secondaryPhone	string	None.
companyName	string	None.
reference	string	None.
createdTimestamp	date	None.
status	string	None.
customerAccountStatus	string	None.
pendingCharges	decimal number	None.
arBalance	decimal number	None.
unallocatedPayments	decimal number	None.
unallocatedCredits	decimal number	None.
unallocatedOpeningBalance	decimal number	None.
currency	string	None.
daysUntilSuspension	integer	None.
suspensionDate	date	None.
daysUntilCancellation	integer	None.
cancellationDate	date	None.
customerAccountStatusTimestamp	date	None.
statusTimestamp	date	None.
lifetimeValue	decimal number	None.
monthlyRecurringRevenue	decimal number	None.
netMonthlyRecurringRevenue	decimal number	None.
nextBillingDate	date	None.
salesforceSynchStatus	string	None.
salesforceId	string	None.
quickbooksId	integer	None.
netsuiteId	string	None.
hubSpotId	integer	None.
hubSpotCompanyId	integer	None.
geotabId	string	None.
digitalRiverId	string	None.
parentId	integer	None.
parentName	string	None.
isParent	boolean	None.
unknownPaymentActivityId	integer	None.
sageIntacctId	integer	None.
avalaraId	string	None.
id	integer	None.
uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "title": "sample string 1",
  "firstName": "sample string 2",
  "middleName": "sample string 3",
  "lastName": "sample string 4",
  "suffix": "sample string 5",
  "primaryEmail": "sample string 6",
  "primaryPhone": "sample string 7",
  "secondaryEmail": "sample string 8",
  "secondaryPhone": "sample string 9",
  "companyName": "sample string 10",
  "reference": "sample string 11",
  "createdTimestamp": "2025-11-03T10:10:54.9283963+00:00",
  "status": "sample string 13",
  "customerAccountStatus": "sample string 14",
  "pendingCharges": 1.0,
  "arBalance": 1.0,
  "unallocatedPayments": 15.0,
  "unallocatedCredits": 16.0,
  "unallocatedOpeningBalance": 17.0,
  "currency": "sample string 18",
  "daysUntilSuspension": 1,
  "suspensionDate": "2025-11-03T10:10:54.9283963+00:00",
  "daysUntilCancellation": 1,
  "cancellationDate": "2025-11-03T10:10:54.9283963+00:00",
  "customerAccountStatusTimestamp": "2025-11-03T10:10:54.9283963+00:00",
  "statusTimestamp": "2025-11-03T10:10:54.9283963+00:00",
  "lifetimeValue": 21.0,
  "monthlyRecurringRevenue": 22.0,
  "netMonthlyRecurringRevenue": 23.0,
  "nextBillingDate": "2025-11-03T10:10:54.9283963+00:00",
  "salesforceSynchStatus": "sample string 24",
  "salesforceId": "sample string 25",
  "quickbooksId": 1,
  "netsuiteId": "sample string 26",
  "hubSpotId": 1,
  "hubSpotCompanyId": 1,
  "geotabId": "sample string 27",
  "digitalRiverId": "sample string 28",
  "parentId": 1,
  "parentName": "sample string 29",
  "isParent": true,
  "unknownPaymentActivityId": 1,
  "sageIntacctId": 1,
  "avalaraId": "sample string 31",
  "id": 32,
  "uri": "sample string 33"
}