Estimate a credit note

This endpoint allows you to retrieve amounts for a new credit note creation.

POST /credit_notes/estimate

Estimate amounts for a new credit note

cURL

curl --request POST \
  --url https://api.getlago.com/api/v1/credit_notes/estimate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "credit_note": {
    "invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "items": [
      {
        "fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "amount_cents": 10
      },
      {
        "fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a91",
        "amount_cents": 5
      }
    ]
  }
}
'

200

{
  "estimated_credit_note": {
    "lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "invoice_number": "LAG-1234",
    "currency": "EUR",
    "taxes_amount_cents": 20,
    "precise_taxes_amount_cents": 20.1,
    "taxes_rate": 20,
    "sub_total_excluding_taxes_amount_cents": 100,
    "max_creditable_amount_cents": 100,
    "max_refundable_amount_cents": 0,
    "max_offsettable_amount_cents": 0,
    "coupons_adjustment_amount_cents": 20,
    "precise_coupons_adjustment_amount_cents": 20.1,
    "items": [
      {
        "amount_cents": 100,
        "lago_fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
      }
    ],
    "applied_taxes": [
      {
        "lago_tax_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "tax_name": "TVA",
        "tax_code": "french_standard_vat",
        "tax_rate": 20,
        "tax_description": "French standard VAT",
        "base_amount_cents": 100,
        "amount_cents": 2000,
        "amount_currency": "USD"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

Credit note estimate payload

credit_note · object · required

Show child attributes

Response

200

application/json

Credit note amounts

estimated_credit_note · object · required

Show child attributes