Fetch Credit Memos
1 min
GET
https://api.nue.io/credit-memos
Query Parameters
- customerIdsstringDescription
- customerIdstringDescription
- paymentStatusstringDescriptionAllowedNotTransferredTransferredTransferErrorAppliedPartiallyAppliedPaidPartialPaidRefundedPartialRefundedWrittenOffPartiallyWrittenOffCanceledCreditBack
- statusstringDescriptionAllowedDraftActiveCanceledPendingActivationE-Invoicing
- sourcestringDescriptionAllowedBillingCreditConversionPaymentOperationStandaloneGenerateFromTransaction
- includesstringDescriptionAllowedassetsordersassets,ordersorders,assets
Header Parameters
- nue-api-keystringrequiredDescription
Responses
200
- object
- statusstring<SUCCESS | PARTIAL_SUCCESS | FAILURE>AllowedSUCCESSPARTIAL_SUCCESSFAILURE
- dataobject[]
- idstring
- namestring
- customerIdstring
- amountnumber
- balancenumber
- statusstring
- paymentStatusstring
- sourcestring
- creditMemoDatestring<date>Formatdate
- paginationobject
- pageinteger
- limitinteger
- totalinteger
- hasNextboolean
- hasPreviousboolean
curl
curl --request GET \
--url https://api.nue.io/credit-memos \
--header 'accept: application/json' \
--header 'nue-api-key: string'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("nue-api-key", "string");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.nue.io/credit-memos", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.nue.io/credit-memos")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["nue-api-key"] = "string"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.nue.io/credit-memos"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'nue-api-key': 'string'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Successfully retrieved credit memo data
{
"status": "",
"data": [
{
"id": "",
"name": "",
"customerId": "",
"amount": 0,
"balance": 0,
"status": "",
"paymentStatus": "",
"source": "",
"creditMemoDate": ""
}
],
"pagination": {
"page": 0,
"limit": 0,
"total": 0,
"hasNext": false,
"hasPrevious": false
}
}