Update a Debit Memo
1 min
POST
https://api.nue.io/billing/debit-memos:update
Header Parameters
- acceptstringDescriptionDefaultapplication/jsonAllowedapplication/json*/*
Body Parameters
- bodyobjectrequiredDescription
- debitMemoobjectrequired
- idstringrequired
- customerIdstringrequired
- amountstringrequired
- startDatestring<date>requiredFormatdate
- endDatestring<date>requiredFormatdate
- taxAmountstringrequired
- sourceIdstringrequired
- sourceTypestringrequired
- chargeReasonstringrequired
- statusstringrequired
- currencyCodestringrequired
- descriptionstringrequired
- notifyCrmbooleanrequired
Responses
400
- object
- titlestring
- messagestring
- errorCodestring
404
default
- UpdateDebitMemoResponse
- Idstring<uuid>DescriptionFormatuuid
- Customer IdstringDescription
- AmountnumberDescription
- Tax AmountnumberDescription
- Start Datestring<date>DescriptionFormatdate
- End Datestring<date>DescriptionFormatdate
- Source IdstringDescription
- Source Typestring<Invoice>DescriptionAllowedInvoice
- Charge Reasonstring<LateFee | AdditionalFee | BillingDiscrepancies>DescriptionAllowedLateFeeAdditionalFeeBillingDiscrepancies
- DescriptionstringDescription
curl
curl --request POST \
--url https://api.nue.io/billing/debit-memos:update \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"debitMemo": {
"id": "",
"customerId": "",
"amount": "",
"startDate": "",
"endDate": "",
"taxAmount": "",
"sourceId": "",
"sourceType": "",
"chargeReason": "",
"status": "",
"currencyCode": "",
"description": ""
},
"notifyCrm": ""
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"debitMemo": {
"id": "",
"customerId": "",
"amount": "",
"startDate": "",
"endDate": "",
"taxAmount": "",
"sourceId": "",
"sourceType": "",
"chargeReason": "",
"status": "",
"currencyCode": "",
"description": ""
},
"notifyCrm": ""
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.nue.io/billing/debit-memos:update", 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/debit-memos:update")
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.body = JSON.dump({
"debitMemo": {
"id": "",
"customerId": "",
"amount": "",
"startDate": "",
"endDate": "",
"taxAmount": "",
"sourceId": "",
"sourceType": "",
"chargeReason": "",
"status": "",
"currencyCode": "",
"description": ""
},
"notifyCrm": ""
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.nue.io/billing/debit-memos:update"
payload = json.dumps({
"debitMemo": {
"id": "",
"customerId": "",
"amount": "",
"startDate": "",
"endDate": "",
"taxAmount": "",
"sourceId": "",
"sourceType": "",
"chargeReason": "",
"status": "",
"currencyCode": "",
"description": ""
},
"notifyCrm": ""
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
400
// Bad Request
{
"title": "",
"message": "",
"errorCode": ""
}404
// Not Found
default
// default response
{
"Id": "",
"Customer Id": "",
"Amount": 0,
"Tax Amount": 0,
"Start Date": "",
"End Date": "",
"Source Id": "",
"Source Type": "",
"Charge Reason": "",
"Description": ""
}GENERATED
// default response
{
"Id": "",
"Customer Id": "",
"Amount": 0,
"Tax Amount": 0,
"Start Date": "",
"End Date": "",
"Source Id": "",
"Source Type": "",
"Charge Reason": "",
"Description": ""
}Response
{
"id": "838e8a7b-2568-49eb-9b12-b536d2ba79b4",
"customerId": "001DE0000344tTzYAI",
"amount": "100",
"startDate": "2023-02-02",
"endDate": "2023-08-03",
"taxAmount": "0",
"sourceId": "1298c34f-98bc-46bb-8f5d-a757556e9b4b",
"sourceType": "Invoice",
"chargeReason": "LateFee",
"status": "Active",
"currencyCode": "USD",
"description": "Late Fee"
}