GET
/
credit_notes
Authorization
Query
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/credit_notes?per_page=2&page=1" \
  --header "Authorization: Bearer $API_KEY"
{
  "credit_notes": [
    {
      "applied_taxes": [],
      "balance_amount_cents": 100,
      "coupons_adjustment_amount_cents": 20,
      "created_at": "2022-09-14T16:35:31Z",
      "credit_amount_cents": 100,
      "credit_status": "available",
      "currency": "EUR",
      "description": "Free text",
      "file_url": "https://getlago.com/credit_note/file",
      "invoice_number": "LAG-1234",
      "issuing_date": "2022-12-06",
      "items": [],
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "number": "LAG-1234-CN2",
      "reason": "other",
      "refund_amount_cents": 123,
      "refund_status": "pending",
      "sequential_id": 2,
      "sub_total_excluding_taxes_amount_cents": 100,
      "taxes_amount_cents": 20,
      "taxes_rate": 20,
      "total_amount_cents": 120,
      "updated_at": "2022-09-14T16:35:31Z"
    }
  ]
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer

Page number.

per_page
integer

Number of records per page.

external_customer_id
string

Unique identifier assigned to the customer in your application.

Response

200 - application/json
credit_notes
object[]
required