GuidesAPI ReferenceSupport

Un-Hold Customer

post https://secure.fusebill.com/v1/customers/unhold

This function is used to remove the hold status from a customer. They will revert to active status.

Request Parameters

PropertyTypeDescriptionRequired
customerIdIntegerThis is the the Id value which uniquely identifies this
Customer record in the Fusebill system. This value is unique to each customer.		Yes
serviceStartOptionEnum: {ChargeForAllMissedPeriods, ChargeForLastMissedPeriods, NoChargesForMissedPeriods, ChargeForCurrentFullPeriod}When the customer is taken off of the Hold status, you are given a number of options for collection of outstanding funds owing.Yes
previewBooleanIf set to True the customer is not taken off hold, the call will simply simulate the unhold action and calculate the mock invoice.Optional
showZeroDollarChargesBooleanControls whether zero dollar charges are shown on the invoice preview if preview is trueOptional
temporarilyDisableAutoPostBooleanThis key allows you to temporarily disable invoice post and thus the collection of outstanding amounts owing.Optional
Examples
curl -X POST "https://secure.fusebill.com/v1/customers/unHold" \
	-H "Content-Type: application/json" \
	-H "Authorization: Basic {APIKey}" \
	-d "{customerId:{id},serviceStartOption:'ChargeForCurrentFullPeriod',showZeroDollarCharges:false,temporarilyDisableAutoPost:false,prorate:false,preview:true}"

//Json data, Fusebill Id which corresponds to the customerId Field
string jsonData = "{'customerId':{id},'serviceStartOption':'ChargeForCurrentFullPeriod','preview':false,'showZeroDollarCharges':false,'temporarilyDisableAutoPost':false,'prorate':false}";
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/customers/unHold");
//Add Content type
request.ContentType = "application/json";
//Add Api key authorization
request.Headers.Add(HttpRequestHeader.Authorization, "Basic "+apiKey);
//Set request method
request.Method = "POST";
//Add the json data to request
using (var streamWriter = new StreamWriter(request.GetRequestStream()))
{
  streamWriter.Write(jsonData);
  streamWriter.Flush();
  streamWriter.Close();
}
//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 json
#Import library Requests
import requests
#Pass in a dictionary to the Headers parameter
headers = {'Authorization' : 'Basic {APIKey}', 'Content-Type' : 'application/json'}
#Pass in a dict to the Payload parameter
payload = {'customerId':{id},"serviceStartOption":"ChargeForAllMissedPeriods","preview":'false',"showZeroDollarCharges":'false',"temporarilyDisableAutoPost":'false'}
#Pass in your URI, Payload and Headers
r = requests.post('https://secure.fusebill.com/v1/customers/unHold', data=json.dumps(payload), headers=headers)
print(r.content)

{
  "customerId": 180513,
  "serviceStartOption": "ChargeForLastMissedPeriods",
  "preview": false,
  "showZeroDollarCharges": false,
  "temporarilyDisableAutoPost": false
}
Response
{
  "firstName": "Cleo",
  "middleName": "Flowers",
  "lastName": "Santiago",
  "companyName": "Bedder",
  "suffix": "Sr.",
  "primaryEmail": "[email protected]",
  "primaryPhone": 8435292637,
  "secondaryEmail": "[email protected]",
  "secondaryPhone": 9704712723,
  "title": "Ms",
  "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": "Cleo1974",
  "parentId": 12000749,
  "quickBooksLatchType": null,
  "quickBooksId": null,
  "quickBooksSyncToken": null,
  "hubSpotId": null,
  "hubSpotCompanyId":null,
  "geotabId": "7813",
  "modifiedTimestamp": "2019-11-07T15:51:11.1915461Z",
  "createdTimestamp": "2018-01-01T03:33:33.02",
  "id": 12000750,
  "uri": "https://secure.fusebill.com/v1/customers/12000750"
}

{
    "ErrorId": 0,
    "HttpStatusCode": 400,
    "Errors": [
        {
            "Key": "customerHold.CustomerServiceStartOption",
            "Value": "Allowable Service Start Option are: null, ChargeForAllMissedPeriods, ChargeForLastMissedPeriods, NoChargesForMissedPeriods, ChargeForCurrentFullPeriod"
        }
    ]
}
Language
Authorization