InvoicePaymentRequest class
Constructors
-
InvoicePaymentRequest({InvoiceAutomaticPaymentSource? automaticPaymentSource, String? cardId, Money? computedAmountMoney, String? dueDate, Money? fixedAmountRequestedMoney, String? percentageRequested, List<InvoicePaymentReminder>? reminders, InvoiceRequestType? requestType, Money? roundedAdjustmentIncludedMoney, bool? tippingEnabled, Money? totalCompletedAmountMoney, String? uid})
-
const
-
InvoicePaymentRequest.fromJson(Map<String, dynamic> json)
-
Converts a Map<String,
dynamic> to a InvoicePaymentRequest
factory
Properties
-
automaticPaymentSource
→ InvoiceAutomaticPaymentSource?
-
The payment method for an automatic payment.
final
-
cardId
→ String?
-
The ID of the credit or debit card on file to charge for the payment
request. To get the cards on file for a customer, call ListCards and
include the
customer_id of the invoice recipient.
final
-
computedAmountMoney
→ Money?
-
Read only The amount of the payment request, computed using the
order amount and information from the various payment request fields
(
request_type, fixed_amount_requested_money, and
percentage_requested).
final
-
dueDate
→ String?
-
he due date (in the invoice's time zone) for the payment request, in
YYYY-MM-DD format. This field is required to create a payment request.
If an automatic_payment_source is defined for the request, Square
charges the payment source on this date.
final
-
fixedAmountRequestedMoney
→ Money?
-
If the payment request specifies
DEPOSIT or INSTALLMENT as the
request_type, this indicates the request amount. You cannot specify
this when request_type is BALANCE or when the payment request includes
the percentage_requested field.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
percentageRequested
→ String?
-
Specifies the amount for the payment request in percentage:
final
-
props
→ List<Object?>
-
The list of properties that will be used to determine whether
two instances are equal.
no setter
-
reminders
→ List<InvoicePaymentReminder>?
-
A list of one or more reminders to send for the payment request.
final
-
requestType
→ InvoiceRequestType?
-
Identifies the payment request type. This type defines how the payment
request amount is determined. This field is required to create a payment
request.
final
-
roundedAdjustmentIncludedMoney
→ Money?
-
Read only If the most recent payment was a cash payment in a currency
that rounds cash payments (such as,
CAD or AUD) and the payment is
rounded from computed_amount_money in the payment request, then this
field specifies the rounding adjustment applied. This amount might be
negative.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
stringify
→ bool?
-
If set to
true, the toString method will be overridden to output
this instance's props.
no setterinherited
-
tippingEnabled
→ bool?
-
If set to true, the Square-hosted invoice page (the public_url field of
the invoice) provides a place for the customer to pay a tip.
final
-
totalCompletedAmountMoney
→ Money?
-
Read only The amount of money already paid for the specific payment
request. This amount might include a rounding adjustment if the most
recent invoice payment was in cash in a currency that rounds cash
payments (such as,
CAD or AUD).
final
-
uid
→ String?
-
The Square-generated ID of the payment request in an invoice.
final
