GuidesAPI ReferenceSupport

Poll Bulk Job

get https://secure.fusebill.com/v1/BulkApi/?view=

This call allows you to read a bulk job in any status. It can be used to check the progress for a job as it is validated, or as it is processed.

Path Parameters

PropertyTypeDescription
bulkJobIdNumberThe Fusebill-generated ID that uniquely identifies the bulk job.

Query Parameters

PropertyTypeDescription
viewEnum:{Full}If set to "Full", an array of record objects will be returned. This will show record-by-record statuses.
Examples
curl -X GET "https://secure.fusebill.com/v1/BulkApi/{bulkJobId}" \
	-H "Content-Type: application/json" \
	-H "Authorization: Basic {APIKey}"

//path parameter
int jobId = {jobId};
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/BulkApi/" + jobId);
//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 Requests
import requests
#Pass in a dictionary to the Headers parameter
headers = {'Authorization' : 'Basic {APIKey}', 'Content-Type' : 'application/json'}
#Pass in your URI and Headers
r = requests.get('https://secure.fusebill.com/v1/BulkApi/{jobId}', headers=headers)
print(r.content)
Response
{
    "records": [
        {
            "accountUploadId": 373334,
            "status": "PassedValidation",
            "data": "123",
            "details": null,
            "createdEntityId": null,
            "id": 3456499,
            "uri": null
        },
        {
            "accountUploadId": 373334,
            "status": "PassedValidation",
            "data": "13789624",
            "details": null,
            "createdEntityId": null,
            "id": 3456500,
            "uri": null
        },
        {
            "accountUploadId": 373334,
            "status": "PassedValidation",
            "data": "13789632",
            "details": null,
            "createdEntityId": null,
            "id": 3456501,
            "uri": null
        }
    ],
    "accountId": 9923946,
    "type": "BulkWriteOff",
    "status": "Validated",
    "createdTimestamp": "2020-12-07T14:26:21",
    "completedTimestamp": "2020-12-07T14:26:21.323",
    "totalRecords": 3,
    "successfulRecords": 3,
    "failedRecords": 0,
    "totalProcessedRecords": null,
    "processedRecords": null,
    "failedProcessedRecords": null,
    "importingTimestamp": null,
    "processedTimestamp": null,
    "fileName": "BulkWriteOff-20201207.csv",
    "reference": "Bulk write off",
    "relatedId": null,
    "internalAutomatedFlag": false,
    "modifiedTimestamp": "0001-01-01T00:00:00",
    "id": 373334,
    "uri": null
}

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