---
title: Fetch Credit Memos
slug: fetch-credit-memos
docTags: 
createdAt: 2026-08-25T19:28:59.170Z
---

{
  "id": "hhRf-NfDF7iEcqoNv-ZF1",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.nue.io/credit-memos",
    "servers": [
      {
        "url": "https://api.nue.io/credit-memos",
        "description": "Nue Production API Endpoint"
      },
      {
        "url": "https://api.sandbox.nue.io/credit-memos",
        "description": "Nue Sandbox API Endpoint"
      }
    ],
    "name": "Fetch Credit Memos",
    "description": "<p>Warning: Deprecated\nRetrieve credit memos with flexible filtering, pagination, and data enrichment. Supports both global listing and customer-scoped filtering.</p>",
    "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",
          "description": "JSON array of customer IDs for backwards compatibility"
        },
        {
          "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",
            "Applied",
            "PartiallyApplied",
            "Paid",
            "PartialPaid",
            "Refunded",
            "PartialRefunded",
            "WrittenOff",
            "PartiallyWrittenOff",
            "Canceled",
            "CreditBack"
          ]
        },
        {
          "kind": "optional",
          "name": "status",
          "type": "string",
          "description": "Filter by credit memo status",
          "enum": [
            "Draft",
            "Active",
            "Canceled",
            "PendingActivation",
            "E-Invoicing"
          ]
        },
        {
          "kind": "optional",
          "name": "source",
          "type": "string",
          "description": "Filter by creation source",
          "enum": [
            "Billing",
            "CreditConversion",
            "PaymentOperation",
            "Standalone",
            "GenerateFromTransaction"
          ]
        },
        {
          "kind": "optional",
          "name": "includes",
          "type": "string",
          "description": "<p>Include related data (comma-separated)</p>",
          "enum": [
            "assets",
            "orders",
            "assets,orders",
            "orders,assets"
          ]
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Successfully retrieved credit memo data",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "string<SUCCESS | PARTIAL_SUCCESS | FAILURE>",
                "description": "",
                "enum": [
                  "SUCCESS",
                  "PARTIAL_SUCCESS",
                  "FAILURE"
                ]
              },
              {
                "name": "data",
                "kind": "optional",
                "type": "array",
                "description": "",
                "example": "",
                "itemType": "object",
                "customType": "object[]",
                "schema": [
                  {
                    "name": "id",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "name",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "customerId",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "amount",
                    "kind": "optional",
                    "type": "number",
                    "description": ""
                  },
                  {
                    "name": "balance",
                    "kind": "optional",
                    "type": "number",
                    "description": ""
                  },
                  {
                    "name": "status",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "paymentStatus",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "source",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "creditMemoDate",
                    "kind": "optional",
                    "type": "string<date>",
                    "description": "",
                    "format": "date"
                  }
                ]
              },
              {
                "name": "pagination",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "page",
                    "kind": "optional",
                    "type": "integer",
                    "description": ""
                  },
                  {
                    "name": "limit",
                    "kind": "optional",
                    "type": "integer",
                    "description": ""
                  },
                  {
                    "name": "total",
                    "kind": "optional",
                    "type": "integer",
                    "description": ""
                  },
                  {
                    "name": "hasNext",
                    "kind": "optional",
                    "type": "boolean",
                    "description": ""
                  },
                  {
                    "name": "hasPrevious",
                    "kind": "optional",
                    "type": "boolean",
                    "description": ""
                  }
                ]
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "deprecated": true,
    "examples": {
      "languages": [
        {
          "id": "3KNEX7R9Nek2L0YNeK6Q7",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.nue.io/credit-memos \\\n     --header 'accept: application/json' \\\n     --header 'nue-api-key: string'"
        },
        {
          "id": "GT8M4LlTvBEJoSge2eq0w",
          "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/credit-memos\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "m6TJE1jBvkVrKD7n5Ys7j",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/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\"\nrequest[\"nue-api-key\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "N9Aehro2b__QTVBeA26me",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/credit-memos\"\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": "3KNEX7R9Nek2L0YNeK6Q7"
    },
    "results": {
      "languages": [
        {
          "id": "WGyrIZaKcrUpJBk48hrkI",
          "language": "200",
          "code": "// Successfully retrieved credit memo data\n{\n  \"status\": \"\",\n  \"data\": [\n    {\n      \"id\": \"\",\n      \"name\": \"\",\n      \"customerId\": \"\",\n      \"amount\": 0,\n      \"balance\": 0,\n      \"status\": \"\",\n      \"paymentStatus\": \"\",\n      \"source\": \"\",\n      \"creditMemoDate\": \"\"\n    }\n  ],\n  \"pagination\": {\n    \"page\": 0,\n    \"limit\": 0,\n    \"total\": 0,\n    \"hasNext\": false,\n    \"hasPrevious\": false\n  }\n}"
        }
      ],
      "selectedLanguageId": "WGyrIZaKcrUpJBk48hrkI"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}