Upsert a Standalone Credit Memo
1 min
POST
https://api.nue.io/billing/credit-memos/standalone:upsert
Header Parameters
- nue-api-keystringrequired
Body Parameters
- bodyobjectrequiredExample
{ "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 }- headerobjectrequired
- idstring<uuid>DescriptionFormatuuid
- customerIdstringrequiredDescription
- salesAccountIdstringDescription
- billToContactIdstringDescription
- creditMemoDatestring<date>requiredDescriptionFormatdate
- amountnumberrequiredDescription
- taxAmountnumberDescription
- itemsobject[]required
- idstring<uuid>DescriptionFormatuuid
- productIdstringrequiredDescription
- productNamestringDescription
- transactionDatestring<date>requiredDescriptionFormatdate
- taxAmountnumberDescription
- transactionQuantitynumberrequiredDescription
- transactionAmountnumberrequiredDescription
- deleteItemIdsstring[]Description
- activateCreditMemoNowbooleanDescription
Responses
200
- objectExample
{ "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": [] }- statusstringExample
- dataobject
- idstring<uuid>DescriptionFormatuuid
- namestringDescription
- customerIdstringDescription
- salesAccountIdstringDescription
- billToContactIdstringDescription
- creditMemoDatestring<date>DescriptionFormatdate
- amountnumberDescription
- amountWithoutTaxnumberDescription
- taxAmountnumberDescription
- balancenumberDescription
- statusstringDescription
- sourcestringDescription
- startDatestring<date>DescriptionFormatdate
- dueDatestring<date>DescriptionFormatdate
- creditMemoPdfstring<uri>DescriptionFormaturi
- createdDatestring<date-time>DescriptionFormatdate-time
- createdByIdstringDescription
- lastModifiedDatestring<date-time>DescriptionFormatdate-time
- lastModifiedByIdstringDescription
- activatedTimestring<date-time>DescriptionFormatdate-time
- activatedByIdstringDescription
- taxStatusstringDescription
- paymentStatusstringDescription
- accountingStatusstringDescription
- creditMemoItemsobject[]
- idstring<uuid>DescriptionFormatuuid
- namestringDescription
- creditMemoIdstring<uuid>DescriptionFormatuuid
- creditMemoNumberstringDescription
- productIdstringDescription
- productNamestringDescription
- accountIdstringDescription
- salesAccountIdstringDescription
- transactionDatestring<date>DescriptionFormatdate
- startDatestring<date>DescriptionFormatdate
- endDatestring<date>DescriptionFormatdate
- transactionQuantitynumberDescription
- transactionAmountnumberDescription
- transactionAmountWithoutTaxnumberDescription
- taxAmountnumberDescription
- balancenumberDescription
- appliedCreditsnumberDescription
- ratedCreditsnumberDescription
- paymentStatusstringDescription
- createdDatestring<date-time>DescriptionFormatdate-time
- createdByIdstringDescription
- lastModifiedDatestring<date-time>DescriptionFormatdate-time
- lastModifiedByIdstringDescription
- uomIdstringDescription
- billingTimingstringDescription
- isCatchUpbooleanDescription
- warningsstring[]Description
400
401
500
curl
curl --request POST \
--url https://api.nue.io/billing/credit-memos/standalone:upsert \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'nue-api-key: string' \
--data '{
"header": {
"customerId": "",
"creditMemoDate": "",
"amount": ""
},
"items": [
{
"productId": "",
"transactionDate": "",
"transactionQuantity": "",
"transactionAmount": ""
}
]
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("nue-api-key", "string");
var raw = JSON.stringify({
"header": {
"customerId": "",
"creditMemoDate": "",
"amount": ""
},
"items": [
{
"productId": "",
"transactionDate": "",
"transactionQuantity": "",
"transactionAmount": ""
}
]
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.nue.io/billing/credit-memos/standalone:upsert", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.nue.io/billing/credit-memos/standalone:upsert")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["nue-api-key"] = "string"
request.body = JSON.dump({
"header": {
"customerId": "",
"creditMemoDate": "",
"amount": ""
},
"items": [
{
"productId": "",
"transactionDate": "",
"transactionQuantity": "",
"transactionAmount": ""
}
]
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.nue.io/billing/credit-memos/standalone:upsert"
payload = json.dumps({
"header": {
"customerId": "",
"creditMemoDate": "",
"amount": ""
},
"items": [
{
"productId": "",
"transactionDate": "",
"transactionQuantity": "",
"transactionAmount": ""
}
]
})
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'nue-api-key': 'string'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Successfully created or updated the credit memo
{
"status": "SUCCESS",
"data": {
"id": "",
"name": "",
"customerId": "",
"salesAccountId": "",
"billToContactId": "",
"creditMemoDate": "",
"amount": 0,
"amountWithoutTax": 0,
"taxAmount": 0,
"balance": 0,
"status": "",
"source": "",
"startDate": "",
"dueDate": "",
"creditMemoPdf": "",
"createdDate": "",
"createdById": "",
"lastModifiedDate": "",
"lastModifiedById": "",
"activatedTime": "",
"activatedById": "",
"taxStatus": "",
"paymentStatus": "",
"accountingStatus": "",
"creditMemoItems": [
{
"id": "",
"name": "",
"creditMemoId": "",
"creditMemoNumber": "",
"productId": "",
"productName": "",
"accountId": "",
"salesAccountId": "",
"transactionDate": "",
"startDate": "",
"endDate": "",
"transactionQuantity": 0,
"transactionAmount": 0,
"transactionAmountWithoutTax": 0,
"taxAmount": 0,
"balance": 0,
"appliedCredits": 0,
"ratedCredits": 0,
"paymentStatus": "",
"createdDate": "",
"createdById": "",
"lastModifiedDate": "",
"lastModifiedById": "",
"uomId": "",
"billingTiming": "",
"isCatchUp": false
}
]
},
"warnings": [
""
]
}400
// Bad Request - Invalid input parameters
401
// Unauthorized - Invalid or missing API key
500
// Internal Server Error