List Invoice Summaries

Query, paginate, and sort invoice summary results.

This call supports querying, pagination, and sorting. For syntax and examples, see Pagination, Filtering, Sorting, and Event Suppression.
&query=parameterName:Value

Parameter NameAcceptable ValuesParameter NameAcceptable Values
IdIntegereffectiveTimestampDate Range
customerIdIntegerinvoiceAmountDecimal Range
referenceStringinvoiceStatusDue, Overdue, Paid, WrittenOff, Void, Disputed, Pending
postedTimestampDate RangemodifiedTimestampDate Range
Customer.StatusDraft, Active, Cancelled, Hold, SuspendedunsettledBoolean
dueDateDate RangeinvoiceNumberInteger

Use &pageSize=100&pageNumber=0 for pagination.
Use &sortOrder=Ascending or &sortOrder=Descending with &sortExpression=expression for sorting.

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."
        }
    ]
}
Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json