cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/credit_notes?limit=20" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.credit_notes.get_credit_notes({"limit": 20})
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.creditNotes.getCreditNotes({limit: 20});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->creditNotes->getCreditNotes(['limit' => 20]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.credit_notes.credit_notes_dto.CreditNotesDto.CreditNoteList;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<CreditNoteList> response = client.creditNotes().getCreditNotes(Map.of("limit", 20));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.CreditNotes.GetCreditNotesAsync(new Dictionary<string, object?> { ["limit"] = 20 });
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.creditNotes.getCreditNotes(
queryParams: {'limit': 20},
);
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().GetCreditNotes(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"data": [
{
"object": "<string>",
"id": "<string>",
"status": "<string>",
"code": "<string>",
"account": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"payment": {
"href": "<string>",
"id": "<string>",
"object": "<string>"
},
"invoices": [
{
"href": "<string>",
"id": "<string>",
"object": "<string>"
}
],
"issue_date": "<string>",
"initial_amount": "<string>",
"refund_amount": "<string>",
"remaining_amount": "<string>",
"refundable": true,
"custom_attributes": [
{
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>",
"type": "<string>",
"value": "<unknown>"
}
],
"created_on": "<string>",
"last_updated_on": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"version": 123,
"href": "<string>"
}
],
"object": "<string>",
"pagination": {
"limit": 123,
"has_more": true,
"next_cursor": "<string>",
"prev_cursor": "<string>",
"links": {
"next": "<string>",
"prev": "<string>"
}
},
"url": "<string>"
}Credit notes
List credit notes
Returns one page of credit notes.
GET
/
credit_notes
cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/credit_notes?limit=20" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.credit_notes.get_credit_notes({"limit": 20})
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.creditNotes.getCreditNotes({limit: 20});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->creditNotes->getCreditNotes(['limit' => 20]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.credit_notes.credit_notes_dto.CreditNotesDto.CreditNoteList;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<CreditNoteList> response = client.creditNotes().getCreditNotes(Map.of("limit", 20));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.CreditNotes.GetCreditNotesAsync(new Dictionary<string, object?> { ["limit"] = 20 });
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.creditNotes.getCreditNotes(
queryParams: {'limit': 20},
);
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().GetCreditNotes(context.Background(), map[string]any{"limit": 20}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"data": [
{
"object": "<string>",
"id": "<string>",
"status": "<string>",
"code": "<string>",
"account": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"payment": {
"href": "<string>",
"id": "<string>",
"object": "<string>"
},
"invoices": [
{
"href": "<string>",
"id": "<string>",
"object": "<string>"
}
],
"issue_date": "<string>",
"initial_amount": "<string>",
"refund_amount": "<string>",
"remaining_amount": "<string>",
"refundable": true,
"custom_attributes": [
{
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>",
"type": "<string>",
"value": "<unknown>"
}
],
"created_on": "<string>",
"last_updated_on": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"version": 123,
"href": "<string>"
}
],
"object": "<string>",
"pagination": {
"limit": 123,
"has_more": true,
"next_cursor": "<string>",
"prev_cursor": "<string>",
"links": {
"next": "<string>",
"prev": "<string>"
}
},
"url": "<string>"
}Lists every credit note, one page at a time, under
data. Each record carries its code, the initial_amount, refund_amount and remaining_amount as strings, and whether it is refundable. To filter, add filter_<field>=<value>, or filter_<field>_<operator>=<value> with an operator such as gte or contains.
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.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Query Parameters
The most records to return on one page.
Example:
20
The next_cursor value from the previous page, to fetch the page after it.
The field to sort by. Put - in front for descending order, such as -created_on.
Example:
"-created_on"