Create a credit note
curl --request POST \
--url https://api.spacebring.com/billing/credit_notes/v1 \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"creditNote": {
"invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lines": [
{
"invoiceItemRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"quantity": 4503599627370495
}
],
"creditAmount": 1,
"effectiveDate": "2023-11-07T05:31:56Z",
"internalNote": "<string>",
"outOfBandAmount": 1,
"refunds": [
{
"amount": 1,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
}
'import requests
url = "https://api.spacebring.com/billing/credit_notes/v1"
payload = { "creditNote": {
"invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lines": [
{
"invoiceItemRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"quantity": 4503599627370495
}
],
"creditAmount": 1,
"effectiveDate": "2023-11-07T05:31:56Z",
"internalNote": "<string>",
"outOfBandAmount": 1,
"refunds": [
{
"amount": 1,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
} }
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({
creditNote: {
invoiceRef: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
lines: [
{
invoiceItemRef: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount: 1,
quantity: 4503599627370495
}
],
creditAmount: 1,
effectiveDate: '2023-11-07T05:31:56Z',
internalNote: '<string>',
outOfBandAmount: 1,
refunds: [
{
amount: 1,
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
transactionRef: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
}
})
};
fetch('https://api.spacebring.com/billing/credit_notes/v1', 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.spacebring.com/billing/credit_notes/v1",
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([
'creditNote' => [
'invoiceRef' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'lines' => [
[
'invoiceItemRef' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => 1,
'quantity' => 4503599627370495
]
],
'creditAmount' => 1,
'effectiveDate' => '2023-11-07T05:31:56Z',
'internalNote' => '<string>',
'outOfBandAmount' => 1,
'refunds' => [
[
'amount' => 1,
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'transactionRef' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]
]),
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.spacebring.com/billing/credit_notes/v1"
payload := strings.NewReader("{\n \"creditNote\": {\n \"invoiceRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lines\": [\n {\n \"invoiceItemRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 1,\n \"quantity\": 4503599627370495\n }\n ],\n \"creditAmount\": 1,\n \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n \"internalNote\": \"<string>\",\n \"outOfBandAmount\": 1,\n \"refunds\": [\n {\n \"amount\": 1,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"transactionRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\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.spacebring.com/billing/credit_notes/v1")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"creditNote\": {\n \"invoiceRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lines\": [\n {\n \"invoiceItemRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 1,\n \"quantity\": 4503599627370495\n }\n ],\n \"creditAmount\": 1,\n \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n \"internalNote\": \"<string>\",\n \"outOfBandAmount\": 1,\n \"refunds\": [\n {\n \"amount\": 1,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"transactionRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spacebring.com/billing/credit_notes/v1")
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 \"creditNote\": {\n \"invoiceRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lines\": [\n {\n \"invoiceItemRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 1,\n \"quantity\": 4503599627370495\n }\n ],\n \"creditAmount\": 1,\n \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n \"internalNote\": \"<string>\",\n \"outOfBandAmount\": 1,\n \"refunds\": [\n {\n \"amount\": 1,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"transactionRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"creditNote": {
"baseAmounts": {
"currencyCode": "<string>",
"grossAmount": 123,
"postPaymentAmount": 123,
"prePaymentAmount": 123,
"subtotalAmount": 123,
"subtotalAmountExcludingTax": 123,
"taxes": [
{
"amount": 123,
"inclusive": true,
"rate": 123,
"taxableAmount": 123
}
],
"totalAmount": 123,
"totalExcludingTaxAmount": 123
},
"createDate": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"logo": {
"key": "<string>",
"url": "<string>"
},
"title": "<string>",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"about": "<string>",
"email": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"photoUrl": "<string>",
"surname": "<string>"
}
},
"grossAmount": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lines": [
{
"baseAmounts": {
"currencyCode": "<string>",
"discountedAmount": 123,
"totalAmount": 123,
"totalExcludingTaxAmount": 123,
"tax": {
"amount": 123,
"inclusive": true,
"rate": 123,
"taxableAmount": 123
},
"unitAmount": 123,
"unitExcludingTaxAmount": 123
},
"createDate": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"discountedAmount": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceItemRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"networkRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"totalAmount": 123,
"totalExcludingTaxAmount": 123,
"updateDate": "2023-11-07T05:31:56Z",
"discounts": [
{
"coupon": {
"amountOff": 123,
"currencyCode": "<string>",
"duration": "<string>",
"durationInMonths": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"percentOff": 123,
"type": "<string>"
},
"promocode": {
"code": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiration": "2023-11-07T05:31:56Z",
"limitByFirstPurchase": true
},
"subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"quantity": 123,
"tax": {
"amount": 123,
"inclusive": true,
"rate": 123,
"taxableAmount": 123
},
"unitAmount": 123,
"unitExcludingTaxAmount": 123
}
],
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"networkRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pdfUrl": "<string>",
"postPaymentAmount": 123,
"prePaymentAmount": 123,
"subtotalAmount": 123,
"subtotalAmountExcludingTax": 123,
"taxes": [
{
"amount": 123,
"inclusive": true,
"rate": 123,
"taxableAmount": 123
}
],
"title": "<string>",
"totalAmount": 123,
"totalExcludingTaxAmount": 123,
"updateDate": "2023-11-07T05:31:56Z",
"creditAmount": 123,
"effectiveDate": "<string>",
"internalNote": "<string>",
"number": 123,
"outOfBandAmount": 123,
"refunds": [
{
"amount": 123,
"currencyCode": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"method": {
"label": "<string>"
}
}
],
"voidDate": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}Billing
Create a credit note
Create a credit note for an invoice.
OAuth
Required scopes:invoicesPOST
/
billing
/
credit_notes
/
v1
Create a credit note
curl --request POST \
--url https://api.spacebring.com/billing/credit_notes/v1 \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"creditNote": {
"invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lines": [
{
"invoiceItemRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"quantity": 4503599627370495
}
],
"creditAmount": 1,
"effectiveDate": "2023-11-07T05:31:56Z",
"internalNote": "<string>",
"outOfBandAmount": 1,
"refunds": [
{
"amount": 1,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
}
'import requests
url = "https://api.spacebring.com/billing/credit_notes/v1"
payload = { "creditNote": {
"invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lines": [
{
"invoiceItemRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 1,
"quantity": 4503599627370495
}
],
"creditAmount": 1,
"effectiveDate": "2023-11-07T05:31:56Z",
"internalNote": "<string>",
"outOfBandAmount": 1,
"refunds": [
{
"amount": 1,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
} }
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({
creditNote: {
invoiceRef: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
lines: [
{
invoiceItemRef: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount: 1,
quantity: 4503599627370495
}
],
creditAmount: 1,
effectiveDate: '2023-11-07T05:31:56Z',
internalNote: '<string>',
outOfBandAmount: 1,
refunds: [
{
amount: 1,
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
transactionRef: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
}
})
};
fetch('https://api.spacebring.com/billing/credit_notes/v1', 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.spacebring.com/billing/credit_notes/v1",
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([
'creditNote' => [
'invoiceRef' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'lines' => [
[
'invoiceItemRef' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount' => 1,
'quantity' => 4503599627370495
]
],
'creditAmount' => 1,
'effectiveDate' => '2023-11-07T05:31:56Z',
'internalNote' => '<string>',
'outOfBandAmount' => 1,
'refunds' => [
[
'amount' => 1,
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'transactionRef' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]
]),
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.spacebring.com/billing/credit_notes/v1"
payload := strings.NewReader("{\n \"creditNote\": {\n \"invoiceRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lines\": [\n {\n \"invoiceItemRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 1,\n \"quantity\": 4503599627370495\n }\n ],\n \"creditAmount\": 1,\n \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n \"internalNote\": \"<string>\",\n \"outOfBandAmount\": 1,\n \"refunds\": [\n {\n \"amount\": 1,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"transactionRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\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.spacebring.com/billing/credit_notes/v1")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"creditNote\": {\n \"invoiceRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lines\": [\n {\n \"invoiceItemRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 1,\n \"quantity\": 4503599627370495\n }\n ],\n \"creditAmount\": 1,\n \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n \"internalNote\": \"<string>\",\n \"outOfBandAmount\": 1,\n \"refunds\": [\n {\n \"amount\": 1,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"transactionRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spacebring.com/billing/credit_notes/v1")
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 \"creditNote\": {\n \"invoiceRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lines\": [\n {\n \"invoiceItemRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount\": 1,\n \"quantity\": 4503599627370495\n }\n ],\n \"creditAmount\": 1,\n \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n \"internalNote\": \"<string>\",\n \"outOfBandAmount\": 1,\n \"refunds\": [\n {\n \"amount\": 1,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"transactionRef\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"creditNote": {
"baseAmounts": {
"currencyCode": "<string>",
"grossAmount": 123,
"postPaymentAmount": 123,
"prePaymentAmount": 123,
"subtotalAmount": 123,
"subtotalAmountExcludingTax": 123,
"taxes": [
{
"amount": 123,
"inclusive": true,
"rate": 123,
"taxableAmount": 123
}
],
"totalAmount": 123,
"totalExcludingTaxAmount": 123
},
"createDate": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"logo": {
"key": "<string>",
"url": "<string>"
},
"title": "<string>",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"about": "<string>",
"email": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"photoUrl": "<string>",
"surname": "<string>"
}
},
"grossAmount": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lines": [
{
"baseAmounts": {
"currencyCode": "<string>",
"discountedAmount": 123,
"totalAmount": 123,
"totalExcludingTaxAmount": 123,
"tax": {
"amount": 123,
"inclusive": true,
"rate": 123,
"taxableAmount": 123
},
"unitAmount": 123,
"unitExcludingTaxAmount": 123
},
"createDate": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"discountedAmount": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceItemRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"networkRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"totalAmount": 123,
"totalExcludingTaxAmount": 123,
"updateDate": "2023-11-07T05:31:56Z",
"discounts": [
{
"coupon": {
"amountOff": 123,
"currencyCode": "<string>",
"duration": "<string>",
"durationInMonths": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"percentOff": 123,
"type": "<string>"
},
"promocode": {
"code": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiration": "2023-11-07T05:31:56Z",
"limitByFirstPurchase": true
},
"subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"quantity": 123,
"tax": {
"amount": 123,
"inclusive": true,
"rate": 123,
"taxableAmount": 123
},
"unitAmount": 123,
"unitExcludingTaxAmount": 123
}
],
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"networkRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pdfUrl": "<string>",
"postPaymentAmount": 123,
"prePaymentAmount": 123,
"subtotalAmount": 123,
"subtotalAmountExcludingTax": 123,
"taxes": [
{
"amount": 123,
"inclusive": true,
"rate": 123,
"taxableAmount": 123
}
],
"title": "<string>",
"totalAmount": 123,
"totalExcludingTaxAmount": 123,
"updateDate": "2023-11-07T05:31:56Z",
"creditAmount": 123,
"effectiveDate": "<string>",
"internalNote": "<string>",
"number": 123,
"outOfBandAmount": 123,
"refunds": [
{
"amount": 123,
"currencyCode": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"method": {
"label": "<string>"
}
}
],
"voidDate": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "<string>"
}Authorizations
BasicAuthOAuth2
See our authentication documentation for how to authorize your requests
Headers
The id of the network. Required when using bearer token authentication
Body
application/json
Credit note to create.
Show child attributes
Show child attributes
Response
Created
Show child attributes
Show child attributes
Was this page helpful?
⌘I