FrameSDK/com.framepayments.framesdk.invoices/Invoice

Invoice

data class Invoice(val id: String?, val customer: FrameObjects.Customer?, val total: Int?, val currency: String?, val status: InvoiceStatus?, val memo: String?, val livemode: Boolean?, val metadata: Map<String, String> = emptyMap(), val created: Int?, val updated: Int?, val invoiceObject: String?, val lineItems: List<LineItem> = emptyList(), val collectionMethod: InvoiceCollectionMethod?, val netTerms: Int?, val invoiceNumber: String?, val invoiceDescription: String?)

Represents an invoice issued to a customer.

Constructors

constructor(id: String?, customer: FrameObjects.Customer?, total: Int?, currency: String?, status: InvoiceStatus?, memo: String?, livemode: Boolean?, metadata: Map<String, String> = emptyMap(), created: Int?, updated: Int?, invoiceObject: String?, lineItems: List<LineItem> = emptyList(), collectionMethod: InvoiceCollectionMethod?, netTerms: Int?, invoiceNumber: String?, invoiceDescription: String?)

Properties

collectionMethod

@SerializedName(value = "collection_method")

val collectionMethod: InvoiceCollectionMethod?

How payment is collected for this invoice.

val created: Int?

Unix timestamp of when the invoice was created.

val currency: String?

The ISO 4217 currency code for the invoice amount.

val customer: FrameObjects.Customer?

The customer this invoice was issued to.

val id: String?

Unique identifier for the invoice.

invoiceDescription

@SerializedName(value = "description")

val invoiceDescription: String?

A customer-facing description of the invoice.

@SerializedName(value = "invoice_number")

val invoiceNumber: String?

The merchant-assigned number for this invoice.

@SerializedName(value = "object")

val invoiceObject: String?

The object type identifier returned by the API (e.g., "invoice").

@SerializedName(value = "line_items")

val lineItems: List<LineItem>

The list of line items included on the invoice.

val livemode: Boolean?

Whether the invoice was created in live mode (true) or test mode (false).

val memo: String?

An internal memo visible only to the merchant.

val metadata: Map<String, String>

Arbitrary key-value pairs the merchant can attach for their own reference.

@SerializedName(value = "net_terms")

val netTerms: Int?

The number of days from issuance until the invoice is due.

val status: InvoiceStatus?

The current lifecycle status of the invoice.

val total: Int?

The total amount due, in the smallest currency unit (e.g., cents).

val updated: Int?

Unix timestamp of when the invoice was last updated.