get https://secure.fusebill.com/v1/invoiceSummaries?query=parameterName:value&pageSize=100&pageNumber=0
This function returns a list of summarized invoice objects. Since this will likely return a very large list, 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 |
---|---|---|---|
companyName | String | effectiveTimestamp | Date Range |
currency | 3-digit ISO code | firstName | String |
customerId | Integer | invoiceAmount | Decimal Range |
Customer.AccountStatus | Good, PoorStanding, Collection | invoiceNumber | Integer |
Customer.Arbalance | Decimal Range | invoiceStatus | Due, Overdue, Paid, WrittenOff, Void, Disputed, Pending |
Customer.CreatedTimestamp | Date Range | lastName | String |
Customer.CurrentMrr | Decimal Range | middleName | String |
Customer.CurrentNetMrr | String | modifiedTimestamp | Date Range |
Customer.CustomerReference.Reference1 | String | outstandingBalance | Decimal Range |
Customer.CustomerReference.Reference2 | String | postedTimestamp | Date Range |
Customer.CustomerReference.Reference3 | Date Range | quickBooksId | String |
Customer.ModifiedTimestamp | Decimal Range | reference | String |
Customer.MonthlyRecurringRevenue | Decimal Range | sumOfCharges | Decimal Range |
Customer.NetMRR | Decimal Range | totalCreditNotes | Decimal Range |
Customer.ParentId | Integer | totalPayments | Decimal Range |
Customer.Status | Draft, Active, Cancelled, Hold, Suspended | unsettled | Boolean |
dueDate | Date Range | writeoffs | Decimal Range |
This call supports Pagination (Read More)
&pageSize=100&pageNumber=0
This call supports Sorting Read More
&sortOrder=Ascending
or &sortOrder=Descending
&sortExpression=expression
Examples
curl –X GET https://secure.fusebill.com/v1/invoiceSummaries?query={query}&pageSize=100&pageNumber=0\
-H "Content-Type: application/json" \
-H "Authorization: Basic {APIKey}"
#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 your URI and Headers
r = requests.get('https://secure.fusebill.com/v1/invoiceSummaries??query={query}&pageSize=100&pageNumber=0', headers=headers)
print(r.content)
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/invoiceSummaries?query={query}&pageSize=100&pageNumber=0");
//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();
}
Response
[
{
"customerId": 1856489,
"reference": "AB876",
"companyName": "Acme",
"customerName": "Jamie Taylor",
"effectiveTimestamp": "2019-10-15T20:29:00",
"postedTimestamp": "2019-10-15T20:29:00",
"dueDate": "2019-10-25T04:00:00",
"modifiedTimestamp": "2019-10-15T20:29:00",
"invoiceStatus": "Due",
"invoiceNumber": 17,
"invoiceAmount": 400,
"sumOfCharges": 400,
"totalPayments": 0,
"totalCreditNotes": 0,
"writeoffs": 0,
"outstandingBalance": 400,
"currency": "USD",
"avalaraId": null,
"unsettled": false,
"id": 547049,
"uri": "https://secure.fusebill.com/v1/invoiceSummaries/547049"
}
]
{
"ErrorId": 0,
"HttpStatusCode": 400,
"Errors": [
{
"Key": "Api Error",
"Value": "Bad request, the query is not valid. Please check your request and try again."
}
]
}