The credit note object

This object represents a credit note, used to refund or credit back a customer for a fee or an invoice.

The credit note object

{
  "credit_note": {
    "lago_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
    "sequential_id": 2,
    "number": "LAG-1234-CN2",
    "lago_invoice_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
    "invoice_number": "LAG-1234",
    "issuing_date": "2022-12-06",
    "credit_status": "available",
    "refund_status": "pending",
    "reason": "other",
    "description": "Free text",
    "currency": "EUR",
    "total_amount_cents": 120,
    "total_amount_currency": "EUR",
    "credit_amount_cents": 100,
    "credit_amount_currency": "EUR",
    "refund_amount_cents": 0,
    "refund_amount_currency": "EUR",
    "balance_amount_cents": 100,
    "balance_amount_currency": "EUR",
    "vat_amount_cents": 20,
    "vat_amount_currency": "EUR",
    "sub_total_vat_excluded_amount_cents": 100,
    "sub_total_vat_excluded_amount_currency": "EUR",
    "coupons_adjustement_amount_cents": 0,
    "created_at": "2022-10-06 09:52:00",
    "updated_at": "2022-10-06 09:52:00",
    "file_url": "https://getlago.com/credit_note/file",
    "items": [
      {
        "lago_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
        "amount_cents": 100,
        "amount_currency": "EUR",
        "fee":       {
          "lago_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
          "item": {
            "type": "charge",
            "code": "user_seats",
            "name": "User Seats"
          },
          "amount_cents": 100,
          "amount_currency": "EUR",
          "vat_amount_cents": 20,
          "vat_amount_currency": "EUR",
          "total_amount_cents": 120,
          "total_amount_currency": "EUR",
          "units": 12.6,
          "events_count": 10
        }
      }
    ]
  }
}

Attributes

credit_note · object

Hide object

lago_id · string · required

The credit note unique identifier, created by Lago.

sequential_id · integer · required

The sequential identifier of the credit note, specifically scoped on the associated invoice. It provides a unique numerical identifier for the credit note within the context of the invoice.

number · string · required

The credit note unique number.

invoice_number · string · required

The invoice unique number, related to the credit note.

issuing_date · string · required

The date of creation of the credit note. It follows the ISO 8601 date format and provides the specific date when the credit note was created.

reason · string · required

The reason of the credit note creation. Possible values are duplicated_charge, product_unsatisfactory, order_change, order_cancellation, fraudulent_charge or other.

credit_status · string

The status of the credit portion of the credit note. It indicates the current state or condition of the credit amount associated with the credit note. The possible values for this field are:

• available: this status indicates that an amount remains available for future usage. The credit can be applied towards future transactions or invoices.

• consumed: this status indicates that the credit amount has been fully consumed. The remaining amount is 0, indicating that the credit has been utilized in its entirety.

• voided: this status indicates that the remaining amount of the credit cannot be used any further. The credit has been voided and is no longer available for application or redemption.

refund_status · string

The status of the refund portion of the credit note. It indicates the current state or condition of the refund associated with the credit note. The possible values for this field are:

• pending: this status indicates that the refund is pending execution. The refund request has been initiated but has not been processed or completed yet.

• succeeded: this status indicates that the refund has been successfully executed. The refund amount has been processed and returned to the customer or the designated recipient.

• failed: this status indicates that the refund failed to execute. The refund request encountered an error or unsuccessful processing, and the refund amount could not be returned.

currency · string · required

The currency of the credit note.

total_amount_cents · integer · required

The total amount of the credit note, expressed in cents.

total_amount_currency · string · required

The currency of the total amount of the credit note.

credit_amount_cents · integer · required

The credited amount of the credit note, expressed in cents.

credit_amount_currency · string · required

credit_amount_currency.

refund_amount_cents · integer · required

The refunded amount of the credit note, expressed in cents.

refund_amount_currency · string · required

The currency of the total refunded amount of the credit note.

balance_amount_cents · integer · required

The remaining credit note amount, expressed in cents.

balance_amount_currency · string · required

The currency of the total remaining amount of the credit note.

vat_amount_cents · integer · required

The tax amount of the credit note, expressed in cents.

vat_amount_currency · string · required

The currency of the tax amount of the credit note.

sub_total_vat_excluded_amount_cents · integer · required

The subtotal of the credit note excluding any applicable taxes, expressed in cents.

sub_total_vat_excluded_amount_currency · string · required

The currency of the subtotal amount of the credit note, excluding any applicable taxes.

coupons_adjustement_amount_cents · integer · required

The pro-rated amount of the coupons applied to the source invoice.

created_at · string · required

The date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC).

file_url · string

The PDF file of the credit note.

items · array

Show items

lago_id · string · required

The credit note’s item unique identifier, created by Lago.

amount_cents · integer · required

The credit note’s item amount, expressed in cents.

amount_currency · string · required

The credit note’s item currency.

fee · object

Show fee

lago_id · string · required

The fee item unique identifier, created by Lago.

code · string · required

The code of the fee item.

type · string · required

The type of the fee item.