List Credit Notes by Account

GET /account/{id}/credit-notes

cURL

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.

id · string · required

The account ID.

page · integer

Page number (default: 1).

limit · integer

Items per page (default: 20, max: 100).

cURL

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
}

items · array

Array of credit note objects.

pageCount · integer

Total number of pages.

limit · integer

Items per page.