FrameSDK/com.framepayments.framesdk.invoicelineitems/InvoiceLineItemEndpoints

InvoiceLineItemEndpoints

sealed class InvoiceLineItemEndpoints : FrameNetworkingEndpoints

Defines the network endpoints used by InvoiceLineItemsAPI to manage invoice line items.

Each subclass represents a distinct API operation and supplies the correct endpointURL and httpMethod for that operation.

Inheritors

Types

Link copied to clipboard
data class CreateInvoiceLineItem(val invoiceId: String) : InvoiceLineItemEndpoints

Endpoint for creating a new line item on an invoice.

Link copied to clipboard
data class DeleteInvoiceLineItem(val invoiceId: String, val invoiceLineItemId: String) : InvoiceLineItemEndpoints

Endpoint for deleting a line item from an invoice.

Link copied to clipboard
data class GetInvoiceLineItemWith(val invoiceId: String, val invoiceLineItemId: String) : InvoiceLineItemEndpoints

Endpoint for retrieving a single line item by its identifier from an invoice.

Link copied to clipboard
data class ListInvoiceLineItems(val invoiceId: String) : InvoiceLineItemEndpoints

Endpoint for retrieving all line items belonging to an invoice.

Link copied to clipboard
data class UpdateInvoiceLineItem(val invoiceId: String, val invoiceLineItemId: String) : InvoiceLineItemEndpoints

Endpoint for updating an existing line item on an invoice.

Properties

Link copied to clipboard
open override val endpointURL: String

The fully qualified URL string for this endpoint.

Link copied to clipboard
open override val httpMethod: String

HTTP method, e.g. "GET", "POST", "DELETE".

Link copied to clipboard
open override val queryItems: List<QueryItem>? = null

Optional query-string parameters appended to endpointURL.