Fetch Invoices
1 min
GET
https://api.nue.io/invoices
Query Parameters
- customerIdsstringExample
[ "001KS00000DVz1aYAD", "002KS00000DVz1bYAD" ]
Description - customerIdstringDescription
- paymentStatusstringDescriptionAllowedNotTransferredTransferredTransferErrorPaidPartialPaidCanceledRefundedPartialRefundedWrittenOffPartiallyWrittenOffCreditBackAppliedPartiallyApplied
- statusstringDescriptionAllowedDraftActiveCanceledPendingActivationE-Invoicing
- includesstringExampleDescriptionAllowedassetsorderspaymentApplicationsassets,ordersassets,paymentApplicationsorders,paymentApplicationsassets,orders,paymentApplications
Header Parameters
- nue-api-keystringrequiredDescription
Responses
200
- object
- statusstring
- dataobject[]
- accountingStatusstring
- activatedByIdstring
- activatedTimestring
- amountnumber
- amountWithoutTaxnumber
- assetsobject[]
- assetNumberstring
- assetTypestring
- externalIdstring
- externalNamestring
- productobject
- autoRenewboolean
- billingTimingstring
- bundleTemplatestring
- carvesEligibleboolean
- configurableboolean
- defaultRenewalTermnumber
- defaultSubscriptionTermnumber
- descriptionstring
- evergreenboolean
- freeTrialTypestring
- idstring
- imageUrlstring
- lastPublishedByIdstring
- lastPublishedDatestring
- namestring
- priceBookEntriesobject[]
- activeboolean
- billingTimingstring
- idstring
- listPricenumber
- priceBookIdstring
- pricingAttributesobject[]
- recommendedboolean
- uomobject
- decimalScalenumber
- idstring
- namestring
- quantityDimensionstring
- roundingModestring
- priceModelstring
- productCategorystring
- productFeaturesobject[]
- productOptionsobject[]
- productPriceTagsobject[]
- publishStatusstring
- recordTypestring
- showIncludedProductOptionsboolean
- skustring
- soldIndependentlyboolean
- startDatestring
- statusstring
- uomobject
- productIdstring
- balancenumber
- billToContactIdstring
- createdByIdstring
- createdDatestring
- customerIdstring
- dueDatestring
- endDatestring
- externalInvoiceIdstring
- idstring
- invoiceDatestring
- isCatchUpboolean
- lastModifiedByIdstring
- lastModifiedDatestring
- namestring
- ordersobject[]
- paymentDetailsstring
- paymentHostedUrlstring
- paymentStatusstring
- poDatesstring
- poNumbersstring
- salesAccountIdstring
- shippingAndHandlingnumber
- sourcestring
- startDatestring
- statusstring
- targetDatestring
- taxAmountnumber
- taxStatusstring
- warningsobject[]
curl
curl --request GET \
--url https://api.nue.io/invoices \
--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/invoices", 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/invoices")
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/invoices"
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
// Successful retrieval of customer invoices.
{
"status": "",
"data": [
{
"accountingStatus": "",
"activatedById": "",
"activatedTime": "",
"amount": 0,
"amountWithoutTax": 0,
"assets": [
{
"assetNumber": "",
"assetType": "",
"externalId": "",
"externalName": "",
"product": {
"autoRenew": false,
"billingTiming": "",
"bundleTemplate": "",
"carvesEligible": false,
"configurable": false,
"defaultRenewalTerm": 0,
"defaultSubscriptionTerm": 0,
"description": "",
"evergreen": false,
"freeTrialType": "",
"id": "",
"imageUrl": "",
"lastPublishedById": "",
"lastPublishedDate": "",
"name": "",
"priceBookEntries": [
{
"active": false,
"billingTiming": "",
"id": "",
"listPrice": 0,
"priceBookId": "",
"pricingAttributes": [
{}
],
"recommended": false,
"uom": {
"decimalScale": 0,
"id": "",
"name": "",
"quantityDimension": "",
"roundingMode": ""
}
}
],
"priceModel": "",
"productCategory": "",
"productFeatures": [
{}
],
"productOptions": [
{}
],
"productPriceTags": [
{}
],
"publishStatus": "",
"recordType": "",
"showIncludedProductOptions": false,
"sku": "",
"soldIndependently": false,
"startDate": "",
"status": "",
"uom": {}
},
"productId": ""
}
],
"balance": 0,
"billToContactId": "",
"createdById": "",
"createdDate": "",
"customerId": "",
"dueDate": "",
"endDate": "",
"externalInvoiceId": "",
"id": "",
"invoiceDate": "",
"isCatchUp": false,
"lastModifiedById": "",
"lastModifiedDate": "",
"name": "",
"orders": [
{}
],
"paymentDetails": "",
"paymentHostedUrl": "",
"paymentStatus": "",
"poDates": "",
"poNumbers": "",
"salesAccountId": "",
"shippingAndHandling": 0,
"source": "",
"startDate": "",
"status": "",
"targetDate": "",
"taxAmount": 0,
"taxStatus": ""
}
],
"warnings": [
{}
]
}