FrameSDK/com.framepayments.framesdk.invoicelineitems/InvoiceLineItemsAPI

InvoiceLineItemsAPI

object InvoiceLineItemsAPI

Provides coroutine-based and callback-based methods for managing invoice line items.

Each operation returns or delivers a pair of a nullable result and a nullable NetworkingError. Exactly one of the two will be non-null on completion.

Functions

createInvoiceLineItem

suspend fun createInvoiceLineItem(invoiceId: String, request: InvoiceLineItemRequests.CreateLineItemRequest): Pair<InvoiceLineItem?, NetworkingError?>

Creates a new line item on the specified invoice.

fun createInvoiceLineItem(invoiceId: String, request: InvoiceLineItemRequests.CreateLineItemRequest, completionHandler: (InvoiceLineItem?, NetworkingError?) -> Unit)

Creates a new line item on the specified invoice, delivering the result via a callback.

deleteInvoiceLineItem

suspend fun deleteInvoiceLineItem(invoiceId: String, invoiceLineItemId: String): Pair<InvoiceLineItemResponses.DeletedInvoiceLineItemResponse?, NetworkingError?>

Deletes a line item from the specified invoice.

fun deleteInvoiceLineItem(invoiceId: String, invoiceLineItemId: String, completionHandler: (InvoiceLineItemResponses.DeletedInvoiceLineItemResponse?, NetworkingError?) -> Unit)

Deletes a line item from the specified invoice, delivering the result via a callback.

getInvoiceLineItems

suspend fun getInvoiceLineItems(invoiceId: String): Pair<InvoiceLineItemResponses.ListInvoiceLineItemsResponse?, NetworkingError?>

Retrieves all line items belonging to the specified invoice.

fun getInvoiceLineItems(invoiceId: String, completionHandler: (InvoiceLineItemResponses.ListInvoiceLineItemsResponse?, NetworkingError?) -> Unit)

Retrieves all line items belonging to the specified invoice, delivering the result via a callback.

getInvoiceLineItemWith

suspend fun getInvoiceLineItemWith(invoiceId: String, invoiceLineItemId: String): Pair<InvoiceLineItem?, NetworkingError?>

Retrieves a single line item by its identifier from the specified invoice.

fun getInvoiceLineItemWith(invoiceId: String, invoiceLineItemId: String, completionHandler: (InvoiceLineItem?, NetworkingError?) -> Unit)

Retrieves a single line item by its identifier from the specified invoice, delivering the result via a callback.

updateInvoiceLineItem

suspend fun updateInvoiceLineItem(invoiceId: String, invoiceLineItemId: String, request: InvoiceLineItemRequests.UpdateLineItemRequest): Pair<InvoiceLineItem?, NetworkingError?>

Updates an existing line item on the specified invoice.

fun updateInvoiceLineItem(invoiceId: String, invoiceLineItemId: String, request: InvoiceLineItemRequests.UpdateLineItemRequest, completionHandler: (InvoiceLineItem?, NetworkingError?) -> Unit)

Updates an existing line item on the specified invoice, delivering the result via a callback.