Create credit note
curl --request POST \
--url https://api.zenskar.com/credit_notes \
--header 'Content-Type: application/json' \
--header 'organisation: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": 123,
"currency": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_items": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credits_returned": 123,
"refund_amount": 123,
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credit_note_number": "<string>",
"custom_data": {},
"refund_amount_split": [
{
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"external_payment_id": "<string>",
"connector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
'import requests
url = "https://api.zenskar.com/credit_notes"
payload = {
"amount": 123,
"currency": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_items": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credits_returned": 123,
"refund_amount": 123,
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credit_note_number": "<string>",
"custom_data": {},
"refund_amount_split": [
{
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"external_payment_id": "<string>",
"connector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
headers = {
"x-api-key": "<api-key>",
"organisation": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
organisation: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 123,
currency: '<string>',
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
line_items: {},
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
credits_returned: 123,
refund_amount: 123,
invoice_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
credit_note_number: '<string>',
custom_data: {},
refund_amount_split: [
{
payment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount: 123,
external_payment_id: '<string>',
connector_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
})
};
fetch('https://api.zenskar.com/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.zenskar.com/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([
'amount' => 123,
'currency' => '<string>',
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'line_items' => [
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'credits_returned' => 123,
'refund_amount' => 123,
'invoice_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'credit_note_number' => '<string>',
'custom_data' => [
],
'refund_amount_split' => [
[
'payment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => 123,
'external_payment_id' => '<string>',
'connector_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"organisation: <api-key>",
"x-api-key: <api-key>"
],
]);
$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.zenskar.com/credit_notes"
payload := strings.NewReader("{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"line_items\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"credits_returned\": 123,\n \"refund_amount\": 123,\n \"invoice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"credit_note_number\": \"<string>\",\n \"custom_data\": {},\n \"refund_amount_split\": [\n {\n \"payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123,\n \"external_payment_id\": \"<string>\",\n \"connector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("organisation", "<api-key>")
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.zenskar.com/credit_notes")
.header("x-api-key", "<api-key>")
.header("organisation", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"line_items\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"credits_returned\": 123,\n \"refund_amount\": 123,\n \"invoice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"credit_note_number\": \"<string>\",\n \"custom_data\": {},\n \"refund_amount_split\": [\n {\n \"payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123,\n \"external_payment_id\": \"<string>\",\n \"connector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zenskar.com/credit_notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["organisation"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"line_items\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"credits_returned\": 123,\n \"refund_amount\": 123,\n \"invoice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"credit_note_number\": \"<string>\",\n \"custom_data\": {},\n \"refund_amount_split\": [\n {\n \"payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123,\n \"external_payment_id\": \"<string>\",\n \"connector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"currency": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "in_progress",
"repayment_method": "credits",
"line_items_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"credits_returned": 123,
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"external_id": "<string>"
},
"invoice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"external_id": "<string>"
},
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"custom_data": {},
"credit_note_number": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Credit Notes
Create credit note
Creates a credit note for the given organisation. The credit note will be associated with the organisation.
POST
/
credit_notes
Create credit note
curl --request POST \
--url https://api.zenskar.com/credit_notes \
--header 'Content-Type: application/json' \
--header 'organisation: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": 123,
"currency": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_items": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credits_returned": 123,
"refund_amount": 123,
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credit_note_number": "<string>",
"custom_data": {},
"refund_amount_split": [
{
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"external_payment_id": "<string>",
"connector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
'import requests
url = "https://api.zenskar.com/credit_notes"
payload = {
"amount": 123,
"currency": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_items": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credits_returned": 123,
"refund_amount": 123,
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credit_note_number": "<string>",
"custom_data": {},
"refund_amount_split": [
{
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"external_payment_id": "<string>",
"connector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
headers = {
"x-api-key": "<api-key>",
"organisation": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
organisation: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 123,
currency: '<string>',
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
line_items: {},
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
credits_returned: 123,
refund_amount: 123,
invoice_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
credit_note_number: '<string>',
custom_data: {},
refund_amount_split: [
{
payment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount: 123,
external_payment_id: '<string>',
connector_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
})
};
fetch('https://api.zenskar.com/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.zenskar.com/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([
'amount' => 123,
'currency' => '<string>',
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'line_items' => [
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'credits_returned' => 123,
'refund_amount' => 123,
'invoice_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'credit_note_number' => '<string>',
'custom_data' => [
],
'refund_amount_split' => [
[
'payment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => 123,
'external_payment_id' => '<string>',
'connector_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"organisation: <api-key>",
"x-api-key: <api-key>"
],
]);
$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.zenskar.com/credit_notes"
payload := strings.NewReader("{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"line_items\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"credits_returned\": 123,\n \"refund_amount\": 123,\n \"invoice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"credit_note_number\": \"<string>\",\n \"custom_data\": {},\n \"refund_amount_split\": [\n {\n \"payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123,\n \"external_payment_id\": \"<string>\",\n \"connector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("organisation", "<api-key>")
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.zenskar.com/credit_notes")
.header("x-api-key", "<api-key>")
.header("organisation", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"line_items\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"credits_returned\": 123,\n \"refund_amount\": 123,\n \"invoice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"credit_note_number\": \"<string>\",\n \"custom_data\": {},\n \"refund_amount_split\": [\n {\n \"payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123,\n \"external_payment_id\": \"<string>\",\n \"connector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zenskar.com/credit_notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["organisation"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"line_items\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"credits_returned\": 123,\n \"refund_amount\": 123,\n \"invoice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"credit_note_number\": \"<string>\",\n \"custom_data\": {},\n \"refund_amount_split\": [\n {\n \"payment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 123,\n \"external_payment_id\": \"<string>\",\n \"connector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"currency": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "in_progress",
"repayment_method": "credits",
"line_items_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"credits_returned": 123,
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"external_id": "<string>"
},
"invoice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"external_id": "<string>"
},
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"custom_data": {},
"credit_note_number": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Credit Note Amount
Currency
Customer ID
Status
Available options:
in_progress, issued, void, paid Repayment Method
Available options:
credits, invoice_adjusted, external_payment, credits_against_payment, original_payment_method Line Items
Pre-set credit note id. None means the server mints a fresh UUID. Callers (external CN imports, idempotent retries from Stripe/QBO/etc., migration scripts) may preset to keep a stable id across systems.
Credits amount returned
Refund Amount (if any) against payments, should be addition of refund amount split
Invoice ID
Credit Note Number
Custom Data Dictionary
Available options:
credits, original_payment_method, external Refund Amount Split
Show child attributes
Show child attributes
Response
Successful Response
ID
Amount in lowest denomination of the currency
Currency
Customer ID
Status
Available options:
in_progress, issued, void, paid Repayment Method
Available options:
credits, invoice_adjusted, external_payment, credits_against_payment, original_payment_method Line Items URL
Created At
Credits amount in lowest denomination of the currency
Customer Object
Show child attributes
Show child attributes
Invoice Object
Show child attributes
Show child attributes
Invoice ID
Custom Data Dictionary
Credit Note Number