Create or update a standalone credit memo. If the header.id or items.id is provided, the endpoint will update the corresponding credit memo or credit memo item; otherwise it will create a new one. Setting activateCreditMemoNow to true will immediately activate the credit 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" }, { "kind": "required", "name": "nue-api-key", "type": "string", "description": "" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "example": "{\"header\":{\"customerId\":\"001Ru00000JTE3hIAQ\",\"salesAccountId\":\"001Ru00000JTE3hIAE\",\"billToContactId\":\"001Ru00000JTE3hIAF\",\"creditMemoDate\":\"2025-04-25\",\"amount\":470,\"taxAmount\":10,\"Ruby__Kaiyu_Test__c\":66.66},\"items\":[{\"productId\":\"01tH3000001OV7xIAG\",\"productName\":\"Nue Platform\",\"transactionDate\":\"2025-04-25\",\"taxAmount\":5,\"transactionQuantity\":1,\"transactionAmount\":300,\"Ruby__Kaiyu_Test__c\":\"vvvvvvv\"},{\"productId\":\"01tH3000001OV7xIAG\",\"productName\":\"Nue Platform\",\"transactionDate\":\"2025-04-25\",\"taxAmount\":5,\"transactionQuantity\":1,\"transactionAmount\":170,\"Ruby__Kaiyu_Test__c\":\"qqqqqq\"}],\"deleteItemIds\":[\"299a972b-ad53-4a1a-8d7a-6b441224e54f\"],\"activateCreditMemoNow\":true}", "description": "", "schema": [ { "name": "header", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "stringCredit memo ID. If provided, the endpoint will update the existing credit memo; otherwise it will create a new one.
", "format": "uuid" }, { "name": "customerId", "kind": "required", "type": "string", "description": "ID of the customer for this credit memo" }, { "name": "salesAccountId", "kind": "optional", "type": "string", "description": "ID of the sales account" }, { "name": "billToContactId", "kind": "optional", "type": "string", "description": "ID of the bill-to contact
" }, { "name": "creditMemoDate", "kind": "required", "type": "stringThe credit memo date in YYYY-MM-DD format
", "format": "date" }, { "name": "amount", "kind": "required", "type": "number", "description": "Total amount of the credit memo" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "Total tax amount of the credit memo" } ] }, { "name": "items", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "stringCredit memo item ID. If provided, the endpoint will update the existing credit memo item; otherwise it will create a new one.
", "format": "uuid" }, { "name": "productId", "kind": "required", "type": "string", "description": "ID of the product for this credit memo item" }, { "name": "productName", "kind": "optional", "type": "string", "description": "Name of the product" }, { "name": "transactionDate", "kind": "required", "type": "stringTransaction date for this item in YYYY-MM-DD format
", "format": "date" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "Tax amount for this item" }, { "name": "transactionQuantity", "kind": "required", "type": "number", "description": "Quantity of products for this transaction" }, { "name": "transactionAmount", "kind": "required", "type": "number", "description": "Transaction amount for this item" } ] }, { "name": "deleteItemIds", "kind": "optional", "type": "array", "description": "IDs of credit memo items to delete", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "activateCreditMemoNow", "kind": "optional", "type": "boolean", "description": "If true, the credit memo will be activated immediately
" } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successfully created or updated the credit memo", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"status\":\"SUCCESS\",\"data\":{\"id\":\"fa293389-9ce0-48b0-a6e1-e01b5fe6f48e\",\"name\":\"CM-00000945\",\"customerId\":\"001Ru00000JTE3hIAQ\",\"salesAccountId\":\"001Ru00000JTE3hIAQ\",\"billToContactId\":\"001Ru00000JTE3hIAF\",\"creditMemoDate\":\"2025-04-25\",\"amount\":470,\"amountWithoutTax\":480,\"taxAmount\":10,\"balance\":470,\"status\":\"Active\",\"source\":\"Standalone\",\"startDate\":\"2025-07-16\",\"dueDate\":\"2999-12-31\",\"creditMemoPdf\":\"http://localhost:3000/view-credit-memo/BECYgFqPPICiqJ5croAorgtcbv4fBjjnsmAuO900TMEpJRACXQZWCYmDaGoyTe0c1Klz2cv-_42R10oa6-BJSlfqwhYyGszR4VwgqFwmVuHU0D_5wIR305zWPlczEmCiISCKWfkkQ11gU8e0A5R6jLwpXzHzQIT3RnAINO3RcgqlpCrmIOKjgvLFTehLjFyW5l1OUD07zw=\",\"createdDate\":\"2025-07-16T04:17:38.687Z\",\"createdById\":\"e47ab877-f02b-48d5-a82c-0a79785e7c25\",\"lastModifiedDate\":\"2025-07-16T04:17:44.319Z\",\"lastModifiedById\":\"e47ab877-f02b-48d5-a82c-0a79785e7c25\",\"activatedTime\":\"2025-07-16T04:17:43.761Z\",\"activatedById\":\"e47ab877-f02b-48d5-a82c-0a79785e7c25\",\"taxStatus\":\"Not Calculated\",\"paymentStatus\":\"NotTransferred\",\"accountingStatus\":null,\"Ruby__Kaiyu_Test__c\":67,\"creditMemoItems\":[{\"id\":\"92c715da-5044-4986-bfc9-3bea6471377a\",\"name\":\"CMI-00005594\",\"creditMemoId\":\"fa293389-9ce0-48b0-a6e1-e01b5fe6f48e\",\"creditMemoNumber\":\"CM-00000945\",\"productId\":\"01tH3000001OV7xIAG\",\"productName\":\"Nue Platform\",\"accountId\":\"001Ru00000JTE3hIAQ\",\"salesAccountId\":\"001Ru00000JTE3hIAQ\",\"transactionDate\":\"2025-04-25\",\"startDate\":\"2025-07-16\",\"endDate\":null,\"transactionQuantity\":1,\"transactionAmount\":300,\"transactionAmountWithoutTax\":295,\"taxAmount\":5,\"balance\":300,\"appliedCredits\":0,\"ratedCredits\":0,\"paymentStatus\":\"NotTransferred\",\"createdDate\":\"2025-07-16T12:17:43.686+08:00\",\"createdById\":\"e47ab877-f02b-48d5-a82c-0a79785e7c25\",\"lastModifiedDate\":\"2025-07-16T12:17:44.332+08:00\",\"lastModifiedById\":\"e47ab877-f02b-48d5-a82c-0a79785e7c25\",\"uomId\":\"a0tH3000000Lsl6IAC\",\"billingTiming\":\"In Advance\",\"isCatchUp\":false,\"Ruby__Kaiyu_Test__c\":\"vvvvvvv\"},{\"id\":\"b9b3f58d-b4a8-4b45-b5be-19a40b304fda\",\"name\":\"CMI-00005595\",\"creditMemoId\":\"fa293389-9ce0-48b0-a6e1-e01b5fe6f48e\",\"creditMemoNumber\":\"CM-00000945\",\"productId\":\"01tH3000001OV7xIAG\",\"productName\":\"Nue Platform\",\"accountId\":\"001Ru00000JTE3hIAQ\",\"salesAccountId\":\"001Ru00000JTE3hIAQ\",\"transactionDate\":\"2025-04-25\",\"startDate\":\"2025-07-16\",\"endDate\":null,\"transactionQuantity\":1,\"transactionAmount\":170,\"transactionAmountWithoutTax\":165,\"taxAmount\":5,\"balance\":170,\"appliedCredits\":0,\"ratedCredits\":0,\"paymentStatus\":\"NotTransferred\",\"createdDate\":\"2025-07-16T12:17:43.692+08:00\",\"createdById\":\"e47ab877-f02b-48d5-a82c-0a79785e7c25\",\"lastModifiedDate\":\"2025-07-16T12:17:44.332+08:00\",\"lastModifiedById\":\"e47ab877-f02b-48d5-a82c-0a79785e7c25\",\"uomId\":\"a0tH3000000Lsl6IAC\",\"billingTiming\":\"In Advance\",\"isCatchUp\":false,\"Ruby__Kaiyu_Test__c\":\"qqqqqq\"}]},\"warnings\":[]}", "description": "", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "", "example": "SUCCESS" }, { "name": "data", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "stringCredit memo name/number
" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "Customer ID" }, { "name": "salesAccountId", "kind": "optional", "type": "string", "description": "Sales account ID" }, { "name": "billToContactId", "kind": "optional", "type": "string", "description": "Bill-to contact ID
" }, { "name": "creditMemoDate", "kind": "optional", "type": "stringStatus of the credit memo (Draft, Active, Canceled)
" }, { "name": "source", "kind": "optional", "type": "string", "description": "Source of the credit memo" }, { "name": "startDate", "kind": "optional", "type": "stringCredit memo item name/number
" }, { "name": "creditMemoId", "kind": "optional", "type": "stringIndicates if this is a catch-up item
" } ] } ] }, { "name": "warnings", "kind": "optional", "type": "array", "description": "Warning messages if any", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request - Invalid input parameters
", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Unauthorized - Invalid or missing API key
", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "-bNQ1zRSdLi2G1xIT7wYh", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.nue.io/billing/credit-memos/standalone:upsert \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'nue-api-key: string' \\\n --data '{\n \"header\": {\n \"customerId\": \"\",\n \"creditMemoDate\": \"\",\n \"amount\": \"\"\n },\n \"items\": [\n {\n \"productId\": \"\",\n \"transactionDate\": \"\",\n \"transactionQuantity\": \"\",\n \"transactionAmount\": \"\"\n }\n ]\n }'" }, { "id": "ePE3AN6-oRXaPTQbZQ7As", "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 raw = JSON.stringify({\n \"header\": {\n \"customerId\": \"\",\n \"creditMemoDate\": \"\",\n \"amount\": \"\"\n },\n \"items\": [\n {\n \"productId\": \"\",\n \"transactionDate\": \"\",\n \"transactionQuantity\": \"\",\n \"transactionAmount\": \"\"\n }\n ]\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/billing/credit-memos/standalone:upsert\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "NV9ZQq8rqJMMIAlB1iMAC", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/billing/credit-memos/standalone:upsert\")\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[\"nue-api-key\"] = \"string\"\nrequest.body = JSON.dump({\n \"header\": {\n \"customerId\": \"\",\n \"creditMemoDate\": \"\",\n \"amount\": \"\"\n },\n \"items\": [\n {\n \"productId\": \"\",\n \"transactionDate\": \"\",\n \"transactionQuantity\": \"\",\n \"transactionAmount\": \"\"\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "VdSi0AwCDO8rzmr-bdr-i", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/billing/credit-memos/standalone:upsert\"\n\npayload = json.dumps({\n \"header\": {\n \"customerId\": \"\",\n \"creditMemoDate\": \"\",\n \"amount\": \"\"\n },\n \"items\": [\n {\n \"productId\": \"\",\n \"transactionDate\": \"\",\n \"transactionQuantity\": \"\",\n \"transactionAmount\": \"\"\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'nue-api-key': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "-bNQ1zRSdLi2G1xIT7wYh" }, "results": { "languages": [ { "id": "axMMYbbpZ8KPwsEFjntg_", "language": "200", "code": "// Successfully created or updated the credit memo\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"customerId\": \"\",\n \"salesAccountId\": \"\",\n \"billToContactId\": \"\",\n \"creditMemoDate\": \"\",\n \"amount\": 0,\n \"amountWithoutTax\": 0,\n \"taxAmount\": 0,\n \"balance\": 0,\n \"status\": \"\",\n \"source\": \"\",\n \"startDate\": \"\",\n \"dueDate\": \"\",\n \"creditMemoPdf\": \"\",\n \"createdDate\": \"\",\n \"createdById\": \"\",\n \"lastModifiedDate\": \"\",\n \"lastModifiedById\": \"\",\n \"activatedTime\": \"\",\n \"activatedById\": \"\",\n \"taxStatus\": \"\",\n \"paymentStatus\": \"\",\n \"accountingStatus\": \"\",\n \"creditMemoItems\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"creditMemoId\": \"\",\n \"creditMemoNumber\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"accountId\": \"\",\n \"salesAccountId\": \"\",\n \"transactionDate\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"transactionQuantity\": 0,\n \"transactionAmount\": 0,\n \"transactionAmountWithoutTax\": 0,\n \"taxAmount\": 0,\n \"balance\": 0,\n \"appliedCredits\": 0,\n \"ratedCredits\": 0,\n \"paymentStatus\": \"\",\n \"createdDate\": \"\",\n \"createdById\": \"\",\n \"lastModifiedDate\": \"\",\n \"lastModifiedById\": \"\",\n \"uomId\": \"\",\n \"billingTiming\": \"\",\n \"isCatchUp\": false\n }\n ]\n },\n \"warnings\": [\n \"\"\n ]\n}" }, { "id": "2lvNnc3C6VeAMpQXsaCno", "language": "400", "code": "// Bad Request - Invalid input parameters\n" }, { "id": "xklOlM4xOjwZDMIMc2NSd", "language": "401", "code": "// Unauthorized - Invalid or missing API key\n" }, { "id": "GHkDiojmEllDriws-DN6A", "language": "500", "code": "// Internal Server Error\n" } ], "selectedLanguageId": "axMMYbbpZ8KPwsEFjntg_" } }, "children": [ { "text": "" } ] }