Create a Credit Note
curl --request POST \
--url https://api.nocotax.app/credit_notes \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"currency": "<string>",
"automatic_tax_calculation": {
"enabled": true
},
"customer_id": "<string>",
"customer_tax_registration_ids": [
"<string>"
],
"invoice_id": "<string>",
"items": [
{
"extratax_amount": 123,
"product": {
"tax_code": "<string>"
},
"title": "<string>",
"quantity": 123,
"tax_included_amount": 123,
"period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"taxes": [
{
"jurisdiction": "<string>",
"percentage": "<string>",
"tax_id": "<string>",
"tax_exemption": {
"type": "<string>",
"legal_notice": "<string>"
}
}
],
"unit_extratax_amount": "<string>",
"unit_tax_included_amount": "<string>"
}
],
"issuer": {
"type": "CUSTOMER"
},
"locale": "<string>",
"memo": "<string>",
"numbering_sequence_id": "<string>",
"order_reference": "<string>",
"period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"supplier_id": "<string>",
"supplier_tax_registration_ids": [
"<string>"
]
}
'import requests
url = "https://api.nocotax.app/credit_notes"
payload = {
"currency": "<string>",
"automatic_tax_calculation": { "enabled": True },
"customer_id": "<string>",
"customer_tax_registration_ids": ["<string>"],
"invoice_id": "<string>",
"items": [
{
"extratax_amount": 123,
"product": { "tax_code": "<string>" },
"title": "<string>",
"quantity": 123,
"tax_included_amount": 123,
"period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"taxes": [
{
"jurisdiction": "<string>",
"percentage": "<string>",
"tax_id": "<string>",
"tax_exemption": {
"type": "<string>",
"legal_notice": "<string>"
}
}
],
"unit_extratax_amount": "<string>",
"unit_tax_included_amount": "<string>"
}
],
"issuer": { "type": "CUSTOMER" },
"locale": "<string>",
"memo": "<string>",
"numbering_sequence_id": "<string>",
"order_reference": "<string>",
"period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"supplier_id": "<string>",
"supplier_tax_registration_ids": ["<string>"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currency: '<string>',
automatic_tax_calculation: {enabled: true},
customer_id: '<string>',
customer_tax_registration_ids: ['<string>'],
invoice_id: '<string>',
items: [
{
extratax_amount: 123,
product: {tax_code: '<string>'},
title: '<string>',
quantity: 123,
tax_included_amount: 123,
period: {end: '2023-11-07T05:31:56Z', start: '2023-11-07T05:31:56Z'},
taxes: [
{
jurisdiction: '<string>',
percentage: '<string>',
tax_id: '<string>',
tax_exemption: {type: '<string>', legal_notice: '<string>'}
}
],
unit_extratax_amount: '<string>',
unit_tax_included_amount: '<string>'
}
],
issuer: {type: 'CUSTOMER'},
locale: '<string>',
memo: '<string>',
numbering_sequence_id: '<string>',
order_reference: '<string>',
period: {end: '2023-11-07T05:31:56Z', start: '2023-11-07T05:31:56Z'},
supplier_id: '<string>',
supplier_tax_registration_ids: ['<string>']
})
};
fetch('https://api.nocotax.app/credit_notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nocotax.app/credit_notes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'currency' => '<string>',
'automatic_tax_calculation' => [
'enabled' => true
],
'customer_id' => '<string>',
'customer_tax_registration_ids' => [
'<string>'
],
'invoice_id' => '<string>',
'items' => [
[
'extratax_amount' => 123,
'product' => [
'tax_code' => '<string>'
],
'title' => '<string>',
'quantity' => 123,
'tax_included_amount' => 123,
'period' => [
'end' => '2023-11-07T05:31:56Z',
'start' => '2023-11-07T05:31:56Z'
],
'taxes' => [
[
'jurisdiction' => '<string>',
'percentage' => '<string>',
'tax_id' => '<string>',
'tax_exemption' => [
'type' => '<string>',
'legal_notice' => '<string>'
]
]
],
'unit_extratax_amount' => '<string>',
'unit_tax_included_amount' => '<string>'
]
],
'issuer' => [
'type' => 'CUSTOMER'
],
'locale' => '<string>',
'memo' => '<string>',
'numbering_sequence_id' => '<string>',
'order_reference' => '<string>',
'period' => [
'end' => '2023-11-07T05:31:56Z',
'start' => '2023-11-07T05:31:56Z'
],
'supplier_id' => '<string>',
'supplier_tax_registration_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nocotax.app/credit_notes"
payload := strings.NewReader("{\n \"currency\": \"<string>\",\n \"automatic_tax_calculation\": {\n \"enabled\": true\n },\n \"customer_id\": \"<string>\",\n \"customer_tax_registration_ids\": [\n \"<string>\"\n ],\n \"invoice_id\": \"<string>\",\n \"items\": [\n {\n \"extratax_amount\": 123,\n \"product\": {\n \"tax_code\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"quantity\": 123,\n \"tax_included_amount\": 123,\n \"period\": {\n \"end\": \"2023-11-07T05:31:56Z\",\n \"start\": \"2023-11-07T05:31:56Z\"\n },\n \"taxes\": [\n {\n \"jurisdiction\": \"<string>\",\n \"percentage\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"tax_exemption\": {\n \"type\": \"<string>\",\n \"legal_notice\": \"<string>\"\n }\n }\n ],\n \"unit_extratax_amount\": \"<string>\",\n \"unit_tax_included_amount\": \"<string>\"\n }\n ],\n \"issuer\": {\n \"type\": \"CUSTOMER\"\n },\n \"locale\": \"<string>\",\n \"memo\": \"<string>\",\n \"numbering_sequence_id\": \"<string>\",\n \"order_reference\": \"<string>\",\n \"period\": {\n \"end\": \"2023-11-07T05:31:56Z\",\n \"start\": \"2023-11-07T05:31:56Z\"\n },\n \"supplier_id\": \"<string>\",\n \"supplier_tax_registration_ids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.nocotax.app/credit_notes")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"<string>\",\n \"automatic_tax_calculation\": {\n \"enabled\": true\n },\n \"customer_id\": \"<string>\",\n \"customer_tax_registration_ids\": [\n \"<string>\"\n ],\n \"invoice_id\": \"<string>\",\n \"items\": [\n {\n \"extratax_amount\": 123,\n \"product\": {\n \"tax_code\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"quantity\": 123,\n \"tax_included_amount\": 123,\n \"period\": {\n \"end\": \"2023-11-07T05:31:56Z\",\n \"start\": \"2023-11-07T05:31:56Z\"\n },\n \"taxes\": [\n {\n \"jurisdiction\": \"<string>\",\n \"percentage\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"tax_exemption\": {\n \"type\": \"<string>\",\n \"legal_notice\": \"<string>\"\n }\n }\n ],\n \"unit_extratax_amount\": \"<string>\",\n \"unit_tax_included_amount\": \"<string>\"\n }\n ],\n \"issuer\": {\n \"type\": \"CUSTOMER\"\n },\n \"locale\": \"<string>\",\n \"memo\": \"<string>\",\n \"numbering_sequence_id\": \"<string>\",\n \"order_reference\": \"<string>\",\n \"period\": {\n \"end\": \"2023-11-07T05:31:56Z\",\n \"start\": \"2023-11-07T05:31:56Z\"\n },\n \"supplier_id\": \"<string>\",\n \"supplier_tax_registration_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nocotax.app/credit_notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"<string>\",\n \"automatic_tax_calculation\": {\n \"enabled\": true\n },\n \"customer_id\": \"<string>\",\n \"customer_tax_registration_ids\": [\n \"<string>\"\n ],\n \"invoice_id\": \"<string>\",\n \"items\": [\n {\n \"extratax_amount\": 123,\n \"product\": {\n \"tax_code\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"quantity\": 123,\n \"tax_included_amount\": 123,\n \"period\": {\n \"end\": \"2023-11-07T05:31:56Z\",\n \"start\": \"2023-11-07T05:31:56Z\"\n },\n \"taxes\": [\n {\n \"jurisdiction\": \"<string>\",\n \"percentage\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"tax_exemption\": {\n \"type\": \"<string>\",\n \"legal_notice\": \"<string>\"\n }\n }\n ],\n \"unit_extratax_amount\": \"<string>\",\n \"unit_tax_included_amount\": \"<string>\"\n }\n ],\n \"issuer\": {\n \"type\": \"CUSTOMER\"\n },\n \"locale\": \"<string>\",\n \"memo\": \"<string>\",\n \"numbering_sequence_id\": \"<string>\",\n \"order_reference\": \"<string>\",\n \"period\": {\n \"end\": \"2023-11-07T05:31:56Z\",\n \"start\": \"2023-11-07T05:31:56Z\"\n },\n \"supplier_id\": \"<string>\",\n \"supplier_tax_registration_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "cn_17920607414fecd28c4674",
"livemode": false,
"object": "credit_note",
"amount_to_credit": null,
"amount_overcredited": null,
"amount_credited": null,
"amount_post_payment": null,
"amount_pre_payment": null,
"amount_remaining": null,
"automatic_tax_calculation": {
"enabled": true
},
"credit_status": null,
"currency": "EUR",
"customer_data": {
"name": "Kunde-Dietrich",
"billing_address": {
"city": "Mariettashire",
"line1": "9428 Reichert Garden",
"line2": "Apt. 712",
"country": "NO",
"postal_code": "61470-9968"
},
"business_registration_number": "23205436100802",
"tax_identification_number": "468336193"
},
"customer_id": "org_179206074069vh2a00cf6b",
"customer_tax_registration_data": [],
"customer_tax_registration_ids": [],
"document_date": null,
"document_number": null,
"flow": "sales",
"invoice_id": null,
"issuer": null,
"legal_notices": null,
"locale": "en",
"memo": null,
"metadata": {},
"numbering_sequence_id": "ns_179206074064nifa543c82",
"order_reference": null,
"period": null,
"representations": {},
"status": "draft",
"status_transitions": {},
"supplier_country": "TJ",
"supplier_data": {
"name": "Hettinger, Bashirian and Hermann",
"billing_address": {
"city": "Lake Antoniahaven",
"line1": "4088 Noe Forest",
"line2": "Apt. 635",
"country": "TJ",
"postal_code": "89312-6170"
},
"business_registration_number": "60260274000014",
"tax_identification_number": "959328808"
},
"supplier_id": "org_17920607405xhyb2e87bad",
"supplier_tax_registration_data": [],
"supplier_tax_registration_ids": [],
"taxes": [
{
"tax_id": "no-vat",
"percentage": "0.0",
"jurisdiction": "NO",
"tax_exemption": {
"type": "NOT_REGISTERED",
"legal_notice": null
},
"taxable_amount": 4374684
}
],
"total_extratax_amount": 4374684,
"total_tax_amount": 0,
"total_tax_included_amount": 4374684,
"created_at": "2026-10-15T10:39:01.215Z",
"updated_at": "2026-10-15T10:39:01.215Z"
}{
"message": "<string>",
"status": 123,
"type": "INVALID_REQUEST_ERROR",
"params": [
{
"field": "<string>",
"errors": [
"<string>"
]
}
]
}Credit Notes
Create a Credit Note
Creates a credit note.
POST
/
credit_notes
Create a Credit Note
curl --request POST \
--url https://api.nocotax.app/credit_notes \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"currency": "<string>",
"automatic_tax_calculation": {
"enabled": true
},
"customer_id": "<string>",
"customer_tax_registration_ids": [
"<string>"
],
"invoice_id": "<string>",
"items": [
{
"extratax_amount": 123,
"product": {
"tax_code": "<string>"
},
"title": "<string>",
"quantity": 123,
"tax_included_amount": 123,
"period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"taxes": [
{
"jurisdiction": "<string>",
"percentage": "<string>",
"tax_id": "<string>",
"tax_exemption": {
"type": "<string>",
"legal_notice": "<string>"
}
}
],
"unit_extratax_amount": "<string>",
"unit_tax_included_amount": "<string>"
}
],
"issuer": {
"type": "CUSTOMER"
},
"locale": "<string>",
"memo": "<string>",
"numbering_sequence_id": "<string>",
"order_reference": "<string>",
"period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"supplier_id": "<string>",
"supplier_tax_registration_ids": [
"<string>"
]
}
'import requests
url = "https://api.nocotax.app/credit_notes"
payload = {
"currency": "<string>",
"automatic_tax_calculation": { "enabled": True },
"customer_id": "<string>",
"customer_tax_registration_ids": ["<string>"],
"invoice_id": "<string>",
"items": [
{
"extratax_amount": 123,
"product": { "tax_code": "<string>" },
"title": "<string>",
"quantity": 123,
"tax_included_amount": 123,
"period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"taxes": [
{
"jurisdiction": "<string>",
"percentage": "<string>",
"tax_id": "<string>",
"tax_exemption": {
"type": "<string>",
"legal_notice": "<string>"
}
}
],
"unit_extratax_amount": "<string>",
"unit_tax_included_amount": "<string>"
}
],
"issuer": { "type": "CUSTOMER" },
"locale": "<string>",
"memo": "<string>",
"numbering_sequence_id": "<string>",
"order_reference": "<string>",
"period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"supplier_id": "<string>",
"supplier_tax_registration_ids": ["<string>"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currency: '<string>',
automatic_tax_calculation: {enabled: true},
customer_id: '<string>',
customer_tax_registration_ids: ['<string>'],
invoice_id: '<string>',
items: [
{
extratax_amount: 123,
product: {tax_code: '<string>'},
title: '<string>',
quantity: 123,
tax_included_amount: 123,
period: {end: '2023-11-07T05:31:56Z', start: '2023-11-07T05:31:56Z'},
taxes: [
{
jurisdiction: '<string>',
percentage: '<string>',
tax_id: '<string>',
tax_exemption: {type: '<string>', legal_notice: '<string>'}
}
],
unit_extratax_amount: '<string>',
unit_tax_included_amount: '<string>'
}
],
issuer: {type: 'CUSTOMER'},
locale: '<string>',
memo: '<string>',
numbering_sequence_id: '<string>',
order_reference: '<string>',
period: {end: '2023-11-07T05:31:56Z', start: '2023-11-07T05:31:56Z'},
supplier_id: '<string>',
supplier_tax_registration_ids: ['<string>']
})
};
fetch('https://api.nocotax.app/credit_notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nocotax.app/credit_notes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'currency' => '<string>',
'automatic_tax_calculation' => [
'enabled' => true
],
'customer_id' => '<string>',
'customer_tax_registration_ids' => [
'<string>'
],
'invoice_id' => '<string>',
'items' => [
[
'extratax_amount' => 123,
'product' => [
'tax_code' => '<string>'
],
'title' => '<string>',
'quantity' => 123,
'tax_included_amount' => 123,
'period' => [
'end' => '2023-11-07T05:31:56Z',
'start' => '2023-11-07T05:31:56Z'
],
'taxes' => [
[
'jurisdiction' => '<string>',
'percentage' => '<string>',
'tax_id' => '<string>',
'tax_exemption' => [
'type' => '<string>',
'legal_notice' => '<string>'
]
]
],
'unit_extratax_amount' => '<string>',
'unit_tax_included_amount' => '<string>'
]
],
'issuer' => [
'type' => 'CUSTOMER'
],
'locale' => '<string>',
'memo' => '<string>',
'numbering_sequence_id' => '<string>',
'order_reference' => '<string>',
'period' => [
'end' => '2023-11-07T05:31:56Z',
'start' => '2023-11-07T05:31:56Z'
],
'supplier_id' => '<string>',
'supplier_tax_registration_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nocotax.app/credit_notes"
payload := strings.NewReader("{\n \"currency\": \"<string>\",\n \"automatic_tax_calculation\": {\n \"enabled\": true\n },\n \"customer_id\": \"<string>\",\n \"customer_tax_registration_ids\": [\n \"<string>\"\n ],\n \"invoice_id\": \"<string>\",\n \"items\": [\n {\n \"extratax_amount\": 123,\n \"product\": {\n \"tax_code\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"quantity\": 123,\n \"tax_included_amount\": 123,\n \"period\": {\n \"end\": \"2023-11-07T05:31:56Z\",\n \"start\": \"2023-11-07T05:31:56Z\"\n },\n \"taxes\": [\n {\n \"jurisdiction\": \"<string>\",\n \"percentage\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"tax_exemption\": {\n \"type\": \"<string>\",\n \"legal_notice\": \"<string>\"\n }\n }\n ],\n \"unit_extratax_amount\": \"<string>\",\n \"unit_tax_included_amount\": \"<string>\"\n }\n ],\n \"issuer\": {\n \"type\": \"CUSTOMER\"\n },\n \"locale\": \"<string>\",\n \"memo\": \"<string>\",\n \"numbering_sequence_id\": \"<string>\",\n \"order_reference\": \"<string>\",\n \"period\": {\n \"end\": \"2023-11-07T05:31:56Z\",\n \"start\": \"2023-11-07T05:31:56Z\"\n },\n \"supplier_id\": \"<string>\",\n \"supplier_tax_registration_ids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.nocotax.app/credit_notes")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"<string>\",\n \"automatic_tax_calculation\": {\n \"enabled\": true\n },\n \"customer_id\": \"<string>\",\n \"customer_tax_registration_ids\": [\n \"<string>\"\n ],\n \"invoice_id\": \"<string>\",\n \"items\": [\n {\n \"extratax_amount\": 123,\n \"product\": {\n \"tax_code\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"quantity\": 123,\n \"tax_included_amount\": 123,\n \"period\": {\n \"end\": \"2023-11-07T05:31:56Z\",\n \"start\": \"2023-11-07T05:31:56Z\"\n },\n \"taxes\": [\n {\n \"jurisdiction\": \"<string>\",\n \"percentage\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"tax_exemption\": {\n \"type\": \"<string>\",\n \"legal_notice\": \"<string>\"\n }\n }\n ],\n \"unit_extratax_amount\": \"<string>\",\n \"unit_tax_included_amount\": \"<string>\"\n }\n ],\n \"issuer\": {\n \"type\": \"CUSTOMER\"\n },\n \"locale\": \"<string>\",\n \"memo\": \"<string>\",\n \"numbering_sequence_id\": \"<string>\",\n \"order_reference\": \"<string>\",\n \"period\": {\n \"end\": \"2023-11-07T05:31:56Z\",\n \"start\": \"2023-11-07T05:31:56Z\"\n },\n \"supplier_id\": \"<string>\",\n \"supplier_tax_registration_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nocotax.app/credit_notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"<string>\",\n \"automatic_tax_calculation\": {\n \"enabled\": true\n },\n \"customer_id\": \"<string>\",\n \"customer_tax_registration_ids\": [\n \"<string>\"\n ],\n \"invoice_id\": \"<string>\",\n \"items\": [\n {\n \"extratax_amount\": 123,\n \"product\": {\n \"tax_code\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"quantity\": 123,\n \"tax_included_amount\": 123,\n \"period\": {\n \"end\": \"2023-11-07T05:31:56Z\",\n \"start\": \"2023-11-07T05:31:56Z\"\n },\n \"taxes\": [\n {\n \"jurisdiction\": \"<string>\",\n \"percentage\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"tax_exemption\": {\n \"type\": \"<string>\",\n \"legal_notice\": \"<string>\"\n }\n }\n ],\n \"unit_extratax_amount\": \"<string>\",\n \"unit_tax_included_amount\": \"<string>\"\n }\n ],\n \"issuer\": {\n \"type\": \"CUSTOMER\"\n },\n \"locale\": \"<string>\",\n \"memo\": \"<string>\",\n \"numbering_sequence_id\": \"<string>\",\n \"order_reference\": \"<string>\",\n \"period\": {\n \"end\": \"2023-11-07T05:31:56Z\",\n \"start\": \"2023-11-07T05:31:56Z\"\n },\n \"supplier_id\": \"<string>\",\n \"supplier_tax_registration_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "cn_17920607414fecd28c4674",
"livemode": false,
"object": "credit_note",
"amount_to_credit": null,
"amount_overcredited": null,
"amount_credited": null,
"amount_post_payment": null,
"amount_pre_payment": null,
"amount_remaining": null,
"automatic_tax_calculation": {
"enabled": true
},
"credit_status": null,
"currency": "EUR",
"customer_data": {
"name": "Kunde-Dietrich",
"billing_address": {
"city": "Mariettashire",
"line1": "9428 Reichert Garden",
"line2": "Apt. 712",
"country": "NO",
"postal_code": "61470-9968"
},
"business_registration_number": "23205436100802",
"tax_identification_number": "468336193"
},
"customer_id": "org_179206074069vh2a00cf6b",
"customer_tax_registration_data": [],
"customer_tax_registration_ids": [],
"document_date": null,
"document_number": null,
"flow": "sales",
"invoice_id": null,
"issuer": null,
"legal_notices": null,
"locale": "en",
"memo": null,
"metadata": {},
"numbering_sequence_id": "ns_179206074064nifa543c82",
"order_reference": null,
"period": null,
"representations": {},
"status": "draft",
"status_transitions": {},
"supplier_country": "TJ",
"supplier_data": {
"name": "Hettinger, Bashirian and Hermann",
"billing_address": {
"city": "Lake Antoniahaven",
"line1": "4088 Noe Forest",
"line2": "Apt. 635",
"country": "TJ",
"postal_code": "89312-6170"
},
"business_registration_number": "60260274000014",
"tax_identification_number": "959328808"
},
"supplier_id": "org_17920607405xhyb2e87bad",
"supplier_tax_registration_data": [],
"supplier_tax_registration_ids": [],
"taxes": [
{
"tax_id": "no-vat",
"percentage": "0.0",
"jurisdiction": "NO",
"tax_exemption": {
"type": "NOT_REGISTERED",
"legal_notice": null
},
"taxable_amount": 4374684
}
],
"total_extratax_amount": 4374684,
"total_tax_amount": 0,
"total_tax_included_amount": 4374684,
"created_at": "2026-10-15T10:39:01.215Z",
"updated_at": "2026-10-15T10:39:01.215Z"
}{
"message": "<string>",
"status": 123,
"type": "INVALID_REQUEST_ERROR",
"params": [
{
"field": "<string>",
"errors": [
"<string>"
]
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
The currency ISO code of the document
Specifies the direction or role of the account owner in the invoicing transaction.
sales: The account owner is the supplier (i.e., the entity issuing the document for goods or services provided).
purchases: The account owner is the customer (i.e., the entity receiving the document for goods or services purchased).
platform: The account owner is a facilitator (i.e., the entity enabling the transaction between a customer and a supplier, such as a marketplace or intermediary).
Available options:
sales, purchases, platform Defaults to false. When automatic tax calculation is enabled, Nocotax automatically determines which tax rates must be applied to each item sold within the document. Nocotax also determines which tax registrations to apply on this document
Show child attributes
Show child attributes
The ID of the organization this document refers as a customer. Required if flow is not purchases
The customer’s tax registration IDs, that will be displayed on PDFs. Not compatible with automatic_tax_calculation[enabled]=true.
If this credit note refers to an invoice, the ID of this invoice.
A list of max. 10 line items to be added to the credit note.
Show child attributes
Show child attributes
If the issuer of the document is not the supplier (in case of white-label or self billing), information on the issuer
Show child attributes
Show child attributes
The locale used for this credit note representations (PDF)
Document memo
The ID of the numbering sequence this document is using to generate its number at finalization. Fallbacks to default for organization if not provided
The period associated with this document. Used to recognize and defer revenue
Show child attributes
Show child attributes
The ID of the organization this document refers as a supplier. Required if flow is not sales
The supplier's tax registration IDs, that will be displayed on PDFs. Not compatible with automatic_tax_calculation[enabled]=true.
Response
successful
The amount to credit at the time the credit note is finalized, in the currency's smaller unit (eg. cents)
If the amount of transactions attached to this credit note exceed its amount to credit, the amount overcredited, in the currency's smaller unit (eg. cents)
The amount that has been credited, in the currency's smaller unit (eg. cents)
The amount that will need to be credited to the customer
If attached to an invoice, the amount by which the corresponding invoice amount_remaining is reduced
The amount still to credit, in the currency's smaller unit (eg. cents)
When automatic tax calculation is enabled, Nocotax automatically determines which tax rates must be applied to each item sold within the document.
Show child attributes
Show child attributes
The credit status of the credit note. to_credit: The credit note has an amount that needs to be credited to the customer. credited: This credit note has been totally credited to the customer.
Available options:
to_credit, credited The currency ISO code of the document
Show child attributes
Show child attributes
The ID of the organization this document refers as a customer
The customer’s tax registration data. They are displayed on the PDF of the document, and may be used for automatic tax calculation if enabled.
Show child attributes
Show child attributes
The customer’s tax registration IDs.
The date of issuance of this document. Its value is null when the document status is draft
The number of this document. Its value is null when the document status is draft
If the issuer of the document is not the supplier (in case of white-label or self billing), information on the issuer
Show child attributes
Show child attributes
Specifies the direction or role of the account owner in the invoicing transaction.
sales: The account owner is the supplier (i.e., the entity issuing the document for goods or services provided).
purchases: The account owner is the customer (i.e., the entity receiving the document for goods or services purchased).
platform: The account owner is a facilitator (i.e., the entity enabling the transaction between a customer and a supplier, such as a marketplace or intermediary).
Available options:
sales, purchases, platform If this credit note refers to an invoice, the ID of this invoice.
A text representing a legal notice to display on document representations
The locale used for this credit note representations (PDF)
Document memo
The ID of the numbering sequence this document is using to generate its number at finalization
The period associated with this document. Used to recognize and defer revenue
Show child attributes
Show child attributes
After finalization of a document, you can share its representations to whoever you want. This is a set of URLs you can share.
Show child attributes
Show child attributes
The status of the document, one of draft, finalized, cancelled
Available options:
draft, finalized, cancelled Show child attributes
Show child attributes
The country (ISO alpha 2) of the country of issuance of the document
Show child attributes
Show child attributes
The ID of the organization this document refers as a supplier
The supplier's tax registration data. They are displayed on the PDF of the document, and may be used for automatic tax calculation if enabled.
Show child attributes
Show child attributes
The customer’s tax registration IDs.
The document's tax breakdown
Show child attributes
Show child attributes
Total extratax amount of the document, in the currency's smaller unit (eg. cents)
Total tax amount of the document, in the currency's smaller unit (eg. cents)
Total tax included of the document, in the currency's smaller unit (eg. cents)