List Credit Note Summaries

Query, paginate, and sort credit note summary results.

This call supports querying, pagination, and sorting. For syntax and examples, see Pagination, Filtering, Sorting, and Event Suppression.

Parameter NameAcceptable ValuesParameter NameAcceptable Values
invoiceIdIntegerInvoice.PostedTimestampDate Range
Invoice.CustomerIdIntegerInvoice.QuickBooksIdInteger
Invoice.InvoiceNumberIntegerNumberString

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

Examples
curl –X GET https://secure.fusebill.com/v1/CreditNotes?query={query}&pageSize=100&pageNumber=0" \
-H "Content-Type: application/json" \ 
-H "Authorization: Basic {APIKey}"
//Setup API key 
string apiKey = "{APIKey}"; 
//Configure URI 
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/CreditNotes?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(); 
}
#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/CreditNotes?query={query}&pageSize=100&pageNumber=0',  headers=headers) 
print(r.content)
Response
[
  {
    "netAmount": 12.66,
    "invoiceNumber": 4,
    "creditNotesNumber": "04-CR-01",
    "reference": "referenceString",
    "customerId": 4865197,
    "invoiceId": 69486,
    "currency": "NZD",
    "customerName": "Richards Moss",
    "customerCompany": "Centrexin",
    "invoicePostedDate": "2019-03-01T04:06:40",
    "effectiveTimestamp": "2019-04-02T10:20:49",
    "id": 8795,
    "uri": "https://secure.fusebill.com/v1/CreditNotes/8795"
  },
  {
    "netAmount": 43.9,
    "invoiceNumber": 4,
    "creditNotesNumber": "04-CR-01",
    "reference": "referenceString",
    "customerId": 584679,
    "invoiceId": 69486,
    "currency": "AUD",
    "customerName": "Angela Cherry",
    "customerCompany": "Iplax",
    "invoicePostedDate": "2019-02-09T02:14:31",
    "effectiveTimestamp": "2019-05-31T08:20:03",
    "id": 8799,
    "uri": "https://secure.fusebill.com/v1/CreditNotes/8799"
  }
]
{
    "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