POST
/
credit_notes
/
{lago_id}
/
download
Authorization
Path
LAGO_URL="https://api.getlago.com"
CREDIT_NOTE_ID="__CREDIT_NOTE_ID__"
API_KEY="__YOUR_API_KEY__"

curl --location --request POST "$LAGO_URL/api/v1/credit_notes/$CREDIT_NOTE_ID/download" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json'
{
  "credit_note": {
    "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.

Path Parameters

lago_id
string
required

The credit note unique identifier, created by Lago.

Response

200 - application/json
credit_note
object
required