Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

Latest commit

 

History

History
69 lines (49 loc) · 5 KB

CreditNoteObject.md

File metadata and controls

69 lines (49 loc) · 5 KB

CreditNoteObject

Properties

Name Type Description Notes
lagoId UUID The credit note unique identifier, created by Lago.
sequentialId Integer 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 The credit note unique number.
lagoInvoiceId UUID Unique identifier assigned to the invoice that the credit note belongs to
invoiceNumber String The invoice unique number, related to the credit note.
issuingDate LocalDate 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.
creditStatus CreditStatusEnum 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. [optional]
refundStatus RefundStatusEnum 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. [optional]
reason ReasonEnum The reason of the credit note creation. Possible values are `duplicated_charge`, `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge` or `other`.
description String The description of the credit note. [optional]
currency Currency
totalAmountCents Integer The total amount of the credit note, expressed in cents.
taxesAmountCents Integer The tax amount of the credit note, expressed in cents.
taxesRate BigDecimal The tax rate associated with this specific credit note.
subTotalExcludingTaxesAmountCents Integer The subtotal of the credit note excluding any applicable taxes, expressed in cents.
balanceAmountCents Integer The remaining credit note amount, expressed in cents.
creditAmountCents Integer The credited amount of the credit note, expressed in cents.
refundAmountCents Integer The refunded amount of the credit note, expressed in cents.
couponsAdjustmentAmountCents Integer The pro-rated amount of the coupons applied to the source invoice.
createdAt OffsetDateTime The date when the credit note was created. It is expressed in Coordinated Universal Time (UTC).
updatedAt OffsetDateTime The date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC).
fileUrl String The PDF file of the credit note. [optional]
items List<CreditNoteItemObject> Array of credit note’s items. [optional]
appliedTaxes List<CreditNoteAppliedTaxObject> [optional]

Enum: CreditStatusEnum

Name Value
AVAILABLE "available"
CONSUMED "consumed"
VOIDED "voided"

Enum: RefundStatusEnum

Name Value
PENDING "pending"
SUCCEEDED "succeeded"
FAILED "failed"

Enum: ReasonEnum

Name Value
DUPLICATED_CHARGE "duplicated_charge"
PRODUCT_UNSATISFACTORY "product_unsatisfactory"
ORDER_CHANGE "order_change"
ORDER_CANCELLATION "order_cancellation"
FRAUDULENT_CHARGE "fraudulent_charge"
OTHER "other"