Credit Notes
List Credit Notes by Account
GET
/
account
/
{id}
/
credit-notes
curl "https://api.alguna.io/account/acc_abc123/credit-notes?page=1&limit=20" \
-H "Authorization: Bearer YOUR_API_KEY"
const creditNotes = await alguna.creditNotes.list('acc_abc123', {
page: 1,
limit: 20
});
{
"items": [
{
"id": "cn_xyz789",
"accountId": "acc_abc123",
"status": "issued",
"total": "100.00",
"currency": "USD",
"createdAt": "2024-01-20T10:00:00Z"
},
{
"id": "cn_abc456",
"accountId": "acc_abc123",
"status": "applied",
"total": "50.00",
"currency": "USD",
"createdAt": "2024-01-15T08:00:00Z"
}
],
"pageCount": 1,
"limit": 20
}
List all credit notes for an account with pagination.
string
required
The account ID.
integer
Page number (default: 1).
integer
Items per page (default: 20, max: 100).
curl "https://api.alguna.io/account/acc_abc123/credit-notes?page=1&limit=20" \
-H "Authorization: Bearer YOUR_API_KEY"
const creditNotes = await alguna.creditNotes.list('acc_abc123', {
page: 1,
limit: 20
});
{
"items": [
{
"id": "cn_xyz789",
"accountId": "acc_abc123",
"status": "issued",
"total": "100.00",
"currency": "USD",
"createdAt": "2024-01-20T10:00:00Z"
},
{
"id": "cn_abc456",
"accountId": "acc_abc123",
"status": "applied",
"total": "50.00",
"currency": "USD",
"createdAt": "2024-01-15T08:00:00Z"
}
],
"pageCount": 1,
"limit": 20
}
array
Array of credit note objects.
integer
Total number of pages.
integer
Items per page.
⌘I
curl "https://api.alguna.io/account/acc_abc123/credit-notes?page=1&limit=20" \
-H "Authorization: Bearer YOUR_API_KEY"
const creditNotes = await alguna.creditNotes.list('acc_abc123', {
page: 1,
limit: 20
});
{
"items": [
{
"id": "cn_xyz789",
"accountId": "acc_abc123",
"status": "issued",
"total": "100.00",
"currency": "USD",
"createdAt": "2024-01-20T10:00:00Z"
},
{
"id": "cn_abc456",
"accountId": "acc_abc123",
"status": "applied",
"total": "50.00",
"currency": "USD",
"createdAt": "2024-01-15T08:00:00Z"
}
],
"pageCount": 1,
"limit": 20
}