--- title: Update a Debit Memo slug: update-a-debit-memo docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "Zq5vxeSwXTB0xpkyqT_Wl", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.nue.io/billing/debit-memos:update", "servers": [ { "url": "https://api.nue.io/billing/debit-memos:update", "description": "Nue Production API Endpoint" }, { "url": "https://api.sandbox.nue.io/billing/debit-memos:update", "description": "Nue Sandbox API Endpoint" } ], "name": "Update a Debit Memo", "description": "Update a debit memo. ", "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" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "The request to update a debit memo.", "schema": [ { "name": "debitMemo", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "" }, { "name": "customerId", "kind": "required", "type": "string", "description": "" }, { "name": "amount", "kind": "required", "type": "string", "description": "" }, { "name": "startDate", "kind": "required", "type": "string", "description": "", "format": "date" }, { "name": "endDate", "kind": "required", "type": "string", "description": "", "format": "date" }, { "name": "taxAmount", "kind": "required", "type": "string", "description": "" }, { "name": "sourceId", "kind": "required", "type": "string", "description": "" }, { "name": "sourceType", "kind": "required", "type": "string", "description": "" }, { "name": "chargeReason", "kind": "required", "type": "string", "description": "" }, { "name": "status", "kind": "required", "type": "string", "description": "" }, { "name": "currencyCode", "kind": "required", "type": "string", "description": "" }, { "name": "description", "kind": "required", "type": "string", "description": "" } ] }, { "name": "notifyCrm", "kind": "required", "type": "boolean", "description": "" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "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 }, { "statusCode": "default", "description": "default response", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// default response\n{\n \"Id\": \"\",\n \"Customer Id\": \"\",\n \"Amount\": 0,\n \"Tax Amount\": 0,\n \"Start Date\": \"\",\n \"End Date\": \"\",\n \"Source Id\": \"\",\n \"Source Type\": \"\",\n \"Charge Reason\": \"\",\n \"Description\": \"\"\n}" }, { "label": "Response", "code": "{\n \"id\": \"838e8a7b-2568-49eb-9b12-b536d2ba79b4\",\n \"customerId\": \"001DE0000344tTzYAI\",\n \"amount\": \"100\",\n \"startDate\": \"2023-02-02\",\n \"endDate\": \"2023-08-03\",\n \"taxAmount\": \"0\",\n \"sourceId\": \"1298c34f-98bc-46bb-8f5d-a757556e9b4b\",\n \"sourceType\": \"Invoice\",\n \"chargeReason\": \"LateFee\",\n \"status\": \"Active\",\n \"currencyCode\": \"USD\",\n \"description\": \"Late Fee\"\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "UpdateDebitMemoResponse", "schema": [ { "name": "Id", "kind": "optional", "type": "string", "description": "Debit memo ID.", "format": "uuid" }, { "name": "Customer Id", "kind": "optional", "type": "string", "description": "Customer ID." }, { "name": "Amount", "kind": "optional", "type": "number", "description": "Debit memo amount." }, { "name": "Tax Amount", "kind": "optional", "type": "number", "description": "Debit memo tax amount." }, { "name": "Start Date", "kind": "optional", "type": "string", "description": "Debit memo start date.", "format": "date" }, { "name": "End Date", "kind": "optional", "type": "string", "description": "Debit memo end date.", "format": "date" }, { "name": "Source Id", "kind": "optional", "type": "string", "description": "Source ID of debit memo" }, { "name": "Source Type", "kind": "optional", "type": "string", "description": "Source type of debit memo", "enum": [ "Invoice" ] }, { "name": "Charge Reason", "kind": "optional", "type": "string", "description": "Charge reason of debit memo", "enum": [ "LateFee", "AdditionalFee", "BillingDiscrepancies" ] }, { "name": "Description", "kind": "optional", "type": "string", "description": "Description of debit memo" } ], "modelRef": "#/components/schemas/UpdateDebitMemoResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "GP84jV9PEpgirQfF6c27Z", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.nue.io/billing/debit-memos:update \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"debitMemo\": {\n \"id\": \"\",\n \"customerId\": \"\",\n \"amount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"taxAmount\": \"\",\n \"sourceId\": \"\",\n \"sourceType\": \"\",\n \"chargeReason\": \"\",\n \"status\": \"\",\n \"currencyCode\": \"\",\n \"description\": \"\"\n },\n \"notifyCrm\": \"\"\n }'" }, { "id": "S8DOfXyU15SlV05KxPWfs", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"debitMemo\": {\n \"id\": \"\",\n \"customerId\": \"\",\n \"amount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"taxAmount\": \"\",\n \"sourceId\": \"\",\n \"sourceType\": \"\",\n \"chargeReason\": \"\",\n \"status\": \"\",\n \"currencyCode\": \"\",\n \"description\": \"\"\n },\n \"notifyCrm\": \"\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/billing/debit-memos:update\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "iI170DYPHfhiT4Vnu0Al4", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/billing/debit-memos:update\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"debitMemo\": {\n \"id\": \"\",\n \"customerId\": \"\",\n \"amount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"taxAmount\": \"\",\n \"sourceId\": \"\",\n \"sourceType\": \"\",\n \"chargeReason\": \"\",\n \"status\": \"\",\n \"currencyCode\": \"\",\n \"description\": \"\"\n },\n \"notifyCrm\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "18dtDbo3fxrK6pbXPAVQh", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/billing/debit-memos:update\"\n\npayload = json.dumps({\n \"debitMemo\": {\n \"id\": \"\",\n \"customerId\": \"\",\n \"amount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"taxAmount\": \"\",\n \"sourceId\": \"\",\n \"sourceType\": \"\",\n \"chargeReason\": \"\",\n \"status\": \"\",\n \"currencyCode\": \"\",\n \"description\": \"\"\n },\n \"notifyCrm\": \"\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "GP84jV9PEpgirQfF6c27Z" }, "results": { "languages": [ { "id": "Ir-8-in_A3ge6vSpYUv6i", "language": "400", "code": "// Bad Request\n{\n \"title\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\"\n}" }, { "id": "KcYOlOfLFiwvrGHYdwfIC", "language": "404", "code": "// Not Found\n" }, { "id": "lhkUBAaB9EiupDFe0XCwW", "language": "default", "code": "// default response\n{\n \"Id\": \"\",\n \"Customer Id\": \"\",\n \"Amount\": 0,\n \"Tax Amount\": 0,\n \"Start Date\": \"\",\n \"End Date\": \"\",\n \"Source Id\": \"\",\n \"Source Type\": \"\",\n \"Charge Reason\": \"\",\n \"Description\": \"\"\n}", "subExamples": [ { "label": "GENERATED", "code": "// default response\n{\n \"Id\": \"\",\n \"Customer Id\": \"\",\n \"Amount\": 0,\n \"Tax Amount\": 0,\n \"Start Date\": \"\",\n \"End Date\": \"\",\n \"Source Id\": \"\",\n \"Source Type\": \"\",\n \"Charge Reason\": \"\",\n \"Description\": \"\"\n}" }, { "label": "Response", "code": "{\n \"id\": \"838e8a7b-2568-49eb-9b12-b536d2ba79b4\",\n \"customerId\": \"001DE0000344tTzYAI\",\n \"amount\": \"100\",\n \"startDate\": \"2023-02-02\",\n \"endDate\": \"2023-08-03\",\n \"taxAmount\": \"0\",\n \"sourceId\": \"1298c34f-98bc-46bb-8f5d-a757556e9b4b\",\n \"sourceType\": \"Invoice\",\n \"chargeReason\": \"LateFee\",\n \"status\": \"Active\",\n \"currencyCode\": \"USD\",\n \"description\": \"Late Fee\"\n}" } ] } ], "selectedLanguageId": "Ir-8-in_A3ge6vSpYUv6i" } }, "children": [ { "text": "" } ] }