FrameSDK/com.framepayments.framesdk.invoices/InvoiceEndpoints

InvoiceEndpoints

sealed class InvoiceEndpoints : FrameNetworkingEndpoints

Defines the API endpoints available for invoice operations.

Each case maps to a specific URL path, HTTP method, and optional query parameters used by the networking layer to construct requests.

Inheritors

Types

object CreateInvoice : InvoiceEndpoints

Endpoint for creating a new invoice (POST /v1/invoices).

data class DeleteInvoice(val invoiceId: String) : InvoiceEndpoints

Endpoint for deleting an invoice (DELETE /v1/invoices/{invoiceId}).

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

data class GetInvoiceWith(val invoiceId: String) : InvoiceEndpoints

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

data class IssueInvoice(val invoiceId: String) : InvoiceEndpoints

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

data class UpdateInvoice(val invoiceId: String) : InvoiceEndpoints

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

Properties

open override val endpointURL: String

The URL path for this endpoint.

open override val httpMethod: String

The HTTP method for this endpoint.

open override val queryItems: List<QueryItem>?

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