--- title: Get Credit Memos by Invoice Id slug: get-credit-memos-by-invoice-id docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "RMyGdPVfJ3unjZjI2fege", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.nue.io/billing/invoices/{invoiceId}/credit-memos", "servers": [ { "url": "https://api.nue.io/billing/invoices/{invoiceId}/credit-memos", "description": "Nue Production API Endpoint" }, { "url": "https://api.sandbox.nue.io/billing/invoices/{invoiceId}/credit-memos", "description": "Nue Sandbox API Endpoint" } ], "name": "Get Credit Memos by Invoice Id", "description": "Search credit memos by applied invoice Id", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "invoiceId", "type": "string", "description": "", "format": "uuid" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "*/*" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "creditMemos", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "activatedById", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "salesAccountId", "kind": "optional", "type": "string", "description": "" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "", "format": "date" }, { "name": "dueDate", "kind": "optional", "type": "string", "description": "", "format": "date" }, { "name": "creditMemoPdf", "kind": "optional", "type": "string", "description": "" }, { "name": "source", "kind": "optional", "type": "string", "description": "" }, { "name": "taxStatus", "kind": "optional", "type": "string", "description": "" }, { "name": "shippingAndHandling", "kind": "optional", "type": "number", "description": "" }, { "name": "balance", "kind": "optional", "type": "number", "description": "" }, { "name": "vatMessages", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "billToContactId", "kind": "optional", "type": "string", "description": "" }, { "name": "einvoicingMandateId", "kind": "optional", "type": "string", "description": "" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "taxCompanyCode", "kind": "optional", "type": "string", "description": "" }, { "name": "salesAccount", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "einvoicingDocStatus", "kind": "optional", "type": "string", "description": "" }, { "name": "appliedByObject", "kind": "optional", "type": "string", "description": "" }, { "name": "targetDate", "kind": "optional", "type": "string", "description": "", "format": "date" }, { "name": "activatedBy", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "isCatchUp", "kind": "optional", "type": "boolean", "description": "" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "", "format": "date" }, { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "poNumbers", "kind": "optional", "type": "string", "description": "" }, { "name": "taxErrorMessage", "kind": "optional", "type": "string", "description": "" }, { "name": "poDates", "kind": "optional", "type": "string", "description": "" }, { "name": "appliedById", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "" }, { "name": "creditMemoDate", "kind": "optional", "type": "string", "description": "", "format": "date" }, { "name": "paymentDetails", "kind": "optional", "type": "string", "description": "" }, { "name": "billToContact", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "paymentStatus", "kind": "optional", "type": "string", "description": "" }, { "name": "einvoicingMessage", "kind": "optional", "type": "string", "description": "" }, { "name": "cancellationDate", "kind": "optional", "type": "string", "description": "" }, { "name": "amountWithoutTax", "kind": "optional", "type": "number", "description": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "" }, { "name": "comments", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "entityId", "kind": "optional", "type": "string", "description": "" }, { "name": "einvoicingMandateCode", "kind": "optional", "type": "string", "description": "" }, { "name": "accountingStatus", "kind": "optional", "type": "string", "description": "" }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "activatedTime", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "externalCreditMemoId", "kind": "optional", "type": "string", "description": "" }, { "name": "einvoicingDocId", "kind": "optional", "type": "string", "description": "" }, { "name": "entity", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "customer", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" } ] } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "G8hEHDkibcejOa-kSsWve", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.nue.io/billing/invoices/{invoiceId}/credit-memos \\\n --header 'accept: application/json'" }, { "id": "OtDXblQbt3aE3GmtXFg4T", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/billing/invoices/{invoiceId}/credit-memos\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "bT7UTMiOO9DxTD0oqX_LB", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/billing/invoices/{invoiceId}/credit-memos\")\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\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "1Vc3ROmamYCcLkQKoOJnM", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/billing/invoices/{invoiceId}/credit-memos\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "G8hEHDkibcejOa-kSsWve" }, "results": { "languages": [ { "id": "X43EmCHYhMnV3yPrnM1K_", "language": "200", "code": "// OK\n{\n \"creditMemos\": [\n {\n \"activatedById\": \"\",\n \"salesAccountId\": \"\",\n \"endDate\": \"\",\n \"dueDate\": \"\",\n \"creditMemoPdf\": \"\",\n \"source\": \"\",\n \"taxStatus\": \"\",\n \"shippingAndHandling\": 0,\n \"balance\": 0,\n \"vatMessages\": \"\",\n \"id\": \"\",\n \"billToContactId\": \"\",\n \"einvoicingMandateId\": \"\",\n \"createdById\": \"\",\n \"taxCompanyCode\": \"\",\n \"salesAccount\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"einvoicingDocStatus\": \"\",\n \"appliedByObject\": \"\",\n \"targetDate\": \"\",\n \"activatedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"taxAmount\": 0,\n \"isCatchUp\": false,\n \"startDate\": \"\",\n \"status\": \"\",\n \"poNumbers\": \"\",\n \"taxErrorMessage\": \"\",\n \"poDates\": \"\",\n \"appliedById\": \"\",\n \"lastModifiedById\": \"\",\n \"customerId\": \"\",\n \"creditMemoDate\": \"\",\n \"paymentDetails\": \"\",\n \"billToContact\": {},\n \"paymentStatus\": \"\",\n \"einvoicingMessage\": \"\",\n \"cancellationDate\": \"\",\n \"amountWithoutTax\": 0,\n \"amount\": 0,\n \"comments\": \"\",\n \"lastModifiedDate\": \"\",\n \"lastModifiedBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"entityId\": \"\",\n \"einvoicingMandateCode\": \"\",\n \"accountingStatus\": \"\",\n \"createdDate\": \"\",\n \"createdBy\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"activatedTime\": \"\",\n \"externalCreditMemoId\": \"\",\n \"einvoicingDocId\": \"\",\n \"entity\": {},\n \"customer\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ]\n}" }, { "id": "xK5h0HMOOHh-a7LEf8wel", "language": "400", "code": "// Bad Request\n{\n \"title\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\"\n}" }, { "id": "BvH61d8B6BfFOqeGAiwEd", "language": "404", "code": "// Not Found\n" } ], "selectedLanguageId": "X43EmCHYhMnV3yPrnM1K_" } }, "children": [ { "text": "" } ] }