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).

GetInvoiceWith

data class GetInvoiceWith(val invoiceId: String) : InvoiceEndpoints

Endpoint for retrieving a single invoice by identifier (GET /v1/invoices/{invoiceId}).

IssueInvoice

data class IssueInvoice(val invoiceId: String) : InvoiceEndpoints

Endpoint for issuing a draft invoice to the customer (POST /v1/invoices/{invoiceId}/issue).

UpdateInvoice

data class UpdateInvoice(val invoiceId: String) : InvoiceEndpoints

Endpoint for updating an existing invoice (PATCH /v1/invoices/{invoiceId}).

Properties

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.

endpointURL

open override val endpointURL: String

The URL path for this endpoint.

httpMethod

open override val httpMethod: String

The HTTP method for this endpoint.

queryItems

open override val queryItems: List<QueryItem>?

The query parameters to append to the request URL, or null if none apply.