InvoiceService class

URL: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/invoice An Invoice represents a sales form where the customer pays for a product or service later.

Constructors

InvoiceService.new({required String baseUrl, required AuthenticationService authenticationService, int minorVersion = 63})

Properties

authenticationService → AuthenticationService

final

baseUrl → String

final

hashCode → int

The hash code for this object.

no setter, inherited

minorVersion → int

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createInvoice({required Invoice invoice, String? realmId, String? authToken}) → Future<Invoice>

Have at least one Line a sales item or inline subtotal. Have a populated CustomerRef element.

deleteInvoice({required Invoice invoice, String? realmId, String? authToken}) → Future<DeleteResponse>

This operation deletes the invoice object specified in the request body. Include a minimum of Invoice.Id and Invoice.SyncToken in the request body. You must unlink any linked transactions associated with the invoice object before deleting it.

getInvoicePdf({required String invoiceId, String? realmId, String? authToken}) → Future<Uint8List>

This resource returns the specified object in the response body as an Adobe Portable Document Format (PDF) file. The resulting PDF file is formatted according to custom form styles in the company settings.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

queryInvoice({required String query, String? realmId, String? authToken}) → Future<List<Invoice>>

Returns the results of the query.

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

Retrieves the details of an invoice that has been previously created.

sendInvoice({required String invoiceId, required String emailTo, String? realmId, String? authToken}) → Future<Invoice>

The Invoice.EmailStatus parameter is set to EmailSent. The Invoice.DeliveryInfo element is populated with sending information<./li> The Invoice.BillEmail.Address parameter is updated to the address specified with the value of the sendTo query parameter, if specified.

toString() → String

A string representation of this object.

inherited

updateInvoice({required Invoice invoice, String? realmId, String? authToken}) → Future<Invoice>

Use this operation to update any of the writable fields of an existing estimate object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body.

voidInvoice({required Invoice invoice, String? realmId, String? authToken}) → Future<Invoice>

Use this operation to void an existing invoice object; include a minimum of Invoice.Id and the current Invoice.SyncToken. The transaction remains active but all amounts and quantities are zeroed and the string, Voided, is injected into Invoice.PrivateNote, prepended to existing text if present.

Operators

operator ==(Object other) → bool

The equality operator.

inherited