Read Customer Invoice Summaries

This function is used to retrieve invoice summaries for a customer. Specify the unique Fusebill ID of the customer in your request.

Query String Parameters


Parameter NameAccepted ValuesParameter NameAccepted Values
IdIntegereffectiveTimestampDate Range
referenceStringcustomerIdInteger
invoiceAmountDecimal RangeinvoiceNumberInteger
invoiceStatusDue, Overdue, Paid, WrittenOff, Void, Disputed, PendingmodifiedTimestampDate Range
dueDateDecimal RangepostedTimestampDate Range
customer.StatusActive, Draft, Hold, Cancelled, SuspendedunsettledBoolean

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/customers/{customerId}/invoiceSummaries" \
	-H "Content-Type: application/json" \
	-H "Authorization: Basic {APIKey}"
//query parameter
int queryParameter = {customerId};
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/customers/"+queryParameter+"/invoiceSummaries");
//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 requests
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://secure.fusebill.com/v1/customers/183365/invoiceSummaries', headers=headers)
print(r.content)
Response
[
    {
        "customerId": 1234567,
        "reference": null,
        "companyName": "Sample Company",
        "customerParentId": null,
        "customerName": "",
        "effectiveTimestamp": "2021-04-16T19:01:33",
        "postedTimestamp": "2021-04-16T19:01:33",
        "dueDate": "2021-04-16T04:00:00",
        "modifiedTimestamp": "2021-04-16T19:01:33",
        "invoiceStatus": "Overdue",
        "invoiceNumber": "3",
        "invoiceAmount": 25.0000,
        "sumOfCharges": 25.0000,
        "totalPayments": 0.0000,
        "totalCreditNotes": 0.0000,
        "writeoffs": 0.0000,
        "outstandingBalance": 25.0000,
        "currency": "USD",
        "avalaraId": null,
        "unsettled": false,
        "id": 8765432,
        "uri": "https://secure.fusebill.com/v1/invoiceSummaries/8765432"
    },
    {
        "customerId": 2958328,
        "reference": null,
        "companyName": "Sample Company",
        "customerParentId": null,
        "customerName": "",
        "effectiveTimestamp": "2021-04-16T18:59:35",
        "postedTimestamp": "2021-04-16T18:59:35",
        "dueDate": "2021-04-16T04:00:00",
        "modifiedTimestamp": "2021-04-16T18:59:35",
        "invoiceStatus": "Paid",
        "invoiceNumber": "2",
        "invoiceAmount": 50.0000,
        "sumOfCharges": 50.0000,
        "totalPayments": 50.0000,
        "totalCreditNotes": 0.0000,
        "writeoffs": 0.0000,
        "outstandingBalance": 0.0000,
        "currency": "USD",
        "avalaraId": null,
        "unsettled": false,
        "id": 8765433,
        "uri": "https://secure.fusebill.com/v1/invoiceSummaries/8765433"
    }
]
{
    "ErrorId": 0,
    "HttpStatusCode": 404,
    "Errors": [
        {
            "Key": "Api Error",
            "Value": "Customer with id 2 not found."
        }
    ]
}
Path Params
int32
required
Query Params
string

This call supports string filtering (Read More) and datetime/numeric range filtering (Read More) &query=parameterName:Value

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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