---
title: "Estimate amounts for a new credit note"
method: POST
path: "/credit_notes/estimate"
tags: ["credit_notes"]
---

# Estimate amounts for a new credit note

`POST /credit_notes/estimate`

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

## Request body

- CreditNoteEstimateInput
  - `credit_note` object, required
    - `invoice_id` string, uuid, required — The invoice unique identifier, created by Lago.
    - `items` object[], required — The list of credit note's items.
      - `fee_id` string, uuid, required — The fee unique identifier, created by Lago.
      - `amount_cents` integer, required — The amount of the credit note item, expressed in cents.

## Response `200`

Credit note amounts

- CreditNoteEstimated
  - `estimated_credit_note` object, required
    - `lago_invoice_id` string, uuid, required — Unique identifier assigned to the invoice that the credit note belongs to
    - `invoice_number` string, required — The invoice unique number, related to the credit note.
    - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STD' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW', required
    - `taxes_amount_cents` integer, required — The tax amount of the credit note, expressed in cents.
    - `precise_taxes_amount_cents` number, required — The precise tax amount of the credit note, expressed in cents with decimal precision.
    - `taxes_rate` number, required — The tax rate associated with this specific credit note.
    - `sub_total_excluding_taxes_amount_cents` integer, required — The subtotal of the credit note excluding any applicable taxes, expressed in cents.
    - `max_creditable_amount_cents` integer, required — The credited amount of the credit note, expressed in cents.
    - `max_refundable_amount_cents` integer, required — The refunded amount of the credit note, expressed in cents.
    - `max_offsettable_amount_cents` integer, required — The ofsetted amount of the credit note, expressed in cents.
    - `coupons_adjustment_amount_cents` integer, required — The pro-rated amount of the coupons applied to the source invoice.
    - `precise_coupons_adjustment_amount_cents` number, required — The precise pro-rated amount with decimal precision of the coupons applied to the source invoice.
    - `items` object[], required — Array of credit note's items.
      - `amount_cents` integer, required — The credit note's item amount, expressed in cents.
      - `lago_fee_id` string, uuid, nullable, required — Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.
    - `applied_taxes` object[]
      - `lago_tax_id` string, uuid — Unique identifier of the tax, created by Lago.
      - `tax_name` string — Name of the tax.
      - `tax_code` string — Unique code used to identify the tax associated with the API request.
      - `tax_rate` number — The percentage rate of the tax
      - `tax_description` string — Internal description of the taxe
      - `base_amount_cents` integer
      - `amount_cents` integer — Amount of the tax
      - `amount_currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STD' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW'

## Other responses

- `400` — Bad Request error
- `401` — Unauthorized error
- `422` — Unprocessable entity error

---

[API](https://skmtc.net/getlago/apis/lago-api-documentation.md) · [All operations](https://skmtc.net/getlago/apis/lago-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getlago/lago-api-documentation/versions/6e969ef3bb45/schema)