FrameSDK/com.framepayments.framesdk.invoices/InvoiceEndpoints/GetInvoices

GetInvoices

data class GetInvoices(val perPage: Int? = null, val page: Int? = null, val customer: String? = null, val account: String? = null, val status: InvoiceStatus? = null) : InvoiceEndpoints

Endpoint for retrieving a paginated, optionally filtered list of invoices (GET /v1/invoices).

Constructors

GetInvoices

constructor(perPage: Int? = null, page: Int? = null, customer: String? = null, account: String? = null, status: InvoiceStatus? = null)

Properties

account

val account: String? = null

The account ID to filter results by.

additionalHeaders

open val additionalHeaders: Map<String, String>

Optional extra HTTP headers to attach to the request (e.g. Accept: application/json). Defaults to empty. Applied after the standard Frame Authorization/User-Agent headers but before Content-Type (set on POST/PATCH), so an entry may override the former but not the latter. Prefer supplemental headers like Accept; don't rely on this to set auth headers.

customer

val customer: String? = null

The customer ID to filter results by.

endpointURL

open override val endpointURL: String

The URL path for this endpoint.

httpMethod

open override val httpMethod: String

The HTTP method for this endpoint.

page

val page: Int? = null

The page number to retrieve.