GetInvoices

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

Constructors

constructor(perPage: Int? = null, page: Int? = null, customer: String? = null, account: String? = null, status: InvoiceStatus? = null)

val account: String? = null

The account ID to filter results by.

The customer ID to filter results by.

open override val endpointURL: String

The URL path for this endpoint.

open override val httpMethod: String

The HTTP method for this endpoint.

val page: Int? = null

The page number to retrieve.

val perPage: Int? = null

The number of results to return per page.

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

The InvoiceStatus to filter results by.