Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.borga.is/llms.txt

Use this file to discover all available pages before exploring further.

A credit note is a legal document that records a reduction in the amount owed on an invoice. Borga generates credit notes automatically whenever a refund is processed against a paid invoice. You cannot create credit notes directly — retrieve them here to reconcile refunds in your accounting system.
Credit notes are created automatically when a refund is processed. You can filter by invoice to find all credit notes associated with a specific invoice.

​
List credit notes

GET /v1/credit_notes Returns a paginated list of credit notes, ordered by creation date descending.

​
Query parameters

​
invoice
string
Filter by invoice ID. Returns only credit notes issued against the specified invoice.
​
limit
number
Maximum number of credit notes to return per page.
curl --request GET \
  --url "https://api.borga.is/v1/credit_notes?invoice=inv_01hx9z3k2mfq7nbvd4cw8ej5rt" \
  --header "Authorization: Bearer sk_live_..." \
  --header "X-Merchant-Id: mer_xxx"

​
Response fields

​
data
object[]
required
Array of credit note objects.
​
has_more
boolean
required
Whether more credit notes exist beyond this page.
{
  "data": [
    {
      "id": "cn_01hx9z3k2mfq7nbvd4cw8ej5rt",
      "invoice": "inv_01hx9z3k2mfq7nbvd4cw8ej5rt",
      "amount": 4990,
      "currency": "ISK",
      "reason": "duplicate",
      "status": "issued",
      "created_at": "2026-04-29T14:30:00Z"
    }
  ],
  "has_more": false
}

​
Retrieve a credit note

GET /v1/credit_notes/{id} Retrieves the details of an existing credit note.

​
Path parameters

​
id
string
required
The ID of the credit note to retrieve.
curl --request GET \
  --url https://api.borga.is/v1/credit_notes/cn_01hx9z3k2mfq7nbvd4cw8ej5rt \
  --header "Authorization: Bearer sk_live_..." \
  --header "X-Merchant-Id: mer_xxx"

​
Response fields

​
id
string
required
Unique credit note identifier.
​
invoice
string
required
ID of the invoice this credit note was issued against.
​
amount
number
required
Amount credited.
​
currency
string
required
Three-letter ISO 4217 currency code.
​
reason
string
Reason for the credit note (e.g. duplicate, fraudulent, order_change, product_unsatisfactory).
​
status
string
required
Current status of the credit note.
​
created_at
string
required
ISO 8601 timestamp of when the credit note was created.
{
  "id": "cn_01hx9z3k2mfq7nbvd4cw8ej5rt",
  "invoice": "inv_01hx9z3k2mfq7nbvd4cw8ej5rt",
  "amount": 4990,
  "currency": "ISK",
  "reason": "duplicate",
  "status": "issued",
  "created_at": "2026-04-29T14:30:00Z"
}