FrameSDK/com.framepayments.framesdk.invoices/InvoiceRequests/UpdateInvoiceRequest

UpdateInvoiceRequest

data class UpdateInvoiceRequest(val collectionMethod: InvoiceCollectionMethod? = null, val netTerms: Int? = null, val lineItems: List<LineItem>? = null, val dueDate: String? = null, val autoAdvance: Boolean? = null, val number: String? = null, val description: String? = null, val memo: String? = null, val metadata: Map<String, String>? = null)

Request body for updating an existing invoice.

All fields are optional; only non-null values are applied to the invoice.

Constructors

UpdateInvoiceRequest

constructor(collectionMethod: InvoiceCollectionMethod? = null, netTerms: Int? = null, lineItems: List<LineItem>? = null, dueDate: String? = null, autoAdvance: Boolean? = null, number: String? = null, description: String? = null, memo: String? = null, metadata: Map<String, String>? = null)

Properties

@SerializedName(value = "auto_advance")

val autoAdvance: Boolean? = null

When true, automatically advances the invoice to the next status when its conditions are met.

collectionMethod

@SerializedName(value = "collection_method")

val collectionMethod: InvoiceCollectionMethod? = null

Replaces how payment is collected for this invoice.

val description: String? = null

Replaces the customer-facing description of the invoice.

@SerializedName(value = "due_date")

val dueDate: String? = null

Replaces the explicit due date (ISO 8601 date string).

@SerializedName(value = "line_items")

val lineItems: List<LineItem>? = null

Replaces the full list of line items on the invoice.

val memo: String? = null

Replaces the internal memo visible only to the merchant.

val metadata: Map<String, String>? = null

Replaces the arbitrary key-value pairs attached to the invoice.

@SerializedName(value = "net_terms")

val netTerms: Int? = null

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

val number: String? = null

Replaces the merchant-assigned number for the invoice.