PaymentService class

URL: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/payment A Payment object records a payment in QuickBooks. The payment can be applied for a particular customer against multiple Invoices and Credit Memos. It can also be created without any Invoice or Credit Memo, by just specifying an amount.

Constructors

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

createPayment({required Payment payment, String? realmId, String? authToken}) → Future<Payment>

Creates a payment

deletePayment({required Payment payment, String? realmId, String? authToken}) → Future<DeleteResponse>

This operation deletes the Payment object specified in the request body. Include a minimum of Payment.Id and Payment.SyncToken in the request body.

getPaymentPdf({required String paymentId, 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

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

Returns the results of the query.

readPayment({required String paymentId, String? realmId, String? authToken}) → Future<Payment>

Retrieves the details of a Payment object that has been previously created.

sendPayment({required String paymentId, required String emailTo, String? realmId, String? authToken}) → Future<Payment>

Sends a payment to the specified email.

toString() → String

A string representation of this object.

inherited

updatePayment({required Payment payment, String? realmId, String? authToken}) → Future<Payment>

Use this operation to update any of the writable fields of an existing Payment 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.

voidPayment({required Payment payment, String? realmId, String? authToken}) → Future<Payment>

Use a sparse update operation with include=void to void an existing Payment object; include a minimum of Payment.Id and Payment.SyncToken.The transaction remains active but all amounts and quantities are zeroed and the string, Voided, is injected into Payment.PrivateNote, prepended to existing text if present. If funds for the payment have been deposited, you must delete the associated deposit object before voiding the payment object.

Operators

operator ==(Object other) → bool

The equality operator.

inherited