cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/credit_notes/cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d/apply" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"credit_note": {
"invoices": [
{
"invoice_id": "INV-0001",
"amount": 5
}
]
}
}'from exsited import build_client
client = build_client()
response = client.credit_notes.apply_credit_note(
"cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d",
{"credit_note": {"invoices": [{"invoice_id": "INV-0001", "amount": 5}]}},
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.creditNotes.applyCreditNote('cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d', {
credit_note: {invoices: [{invoice_id: 'INV-0001', amount: 5}]},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->creditNotes->applyCreditNote('cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d', [
'credit_note' => ['invoices' => [['invoice_id' => 'INV-0001', 'amount' => 5]]],
]);
print_r($response->data);
import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.List;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<Dto> response = client.creditNotes().applyCreditNote(
"cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d",
Map.of(
"credit_note", Map.of(
"invoices", List.of(Map.of("invoice_id", "INV-0001", "amount", 5)))));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.CreditNotes.ApplyCreditNoteAsync(
"cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d",
new Dictionary<string, object?>
{
["credit_note"] = new Dictionary<string, object?>
{
["invoices"] = new List<object?>
{
new Dictionary<string, object?>
{
["invoice_id"] = "INV-0001",
["amount"] = 5,
},
},
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.creditNotes.applyCreditNote(
'cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d',
{
'credit_note': {
'invoices': [
{'invoice_id': 'INV-0001', 'amount': 5},
],
},
},
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.CreditNotes().ApplyCreditNote(context.Background(), "cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d", map[string]any{
"credit_note": map[string]any{
"invoices": []any{
map[string]any{"invoice_id": "INV-0001", "amount": 5},
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
Credit notes
Apply a credit note to invoices
Spends a credit note against one or more invoices and returns the credit note.
POST
/
credit_notes
/
{credit_note_id}
/
apply
cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/credit_notes/cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d/apply" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"credit_note": {
"invoices": [
{
"invoice_id": "INV-0001",
"amount": 5
}
]
}
}'from exsited import build_client
client = build_client()
response = client.credit_notes.apply_credit_note(
"cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d",
{"credit_note": {"invoices": [{"invoice_id": "INV-0001", "amount": 5}]}},
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.creditNotes.applyCreditNote('cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d', {
credit_note: {invoices: [{invoice_id: 'INV-0001', amount: 5}]},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->creditNotes->applyCreditNote('cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d', [
'credit_note' => ['invoices' => [['invoice_id' => 'INV-0001', 'amount' => 5]]],
]);
print_r($response->data);
import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.List;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<Dto> response = client.creditNotes().applyCreditNote(
"cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d",
Map.of(
"credit_note", Map.of(
"invoices", List.of(Map.of("invoice_id", "INV-0001", "amount", 5)))));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.CreditNotes.ApplyCreditNoteAsync(
"cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d",
new Dictionary<string, object?>
{
["credit_note"] = new Dictionary<string, object?>
{
["invoices"] = new List<object?>
{
new Dictionary<string, object?>
{
["invoice_id"] = "INV-0001",
["amount"] = 5,
},
},
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.creditNotes.applyCreditNote(
'cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d',
{
'credit_note': {
'invoices': [
{'invoice_id': 'INV-0001', 'amount': 5},
],
},
},
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.CreditNotes().ApplyCreditNote(context.Background(), "cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d", map[string]any{
"credit_note": map[string]any{
"invoices": []any{
map[string]any{"invoice_id": "INV-0001", "amount": 5},
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
Applies the credit note to each invoice listed under
credit_note.invoices, each entry with only invoice_id and amount. It records a payment against each invoice and a journal posting, and returns the credit note.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The credit note's id, which starts with cn_.
Body
application/json
Show child attributes
Show child attributes
Response
200
The credit note after the application.