GET v1/customers/{id}/overview?showCustomerFinancialsInCustomerOverview={showCustomerFinancialsInCustomerOverview}
Documentation for 'Overview'.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
id | Documentation for 'id'. |
Define this parameter in the request URI. |
showCustomerFinancialsInCustomerOverview | Documentation for 'showCustomerFinancialsInCustomerOverview'. |
Define this parameter in the request URI. |
Response Information
Response body formats
application/json, text/json
Sample:
Click to beautify!
{ "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", "companyName": "sample string 8", "reference": "sample string 9", "createdTimestamp": "2024-05-03T13:12:07.7040076+00:00", "status": "sample string 11", "customerAccountStatus": "sample string 12", "pendingCharges": 1.0, "arBalance": 1.0, "unallocatedPayments": 13.0, "unallocatedCredits": 14.0, "unallocatedOpeningBalance": 15.0, "currency": "sample string 16", "daysUntilSuspension": 1, "daysUntilCancellation": 1, "customerAccountStatusTimestamp": "2024-05-03T13:12:07.7196803+00:00", "statusTimestamp": "2024-05-03T13:12:07.7196803+00:00", "lifetimeValue": 19.0, "monthlyRecurringRevenue": 20.0, "netMonthlyRecurringRevenue": 21.0, "nextBillingDate": "2024-05-03T13:12:07.7196803+00:00", "salesforceSynchStatus": "sample string 22", "salesforceId": "sample string 23", "quickbooksId": 1, "netsuiteId": "sample string 24", "hubSpotId": 1, "hubSpotCompanyId": 1, "geotabId": "sample string 25", "digitalRiverId": "sample string 26", "parentId": 1, "parentName": "sample string 27", "isParent": true, "unknownPaymentActivityId": 1, "id": 29, "uri": "sample string 30" }
application/xml, text/xml
Sample:
Click to beautify!
<CustomerOverview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get"> <Id>29</Id> <Uri>sample string 30</Uri> <ArBalance>1</ArBalance> <CompanyName>sample string 8</CompanyName> <Created>2024-05-03T13:12:07.7040076+00:00</Created> <Currency>sample string 16</Currency> <CustomerAccountStatus>sample string 12</CustomerAccountStatus> <CustomerAccountStatusTimestamp>2024-05-03T13:12:07.7196803+00:00</CustomerAccountStatusTimestamp> <DaysUntilCancellation>1</DaysUntilCancellation> <DaysUntilSuspension>1</DaysUntilSuspension> <DigitalRiverId>sample string 26</DigitalRiverId> <FirstName>sample string 2</FirstName> <GeotabId>sample string 25</GeotabId> <HubSpotCompanyId>1</HubSpotCompanyId> <HubSpotId>1</HubSpotId> <IsParent>true</IsParent> <LastName>sample string 4</LastName> <LifetimeValue>19</LifetimeValue> <MiddleName>sample string 3</MiddleName> <MonthlyRecurringRevenue>20</MonthlyRecurringRevenue> <NetMonthlyRecurringRevenue>21</NetMonthlyRecurringRevenue> <NetsuiteId>sample string 24</NetsuiteId> <NextBillingDate>2024-05-03T13:12:07.7196803+00:00</NextBillingDate> <ParentId>1</ParentId> <ParentName>sample string 27</ParentName> <PendingCharges>1</PendingCharges> <PrimaryEmail>sample string 6</PrimaryEmail> <PrimaryPhone>sample string 7</PrimaryPhone> <QuickbooksId>1</QuickbooksId> <Reference>sample string 9</Reference> <SalesforceId>sample string 23</SalesforceId> <SalesforceSynchStatus>sample string 22</SalesforceSynchStatus> <Status>sample string 11</Status> <StatusTimestamp>2024-05-03T13:12:07.7196803+00:00</StatusTimestamp> <Suffix>sample string 5</Suffix> <Title>sample string 1</Title> <UnallocatedCredits>14</UnallocatedCredits> <UnallocatedOpeningBalance>15</UnallocatedOpeningBalance> <UnallocatedPayments>13</UnallocatedPayments> <UnknownPaymentActivityId>1</UnknownPaymentActivityId> </CustomerOverview>