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

ListInvoiceLineItems

CreateInvoiceLineItem

UpdateInvoiceLineItem

DeleteInvoiceLineItem

GetInvoiceLineItemWith

Types

CreateInvoiceLineItem

data class CreateInvoiceLineItem(val invoiceId: String) : InvoiceLineItemEndpoints

Endpoint for creating a new line item on an invoice.

DeleteInvoiceLineItem

data class DeleteInvoiceLineItem(val invoiceId: String, val invoiceLineItemId: String) : InvoiceLineItemEndpoints

Endpoint for deleting a line item from an invoice.

GetInvoiceLineItemWith

data class GetInvoiceLineItemWith(val invoiceId: String, val invoiceLineItemId: String) : InvoiceLineItemEndpoints

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

ListInvoiceLineItems

data class ListInvoiceLineItems(val invoiceId: String) : InvoiceLineItemEndpoints

Endpoint for retrieving all line items belonging to an invoice.

UpdateInvoiceLineItem

data class UpdateInvoiceLineItem(val invoiceId: String, val invoiceLineItemId: String) : InvoiceLineItemEndpoints

Endpoint for updating an existing line item on an invoice.

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 fully qualified URL string for this endpoint.

httpMethod

open override val httpMethod: String

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

queryItems

open override val queryItems: List<QueryItem>? = null

Optional query-string parameters appended to endpointURL.