---
title: Update Credit Memo Fields
slug: update-credit-memo-fields
docTags:
createdAt: 2026-08-25T19:28:59.170Z
---
{
"id": "qp7shd0KY9BAxTfAMkw1I",
"type": "api-oas-v2",
"data": {
"method": "PATCH",
"url": "https://api.nue.io/billing/credit-memos/{creditMemoId}",
"servers": [
{
"url": "https://api.nue.io/billing/credit-memos/{creditMemoId}",
"description": "Nue Production API Endpoint"
},
{
"url": "https://api.sandbox.nue.io/billing/credit-memos/{creditMemoId}",
"description": "Nue Sandbox API Endpoint"
}
],
"name": "Update Credit Memo Fields",
"description": "Update credit memo non-monetary properties and custom field data. Valid statuses: 'Draft', 'Pending Activation' and 'Active'.
",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "creditMemoId",
"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": [
{
"kind": "required",
"name": "body",
"type": "object",
"description": "",
"customType": "map",
"schema": [
{
"name": "creditMemoDate",
"kind": "optional",
"type": "string",
"description": "Specify credit memo date, example = '2023-01-10'
",
"format": "date"
},
{
"name": "paymentDetails",
"kind": "optional",
"type": "string",
"description": "Payment details"
},
{
"name": "billToContactId",
"kind": "optional",
"type": "string",
"description": "Bill to contact ID"
}
],
"isExpanded": true
}
],
"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": "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": "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": "einvoicingDocStatus",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "appliedByObject",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "targetDate",
"kind": "optional",
"type": "string",
"description": "",
"format": "date"
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "externalTaxId",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "currencyIsoCode",
"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": "syncTime",
"kind": "optional",
"type": "string",
"description": "",
"format": "date-time"
},
{
"name": "poNumbers",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "customFields",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "poDates",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "taxErrorMessage",
"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": "paymentDetails",
"kind": "optional",
"type": "string",
"description": ""
},
{
"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": "recordType",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "einvoicingMandateCode",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "entityId",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "invoiceDate",
"kind": "optional",
"type": "string",
"description": "",
"format": "date"
},
{
"name": "accountingStatus",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "invoicePdf",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "paymentHostedUrl",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "createdDate",
"kind": "optional",
"type": "string",
"description": "",
"format": "date-time"
},
{
"name": "activatedTime",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "tenantId",
"kind": "optional",
"type": "string",
"description": "",
"format": "uuid"
},
{
"name": "externalInvoiceId",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "einvoicingDocId",
"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": "kqmP6sl0cbLXZsks5w8V9",
"language": "curl",
"label": "cURL",
"code": "curl --request PATCH \\\n --url https://api.nue.io/billing/credit-memos/{creditMemoId} \\\n --header 'accept: application/json'"
},
{
"id": "t2KrF9mDF9sgGih5ru6Uf",
"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: 'PATCH',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/billing/credit-memos/{creditMemoId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "Q9_Yegh6dZXkfu0x-r7-w",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/billing/credit-memos/{creditMemoId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "C4vJkydpepLQIAGR3DC7G",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.nue.io/billing/credit-memos/{creditMemoId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "kqmP6sl0cbLXZsks5w8V9"
},
"results": {
"languages": [
{
"id": "1dRx_us3MkP01NxG48zSH",
"language": "200",
"code": "// OK\n{\n \"activatedById\": \"\",\n \"salesAccountId\": \"\",\n \"endDate\": \"\",\n \"dueDate\": \"\",\n \"source\": \"\",\n \"taxStatus\": \"\",\n \"shippingAndHandling\": 0,\n \"balance\": 0,\n \"vatMessages\": \"\",\n \"id\": \"\",\n \"billToContactId\": \"\",\n \"einvoicingMandateId\": \"\",\n \"createdById\": \"\",\n \"taxCompanyCode\": \"\",\n \"einvoicingDocStatus\": \"\",\n \"appliedByObject\": \"\",\n \"targetDate\": \"\",\n \"name\": \"\",\n \"externalTaxId\": \"\",\n \"currencyIsoCode\": \"\",\n \"taxAmount\": 0,\n \"isCatchUp\": false,\n \"startDate\": \"\",\n \"status\": \"\",\n \"syncTime\": \"\",\n \"poNumbers\": \"\",\n \"customFields\": \"\",\n \"poDates\": \"\",\n \"taxErrorMessage\": \"\",\n \"appliedById\": \"\",\n \"lastModifiedById\": \"\",\n \"customerId\": \"\",\n \"paymentDetails\": \"\",\n \"paymentStatus\": \"\",\n \"einvoicingMessage\": \"\",\n \"cancellationDate\": \"\",\n \"amountWithoutTax\": 0,\n \"amount\": 0,\n \"comments\": \"\",\n \"lastModifiedDate\": \"\",\n \"recordType\": \"\",\n \"einvoicingMandateCode\": \"\",\n \"entityId\": \"\",\n \"invoiceDate\": \"\",\n \"accountingStatus\": \"\",\n \"invoicePdf\": \"\",\n \"paymentHostedUrl\": \"\",\n \"createdDate\": \"\",\n \"activatedTime\": \"\",\n \"tenantId\": \"\",\n \"externalInvoiceId\": \"\",\n \"einvoicingDocId\": \"\"\n}"
},
{
"id": "Polis6KmgHzgF570u3koz",
"language": "400",
"code": "// Bad Request\n{\n \"title\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\"\n}"
},
{
"id": "YGgfry0cn52ou_kcW7j9K",
"language": "404",
"code": "// Not Found\n"
}
],
"selectedLanguageId": "1dRx_us3MkP01NxG48zSH"
}
},
"children": [
{
"text": ""
}
]
}