--- title: Fetch Invoices slug: fetch-invoices docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "lZCevHQgdphdH1QdjL7lk", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.nue.io/invoices", "servers": [ { "url": "https://api.nue.io/invoices", "description": "Nue Production API Endpoint" }, { "url": "https://api.sandbox.nue.io/invoices", "description": "Nue Sandbox API Endpoint" } ], "name": "Fetch Invoices", "description": "

Warning: Deprecated\nRetrieve invoices with flexible filtering, pagination, and data enrichment. Supports both global listing and customer-scoped filtering via customerIds parameter for backwards compatibility.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "nue-api-key", "type": "string", "description": "API key for authentication" } ], "queryParameters": [ { "kind": "optional", "name": "customerIds", "type": "string", "example": "[\"001KS00000DVz1aYAD\",\"002KS00000DVz1bYAD\"]", "description": "

JSON array of customer IDs. When provided, filters to specific customers. When omitted, returns global invoice listing.

" }, { "kind": "optional", "name": "customerId", "type": "string", "description": "Single customer ID for filtering" }, { "kind": "optional", "name": "paymentStatus", "type": "string", "description": "Filter by payment status", "enum": [ "NotTransferred", "Transferred", "TransferError", "Paid", "PartialPaid", "Canceled", "Refunded", "PartialRefunded", "WrittenOff", "PartiallyWrittenOff", "CreditBack", "Applied", "PartiallyApplied" ] }, { "kind": "optional", "name": "status", "type": "string", "description": "Filter by invoice status", "enum": [ "Draft", "Active", "Canceled", "PendingActivation", "E-Invoicing" ] }, { "kind": "optional", "name": "includes", "type": "string", "example": "assets,orders,paymentApplications", "description": "

Include related data (comma-separated). Options: assets, orders, paymentApplications

", "enum": [ "assets", "orders", "paymentApplications", "assets,orders", "assets,paymentApplications", "orders,paymentApplications", "assets,orders,paymentApplications" ] } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful retrieval of customer invoices.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "data", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "accountingStatus", "kind": "optional", "type": "string", "description": "" }, { "name": "activatedById", "kind": "optional", "type": "string", "description": "" }, { "name": "activatedTime", "kind": "optional", "type": "string", "description": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "" }, { "name": "amountWithoutTax", "kind": "optional", "type": "number", "description": "" }, { "name": "assets", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "assetNumber", "kind": "optional", "type": "string", "description": "" }, { "name": "assetType", "kind": "optional", "type": "string", "description": "" }, { "name": "externalId", "kind": "optional", "type": "string", "description": "" }, { "name": "externalName", "kind": "optional", "type": "string", "description": "" }, { "name": "product", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "autoRenew", "kind": "optional", "type": "boolean", "description": "" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "" }, { "name": "bundleTemplate", "kind": "optional", "type": "string", "description": "" }, { "name": "carvesEligible", "kind": "optional", "type": "boolean", "description": "" }, { "name": "configurable", "kind": "optional", "type": "boolean", "description": "" }, { "name": "defaultRenewalTerm", "kind": "optional", "type": "number", "description": "" }, { "name": "defaultSubscriptionTerm", "kind": "optional", "type": "number", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "evergreen", "kind": "optional", "type": "boolean", "description": "" }, { "name": "freeTrialType", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "imageUrl", "kind": "optional", "type": "string", "description": "" }, { "name": "lastPublishedById", "kind": "optional", "type": "string", "description": "" }, { "name": "lastPublishedDate", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "priceBookEntries", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "active", "kind": "optional", "type": "boolean", "description": "" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "listPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "priceBookId", "kind": "optional", "type": "string", "description": "" }, { "name": "pricingAttributes", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "recommended", "kind": "optional", "type": "boolean", "description": "" }, { "name": "uom", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "decimalScale", "kind": "optional", "type": "number", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "quantityDimension", "kind": "optional", "type": "string", "description": "" }, { "name": "roundingMode", "kind": "optional", "type": "string", "description": "" } ] } ] }, { "name": "priceModel", "kind": "optional", "type": "string", "description": "" }, { "name": "productCategory", "kind": "optional", "type": "string", "description": "" }, { "name": "productFeatures", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "productOptions", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "productPriceTags", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "publishStatus", "kind": "optional", "type": "string", "description": "" }, { "name": "recordType", "kind": "optional", "type": "string", "description": "" }, { "name": "showIncludedProductOptions", "kind": "optional", "type": "boolean", "description": "" }, { "name": "sku", "kind": "optional", "type": "string", "description": "" }, { "name": "soldIndependently", "kind": "optional", "type": "boolean", "description": "" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "uom", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] } ] }, { "name": "productId", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "balance", "kind": "optional", "type": "number", "description": "" }, { "name": "billToContactId", "kind": "optional", "type": "string", "description": "" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "" }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "" }, { "name": "dueDate", "kind": "optional", "type": "string", "description": "" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "" }, { "name": "externalInvoiceId", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "invoiceDate", "kind": "optional", "type": "string", "description": "" }, { "name": "isCatchUp", "kind": "optional", "type": "boolean", "description": "" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "orders", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "paymentDetails", "kind": "optional", "type": "string", "description": "" }, { "name": "paymentHostedUrl", "kind": "optional", "type": "string", "description": "" }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "" }, { "name": "poDates", "kind": "optional", "type": "string", "description": "" }, { "name": "poNumbers", "kind": "optional", "type": "string", "description": "" }, { "name": "salesAccountId", "kind": "optional", "type": "string", "description": "" }, { "name": "shippingAndHandling", "kind": "optional", "type": "number", "description": "" }, { "name": "source", "kind": "optional", "type": "string", "description": "" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "targetDate", "kind": "optional", "type": "string", "description": "" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "taxStatus", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "warnings", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "deprecated": true, "examples": { "languages": [ { "id": "ul2s_tfRGDnX0eua4_vzv", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.nue.io/invoices \\\n --header 'accept: application/json' \\\n --header 'nue-api-key: string'" }, { "id": "3Il0lOdi0F363F8Wda7MB", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"nue-api-key\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/invoices\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "kprjdnVzkRtv6vrCNyigX", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/invoices\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"nue-api-key\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "uXzndE1KvgolMpjLznsEC", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/invoices\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'nue-api-key': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "ul2s_tfRGDnX0eua4_vzv" }, "results": { "languages": [ { "id": "x88MtGgiMSM8-_ZOkb-3w", "language": "200", "code": "// Successful retrieval of customer invoices.\n{\n \"status\": \"\",\n \"data\": [\n {\n \"accountingStatus\": \"\",\n \"activatedById\": \"\",\n \"activatedTime\": \"\",\n \"amount\": 0,\n \"amountWithoutTax\": 0,\n \"assets\": [\n {\n \"assetNumber\": \"\",\n \"assetType\": \"\",\n \"externalId\": \"\",\n \"externalName\": \"\",\n \"product\": {\n \"autoRenew\": false,\n \"billingTiming\": \"\",\n \"bundleTemplate\": \"\",\n \"carvesEligible\": false,\n \"configurable\": false,\n \"defaultRenewalTerm\": 0,\n \"defaultSubscriptionTerm\": 0,\n \"description\": \"\",\n \"evergreen\": false,\n \"freeTrialType\": \"\",\n \"id\": \"\",\n \"imageUrl\": \"\",\n \"lastPublishedById\": \"\",\n \"lastPublishedDate\": \"\",\n \"name\": \"\",\n \"priceBookEntries\": [\n {\n \"active\": false,\n \"billingTiming\": \"\",\n \"id\": \"\",\n \"listPrice\": 0,\n \"priceBookId\": \"\",\n \"pricingAttributes\": [\n {}\n ],\n \"recommended\": false,\n \"uom\": {\n \"decimalScale\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"quantityDimension\": \"\",\n \"roundingMode\": \"\"\n }\n }\n ],\n \"priceModel\": \"\",\n \"productCategory\": \"\",\n \"productFeatures\": [\n {}\n ],\n \"productOptions\": [\n {}\n ],\n \"productPriceTags\": [\n {}\n ],\n \"publishStatus\": \"\",\n \"recordType\": \"\",\n \"showIncludedProductOptions\": false,\n \"sku\": \"\",\n \"soldIndependently\": false,\n \"startDate\": \"\",\n \"status\": \"\",\n \"uom\": {}\n },\n \"productId\": \"\"\n }\n ],\n \"balance\": 0,\n \"billToContactId\": \"\",\n \"createdById\": \"\",\n \"createdDate\": \"\",\n \"customerId\": \"\",\n \"dueDate\": \"\",\n \"endDate\": \"\",\n \"externalInvoiceId\": \"\",\n \"id\": \"\",\n \"invoiceDate\": \"\",\n \"isCatchUp\": false,\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"name\": \"\",\n \"orders\": [\n {}\n ],\n \"paymentDetails\": \"\",\n \"paymentHostedUrl\": \"\",\n \"paymentStatus\": \"\",\n \"poDates\": \"\",\n \"poNumbers\": \"\",\n \"salesAccountId\": \"\",\n \"shippingAndHandling\": 0,\n \"source\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"targetDate\": \"\",\n \"taxAmount\": 0,\n \"taxStatus\": \"\"\n }\n ],\n \"warnings\": [\n {}\n ]\n}" } ], "selectedLanguageId": "x88MtGgiMSM8-_ZOkb-3w" } }, "children": [ { "text": "" } ] }