GuidesAPI ReferenceSupport

Read Customer Overview

get https://secure.fusebill.com/v1/customers//overview

This resource is used to retrieve a short form customer object with some additional payment and account balance information. This is ideal for quickly checking if a customer has an unpaid balance, has a credit, or pending charges.

Path Parameters

PropertyTypeDescription
customerIdIntegerThis is the the Id value which uniquely identifies this Customer record in the Fusebill system. This value is unique to each customer.
Examples
curl -X GET "https://secure.fusebill.com/v1/customers/{id}/Overview" \
	-H "Content-Type: application/json" \
	-H "Authorization: Basic {APIKey}"

//Path parameter, Fusebill Id which corresponds to the customerId 
int pathParameter = {customerId}; 
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://stg-secure.fusebill.com/v1/customers/"+pathParameter+"/Overview");
//Add Content type
request.ContentType = "application/json";
request.ContentLength = 0;
//Add Api key authorization
request.Headers.Add(HttpRequestHeader.Authorization, "Basic "+apiKey);
//Set request method
request.Method = "GET";
//Perform the request
var httpResponse = (HttpWebResponse)request.GetResponse();
//Record the response from our request
var result = "";
using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
  result = streamReader.ReadToEnd();
}

#Import library Requests
import requests
#Pass in a dictionary to the Headers parameter
headers = {'Authorization' : 'Basic {APIKey}', 'Content-Type' : 'application/json'}
#Pass in your URI, Payload and Headers
r = requests.get('https://stg-secure.fusebill.com/v1/customers/{id}/overview', headers=headers)
print(r.content)
Response
{
  "title": "Dr",
  "firstName": "Foreman",
  "middleName": "Mai",
  "lastName": "Travis",
  "suffix": "Jr.",
  "primaryEmail": "[email protected]",
  "primaryPhone": 9934643454,
  "companyName": 9984242269,
  "reference": 100986,
  "createdTimestamp": "2019-11-06T14:19:01",
  "status": "Active",
  "customerAccountStatus": "Good",
  "pendingCharges": 0,
  "arBalance": 0,
  "unallocatedPayments": 0,
  "unallocatedCredits": 0,
  "unallocatedOpeningBalance": 0,
  "currency": "USD",
  "daysUntilSuspension": null,
  "daysUntilCancellation": null,
  "customerAccountStatusTimestamp": "2019-11-06T14:19:01",
  "statusTimestamp": "2019-11-06T14:19:01",
  "lifetimeValue": 0,
  "monthlyRecurringRevenue": 0,
  "netMonthlyRecurringRevenue": 0,
  "nextBillingDate": null,
  "salesforceSynchStatus": "Enabled",
  "salesforceId": null,
  "quickbooksId": null,
  "netsuiteId": null,
  "hubSpotId": null,
  "hubSpotCompanyId":null,
  "geotabId":"1234",   
  "parentId": null,
  "parentName": null,
  "isParent": false,
  "unknownPaymentActivityId": null,
  "id": 650084,
  "uri": "https://secure.fusebill.com/v1/CustomerOverview/650084"
}

{
    "ErrorId": 0,
    "HttpStatusCode": 404,
    "Errors": [
        {
            "Key": "Api Error",
            "Value": "CustomerOverview with id 2 not found."
        }
    ]
}
Language
Authorization