List Credit Note Summaries

This action returns the list of all credit notes in summary form. This call supports searching with filters using the query parameter. For example, to get all the credit notes for a specific invoice, call GET v1/CreditNotes?query=invoiceId:{invoiceId}

This call supports string filtering (Read More)

Parameter NameAcceptable ValuesParameter NameAcceptable Values
invoiceIdIntegerInvoice.PostedTimestampDate Range

This call supports pagination (Read More)
This call supports sorting (Read More)
&sortOrder=Ascending or &sortOrder=Descending

curl –X GET{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://{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('{query}&pageSize=100&pageNumber=0',  headers=headers) 
    "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": ""
    "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": ""
    "ErrorId": 0,
    "HttpStatusCode": 400,
    "Errors": [
            "Key": "Api Error",
            "Value": "Bad request, the query is not valid.  Please check your request and try again."