Convert Credits to Credit Memos
1 min
POST
https://api.nue.io/billing/credits:convert
Header Parameters
- acceptstringDescriptionDefaultapplication/jsonAllowedapplication/json*/*
Body Parameters
- bodyCreditConvertRequestrequiredDescription
- creditsCreditConvert[]required
- creditIdstring<uuid>Formatuuid
- creditNumberstring
- amountnumber
Responses
200
- CreditConvertResponse
- creditmemosInvoiceOneTimeCredit[]
- idstring<uuid>Formatuuid
- tenantIdstring<uuid>Formatuuid
- invoiceNumberstring
- creditMemoNumberstring
- invoiceDatestring<date>Formatdate
- creditMemoDatestring<date>Formatdate
- accountIdstring
- statusstring<Draft | PendingActivation | Active | Canceled | EInvoicing>AllowedDraftPendingActivationActiveCanceledEInvoicing
- recordTypestring<Invoice | CreditMemo>AllowedInvoiceCreditMemo
- amountnumber
- amountWithoutTaxnumber
- taxAmountnumber
- balancenumber
- dueDatestring<date>Formatdate
- activatedByIdstring
- activatedTimestring<date-time>Formatdate-time
- startDatestring<date>Formatdate
- endDatestring<date>Formatdate
- targetDatestring<date>Formatdate
- salesAccountIdstring
- currencyIsoCodestring
- itemsInvoiceItemOneTimeCredit[]
- idstring<uuid>Formatuuid
- invoiceItemNumberstring
- invoiceIdstring<uuid>Formatuuid
- invoiceNumberstring
- creditMemoItemNumberstring
- creditMemoIdstring<uuid>Formatuuid
- creditMemoNumberstring
- tenantIdstring<uuid>Formatuuid
- accountIdstring
- productIdstring
- productNamestring
- assetIdstring
- assetNumberstring
- assetTypestring<Subscription | Asset | Entitlement>AllowedSubscriptionAssetEntitlement
- uomIdstring
- transactionDatestring<date>Formatdate
- transactionAmountnumber
- transactionAmountWithoutTaxnumber
- transactionQuantitynumber
- taxAmountnumber
- balancenumber
- startDatestring<date>Formatdate
- endDatestring<date>Formatdate
- statusstring<Draft | PendingActivation | Active | Canceled | EInvoicing>AllowedDraftPendingActivationActiveCanceledEInvoicing
- salesAccountIdstring
- currencyIsoCodestring
- detailsInvoiceItemDetailOneTimeCredit[]
- idstring<uuid>Formatuuid
- invoiceItemDetailNumberstring
- invoiceItemIdstring<uuid>Formatuuid
- invoiceIdstring<uuid>Formatuuid
- creditMemoItemDetailNumberstring
- creditMemoItemIdstring<uuid>Formatuuid
- creditMemoIdstring<uuid>Formatuuid
- tenantIdstring<uuid>Formatuuid
- accountIdstring
- orderProductIdstring
- transactionAmountWithoutTaxnumber
- transactionQuantitynumber
- taxAmountnumber
- startDatestring<date>Formatdate
- endDatestring<date>Formatdate
- billingTimingstring<InAdvance | InArrears>AllowedInAdvanceInArrears
- statusstring<Draft | PendingActivation | Active | Canceled | EInvoicing>AllowedDraftPendingActivationActiveCanceledEInvoicing
- salesAccountIdstring
- currencyIsoCodestring
400
- object
- titlestring
- messagestring
- errorCodestring
404
curl
curl --request POST \
--url https://api.nue.io/billing/credits:convert \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"credits": [
{}
]
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"credits": [
{}
]
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.nue.io/billing/credits:convert", 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/credits:convert")
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({
"credits": [
{}
]
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.nue.io/billing/credits:convert"
payload = json.dumps({
"credits": [
{}
]
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// default response
{
"creditmemos": [
{
"id": "",
"tenantId": "",
"invoiceNumber": "",
"creditMemoNumber": "",
"invoiceDate": "",
"creditMemoDate": "",
"accountId": "",
"status": "",
"recordType": "",
"amount": 0,
"amountWithoutTax": 0,
"taxAmount": 0,
"balance": 0,
"dueDate": "",
"activatedById": "",
"activatedTime": "",
"startDate": "",
"endDate": "",
"targetDate": "",
"salesAccountId": "",
"currencyIsoCode": "",
"items": [
{
"id": "",
"invoiceItemNumber": "",
"invoiceId": "",
"invoiceNumber": "",
"creditMemoItemNumber": "",
"creditMemoId": "",
"creditMemoNumber": "",
"tenantId": "",
"accountId": "",
"productId": "",
"productName": "",
"assetId": "",
"assetNumber": "",
"assetType": "",
"uomId": "",
"transactionDate": "",
"transactionAmount": 0,
"transactionAmountWithoutTax": 0,
"transactionQuantity": 0,
"taxAmount": 0,
"balance": 0,
"startDate": "",
"endDate": "",
"status": "",
"salesAccountId": "",
"currencyIsoCode": "",
"details": [
{
"id": "",
"invoiceItemDetailNumber": "",
"invoiceItemId": "",
"invoiceId": "",
"creditMemoItemDetailNumber": "",
"creditMemoItemId": "",
"creditMemoId": "",
"tenantId": "",
"accountId": "",
"orderProductId": "",
"transactionAmountWithoutTax": 0,
"transactionQuantity": 0,
"taxAmount": 0,
"startDate": "",
"endDate": "",
"billingTiming": "",
"status": "",
"salesAccountId": "",
"currencyIsoCode": ""
}
]
}
]
}
]
}GENERATED
// default response
{
"creditmemos": [
{
"id": "",
"tenantId": "",
"invoiceNumber": "",
"creditMemoNumber": "",
"invoiceDate": "",
"creditMemoDate": "",
"accountId": "",
"status": "",
"recordType": "",
"amount": 0,
"amountWithoutTax": 0,
"taxAmount": 0,
"balance": 0,
"dueDate": "",
"activatedById": "",
"activatedTime": "",
"startDate": "",
"endDate": "",
"targetDate": "",
"salesAccountId": "",
"currencyIsoCode": "",
"items": [
{
"id": "",
"invoiceItemNumber": "",
"invoiceId": "",
"invoiceNumber": "",
"creditMemoItemNumber": "",
"creditMemoId": "",
"creditMemoNumber": "",
"tenantId": "",
"accountId": "",
"productId": "",
"productName": "",
"assetId": "",
"assetNumber": "",
"assetType": "",
"uomId": "",
"transactionDate": "",
"transactionAmount": 0,
"transactionAmountWithoutTax": 0,
"transactionQuantity": 0,
"taxAmount": 0,
"balance": 0,
"startDate": "",
"endDate": "",
"status": "",
"salesAccountId": "",
"currencyIsoCode": "",
"details": [
{
"id": "",
"invoiceItemDetailNumber": "",
"invoiceItemId": "",
"invoiceId": "",
"creditMemoItemDetailNumber": "",
"creditMemoItemId": "",
"creditMemoId": "",
"tenantId": "",
"accountId": "",
"orderProductId": "",
"transactionAmountWithoutTax": 0,
"transactionQuantity": 0,
"taxAmount": 0,
"startDate": "",
"endDate": "",
"billingTiming": "",
"status": "",
"salesAccountId": "",
"currencyIsoCode": ""
}
]
}
]
}
]
}Convert credits Response
{
"invoices": [
{
"id": "d15d8c1a-6871-48c6-8179-bba64d63f885",
"tenantId": "8308ffcf-d286-4eaf-93ed-67605c02de2f",
"creditMemoNumber": "CM-00001280",
"creditMemoDate": "2024-05-07",
"accountId": "001RK00000EpbwnYAB",
"status": "Active",
"amount": 50,
"amountWithoutTax": 50,
"taxAmount": 0,
"balance": 50,
"dueDate": "2024-06-06",
"startDate": "2024-05-06",
"endDate": "2024-05-06",
"targetDate": "2024-05-07",
"salesAccountId": "001RK00000EpbwnYAB",
"items": [
{
"id": "0ab92ee4-d06b-4f22-bb21-180a75f7faa8",
"creditMemoItemNumber": "CMI-00001280",
"creditMemoId": "d15d8c1a-6871-48c6-8179-bba64d63f885",
"creditMemoNumber": "CM-00001280",
"tenantId": "8308ffcf-d286-4eaf-93ed-67605c02de2f",
"accountId": "001RK00000EpbwnYAB",
"productId": "01tRK000004dlkkYAA",
"productName": "Test-OneTimeCredit-Cash-Asset01",
"assetId": "02iRK000000Wy97YAC",
"assetNumber": "02iRK000000Wy97YAC",
"assetType": "Asset",
"uomId": "a0kRK000001piJQYAY",
"transactionDate": "2024-05-07",
"transactionAmount": 50,
"transactionAmountWithoutTax": 50,
"transactionQuantity": 25,
"taxAmount": 0,
"balance": 50,
"startDate": "2024-05-06",
"endDate": "2024-05-06",
"status": "Active",
"salesAccountId": "001RK00000EpbwnYAB",
"details": [
{
"id": "97e84005-8c65-45eb-bc6f-e9786af257b9",
"creditMemoItemDetailNumber": "CMID-0000001280",
"creditMemoItemId": "0ab92ee4-d06b-4f22-bb21-180a75f7faa8",
"creditMemoId": "d15d8c1a-6871-48c6-8179-bba64d63f885",
"tenantId": "8308ffcf-d286-4eaf-93ed-67605c02de2f",
"accountId": "001RK00000EpbwnYAB",
"orderProductId": "802RK000008DH1vYAG",
"transactionAmountWithoutTax": 50,
"transactionQuantity": 25,
"taxAmount": 0,
"startDate": "2024-05-06",
"endDate": "2024-05-06",
"billingTiming": "InAdvance",
"status": "Active",
"salesAccountId": "001RK00000EpbwnYAB"
}
]
}
]
}
]
}400
// Bad Request
{
"title": "",
"message": "",
"errorCode": ""
}404
// Not Found