get https://secure.fusebill.com/v1/customers/?query=parameterName:value&pageSize=100&pageNumber=0
This function is used to retrieve a list of customer objects.
In order to manage the size of the data returned it is strongly recommended that pagination is used.
This call supports string filtering (Read More) and datetime/numeric range filtering (Read More)
&query=parameterName:Value
Parameter Name | Acceptable Values | Parameter name | Acceptable Values |
---|---|---|---|
AccountStatus | Good, PoorStanding, Collection | FirstName | String |
Arbalance | Decimal Range | LastName | String |
CompanyName | String | MiddleName | String |
CreatedTimestamp | Date Range | ModifiedTimestamp | Date Range |
CurrencyId | Integer (1-24)* | MonthlyRecurringRevenue | Decimal Range |
CurrentMrr | Decimal Range | NetMRR | Decimal Range |
CurrentNetMrr | Decimal Range | NetsuiteEntityType | Integer (1-2)** |
CustomerAcquisition.AdContent | String | NetSuiteId | String |
CustomerAcquisition.Campaign | String | NetSuiteSynchStatusId | Enabled, Disabled |
CustomerAcquisition.LandingPage | String | ParentId | Integer |
CustomerAcquisition.Medium | String | PrimaryEmail | String |
CustomerAcquisition.Source | String | PrimaryPhone | String |
CustomerReference.Reference1 | String | QuickBooksId | Integer |
CustomerReference.Reference2 | String | QuickBooksLatchTypeId | CreateNew, LatchExisting, DoNothing |
CustomerReference.Reference3 | String | QuickBooksSyncToken | Integer |
CustomerReference.SalesTrackingCode1.Code | String | Reference | String |
CustomerReference.SalesTrackingCode1.Name | String | SalesforceAccountType | Company, Person |
CustomerReference.SalesTrackingCode2.Code | String | SalesforceId | String |
CustomerReference.SalesTrackingCode2.Name | String | SalesforceSynchStatus | Enabled, Disabled |
CustomerReference.SalesTrackingCode3.Code | String | SecondaryEmail | String |
CustomerReference.SalesTrackingCode3.Name | String | SecondaryPhone | String |
CustomerReference.SalesTrackingCode4.Code | String | Status | Draft, Active, Cancelled, Hold, Suspended |
CustomerReference.SalesTrackingCode4.Name | String | Suffix | String |
CustomerReference.SalesTrackingCode5.Code | String | Title | Mr, Mrs, Ms, Miss, Dr |
CustomerReference.SalesTrackingCode5.Name | String |
*See here for Fusebill currency codes
**The NetsuiteEntityType
is 1 for “Customer – Individual” and 2 for "Customer – Company”
This call supports Pagination (Read More)
&pageSize=100&pageNumber=0
This call supports Sorting Read More
&sortOrder=Ascending
or &sortOrder=Descending
&sortExpression=expression
Example
curl -X GET "https://secure.fusebill.com/v1/customers?query=firstName:John" \
-H "Content-Type: application/json" \
-H "Authorization: Basic {APIKey}"
//Query String
string queryString = "firstName:john";
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://stg-secure.fusebill.com/v1/customers/?query="+queryString);
//Add Content type
request.ContentType = "application/json";
//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 JSON
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?query=firstName:John', headers=headers)
print(r.content)
Response
[
{
"firstName": "Bowen",
"middleName": "Laurie",
"lastName": "Rosales",
"companyName": "Manglo",
"suffix": "Jr.",
"primaryEmail": "[email protected]",
"primaryPhone": 9454323791,
"secondaryEmail": "[email protected]",
"secondaryPhone": 8784522075,
"title": "Dr",
"reference": 100986,
"status": "Active",
"customerAccountStatus": "Good",
"currency": "USD",
"customerReference": {
"reference1": null,
"reference2": "customValue",
"reference3": null,
"salesTrackingCodes": [],
"id": 12000750,
"uri": "https://secure.fusebill.com/v1/customers/12000750"
},
"customerAcquisition": {
"adContent": null,
"campaign": null,
"keyword": null,
"landingPage": null,
"medium": null,
"source": null,
"id": 12000750,
"uri": "https://secure.fusebill.com/v1/customers/12000750"
},
"monthlyRecurringRevenue": 250,
"netMonthlyRecurringRevenue": 220,
"salesforceId": 12345678,
"salesforceAccountType": null,
"salesforceSynchStatus": "Enabled",
"netsuiteId": 12345678,
"netsuiteSynchStatus": "Enabled",
"netsuiteCustomerType": "Individual",
"portalUserName": "Bowen1974",
"parentId": 12000749,
"quickBooksLatchType": null,
"quickBooksId": null,
"quickBooksSyncToken": null,
"hubSpotId": null,
"hubSpotCompanyId":null,
"geotabId":"1234",
"modifiedTimestamp": "2019-11-07T15:51:11.1915461Z",
"createdTimestamp": "2018-01-01T03:33:33.02",
"id": 12000750,
"uri": "https://secure.fusebill.com/v1/customers/12000750"
}
]
//if a malformed query string is used:
{
"ErrorId": 0,
"HttpStatusCode": 400,
"Errors": [
{
"Key": "Api Error",
"Value": "Bad request, the query is not valid. Please check your request and try again."
}
]
}