InvoiceService class

URL: https://developer.squareup.com/reference/square/invoices-api/list-invoices

The Invoices API lets you create and manage invoices for orders that were created using the Orders API. After you create the invoice and configure its delivery method, payment schedule, and other invoice settings, you can publish the invoice. Depending on the invoice settings, Square sends the invoice to the customer or automatically charges a card on file. Square also hosts each invoice on a web page where customers can easily pay for it.

Constructors

InvoiceService.new({required String baseUrl, required AuthenticationService authenticationService})

Properties

authenticationService → AuthenticationService

final

baseUrl → String

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cancelInvoice({required int invoiceId, required int version, String? authToken}) → Future<Invoice>

Cancels an invoice.

createInvoice({required CreateInvoiceRequest request, String? authToken}) → Future<Invoice>

Creates a draft invoice for an order created using the Orders API.

deleteInvoice({required int invoiceId, required int version, String? authToken}) → Future<bool>

Deletes the specified invoice.

listInvoices({required String locationId, String? cursor, int? limit, String? authToken}) → Future<InvoiceResponse>

Returns a list of invoices for a given location.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

publishInvoice({required String invoiceId, required PublishInvoiceRequest request, String? authToken}) → Future<Invoice>

Publishes the specified draft invoice.

readInvoice({required String invoiceId, String? authToken}) → Future<Invoice>

Retrieves an invoice by invoice ID.

searchInvoice({required SearchInvoiceRequest request, String? authToken}) → Future<InvoiceResponse>

Searches for invoices from a location specified in the filter.

toString() → String

A string representation of this object.

inherited

updateInvoice({required int invoiceId, required UpdateInvoiceRequest request, String? authToken}) → Future<Invoice>

Updates an invoice by modifying fields, clearing fields, or both.

Operators

operator ==(Object other) → bool

The equality operator.

inherited