InvoicePaymentRequest (Square 30.0.1.20230608 API)

java.lang.Object
- com.squareup.square.models.InvoicePaymentRequest

```
public class InvoicePaymentRequest
extends Object
```
This is a model class for InvoicePaymentRequest type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class InvoicePaymentRequest.Builder
Class to build instances of InvoicePaymentRequest.

Nested Classes
Modifier and Type	Class and Description
`static class`	`InvoicePaymentRequest.Builder` Class to build instances of `InvoicePaymentRequest`.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	InvoicePaymentRequest(io.apimatic.core.types.OptionalNullable<String> uid, String requestMethod, String requestType, io.apimatic.core.types.OptionalNullable<String> dueDate, Money fixedAmountRequestedMoney, io.apimatic.core.types.OptionalNullable<String> percentageRequested, io.apimatic.core.types.OptionalNullable<Boolean> tippingEnabled, String automaticPaymentSource, io.apimatic.core.types.OptionalNullable<String> cardId, io.apimatic.core.types.OptionalNullable<List<InvoicePaymentReminder>> reminders, Money computedAmountMoney, Money totalCompletedAmountMoney, Money roundingAdjustmentIncludedMoney) Internal initialization constructor.
	`InvoicePaymentRequest(String uid, String requestMethod, String requestType, String dueDate, Money fixedAmountRequestedMoney, String percentageRequested, Boolean tippingEnabled, String automaticPaymentSource, String cardId, List<InvoicePaymentReminder> reminders, Money computedAmountMoney, Money totalCompletedAmountMoney, Money roundingAdjustmentIncludedMoney)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAutomaticPaymentSource()` Getter for AutomaticPaymentSource.
`String`	`getCardId()` Getter for CardId.
`Money`	`getComputedAmountMoney()` Getter for ComputedAmountMoney.
`String`	`getDueDate()` Getter for DueDate.
`Money`	`getFixedAmountRequestedMoney()` Getter for FixedAmountRequestedMoney.
`String`	`getPercentageRequested()` Getter for PercentageRequested.
`List<InvoicePaymentReminder>`	`getReminders()` Getter for Reminders.
`String`	`getRequestMethod()` Getter for RequestMethod.
`String`	`getRequestType()` Getter for RequestType.
`Money`	`getRoundingAdjustmentIncludedMoney()` Getter for RoundingAdjustmentIncludedMoney.
`Boolean`	`getTippingEnabled()` Getter for TippingEnabled.
`Money`	`getTotalCompletedAmountMoney()` Getter for TotalCompletedAmountMoney.
`String`	`getUid()` Getter for Uid.
`int`	`hashCode()`
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetCardId()` Internal Getter for CardId.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetDueDate()` Internal Getter for DueDate.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetPercentageRequested()` Internal Getter for PercentageRequested.
`protected io.apimatic.core.types.OptionalNullable<List<InvoicePaymentReminder>>`	`internalGetReminders()` Internal Getter for Reminders.
`protected io.apimatic.core.types.OptionalNullable<Boolean>`	`internalGetTippingEnabled()` Internal Getter for TippingEnabled.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetUid()` Internal Getter for Uid.
`InvoicePaymentRequest.Builder`	`toBuilder()` Builds a new `InvoicePaymentRequest.Builder` object.
`String`	`toString()` Converts this InvoicePaymentRequest into string format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InvoicePaymentRequest
```
public InvoicePaymentRequest(String uid,
                             String requestMethod,
                             String requestType,
                             String dueDate,
                             Money fixedAmountRequestedMoney,
                             String percentageRequested,
                             Boolean tippingEnabled,
                             String automaticPaymentSource,
                             String cardId,
                             List<InvoicePaymentReminder> reminders,
                             Money computedAmountMoney,
                             Money totalCompletedAmountMoney,
                             Money roundingAdjustmentIncludedMoney)
```
    Initialization constructor.
    
    Parameters:
    
    uid - String value for uid.
    
    requestMethod - String value for requestMethod.
    
    requestType - String value for requestType.
    
    dueDate - String value for dueDate.
    
    fixedAmountRequestedMoney - Money value for fixedAmountRequestedMoney.
    
    percentageRequested - String value for percentageRequested.
    
    tippingEnabled - Boolean value for tippingEnabled.
    
    automaticPaymentSource - String value for automaticPaymentSource.
    
    cardId - String value for cardId.
    
    reminders - List of InvoicePaymentReminder value for reminders.
    
    computedAmountMoney - Money value for computedAmountMoney.
    
    totalCompletedAmountMoney - Money value for totalCompletedAmountMoney.
    
    roundingAdjustmentIncludedMoney - Money value for roundingAdjustmentIncludedMoney.
  - InvoicePaymentRequest
```
protected InvoicePaymentRequest(io.apimatic.core.types.OptionalNullable<String> uid,
                                String requestMethod,
                                String requestType,
                                io.apimatic.core.types.OptionalNullable<String> dueDate,
                                Money fixedAmountRequestedMoney,
                                io.apimatic.core.types.OptionalNullable<String> percentageRequested,
                                io.apimatic.core.types.OptionalNullable<Boolean> tippingEnabled,
                                String automaticPaymentSource,
                                io.apimatic.core.types.OptionalNullable<String> cardId,
                                io.apimatic.core.types.OptionalNullable<List<InvoicePaymentReminder>> reminders,
                                Money computedAmountMoney,
                                Money totalCompletedAmountMoney,
                                Money roundingAdjustmentIncludedMoney)
```
    Internal initialization constructor.
- Method Detail
  - internalGetUid
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetUid()
```
    Internal Getter for Uid. The Square-generated ID of the payment request in an [invoice](entity:Invoice).
    
    Returns:
    
    Returns the Internal String
  - getUid
```
public String getUid()
```
    Getter for Uid. The Square-generated ID of the payment request in an [invoice](entity:Invoice).
    
    Returns:
    
    Returns the String
  - getRequestMethod
```
public String getRequestMethod()
```
    Getter for RequestMethod. Specifies the action for Square to take for processing the invoice. For example, email the invoice, charge a customer's card on file, or do nothing. DEPRECATED at version 2021-01-21. The corresponding `request_method` field is replaced by the `Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields.
    
    Returns:
    
    Returns the String
  - getRequestType
```
public String getRequestType()
```
    Getter for RequestType. Indicates the type of the payment request. For more information, see [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).
    
    Returns:
    
    Returns the String
  - internalGetDueDate
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetDueDate()
```
    Internal Getter for DueDate. The 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. After this date, the invoice becomes overdue. For example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\_Angeles becomes overdue at midnight on March 9 in America/Los\_Angeles (which equals a UTC timestamp of 2021-03-10T08:00:00Z).
    
    Returns:
    
    Returns the Internal String
  - getDueDate
```
public String getDueDate()
```
    Getter for DueDate. The 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. After this date, the invoice becomes overdue. For example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\_Angeles becomes overdue at midnight on March 9 in America/Los\_Angeles (which equals a UTC timestamp of 2021-03-10T08:00:00Z).
    
    Returns:
    
    Returns the String
  - getFixedAmountRequestedMoney
```
public Money getFixedAmountRequestedMoney()
```
    Getter for FixedAmountRequestedMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - internalGetPercentageRequested
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetPercentageRequested()
```
    Internal Getter for PercentageRequested. Specifies the amount for the payment request in percentage: - When the payment `request_type` is `DEPOSIT`, it is the percentage of the order's total amount. - When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order's total less the deposit, if requested. The sum of the `percentage_requested` in all installment payment requests must be equal to 100. You cannot specify this when the payment `request_type` is `BALANCE` or when the payment request specifies the `fixed_amount_requested_money` field.
    
    Returns:
    
    Returns the Internal String
  - getPercentageRequested
```
public String getPercentageRequested()
```
    Getter for PercentageRequested. Specifies the amount for the payment request in percentage: - When the payment `request_type` is `DEPOSIT`, it is the percentage of the order's total amount. - When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order's total less the deposit, if requested. The sum of the `percentage_requested` in all installment payment requests must be equal to 100. You cannot specify this when the payment `request_type` is `BALANCE` or when the payment request specifies the `fixed_amount_requested_money` field.
    
    Returns:
    
    Returns the String
  - internalGetTippingEnabled
```
protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetTippingEnabled()
```
    Internal Getter for TippingEnabled. 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. This field is allowed only on the final payment request and the payment `request_type` must be `BALANCE` or `INSTALLMENT`.
    
    Returns:
    
    Returns the Internal Boolean
  - getTippingEnabled
```
public Boolean getTippingEnabled()
```
    Getter for TippingEnabled. 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. This field is allowed only on the final payment request and the payment `request_type` must be `BALANCE` or `INSTALLMENT`.
    
    Returns:
    
    Returns the Boolean
  - getAutomaticPaymentSource
```
public String getAutomaticPaymentSource()
```
    Getter for AutomaticPaymentSource. Indicates the automatic payment method for an [invoice payment request]($m/InvoicePaymentRequest).
    
    Returns:
    
    Returns the String
  - internalGetCardId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetCardId()
```
    Internal Getter for CardId. 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](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient.
    
    Returns:
    
    Returns the Internal String
  - getCardId
```
public String getCardId()
```
    Getter for CardId. 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](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient.
    
    Returns:
    
    Returns the String
  - internalGetReminders
```
protected io.apimatic.core.types.OptionalNullable<List<InvoicePaymentReminder>> internalGetReminders()
```
    Internal Getter for Reminders. A list of one or more reminders to send for the payment request.
    
    Returns:
    
    Returns the Internal List of InvoicePaymentReminder
  - getReminders
```
public List<InvoicePaymentReminder> getReminders()
```
    Getter for Reminders. A list of one or more reminders to send for the payment request.
    
    Returns:
    
    Returns the List of InvoicePaymentReminder
  - getComputedAmountMoney
```
public Money getComputedAmountMoney()
```
    Getter for ComputedAmountMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getTotalCompletedAmountMoney
```
public Money getTotalCompletedAmountMoney()
```
    Getter for TotalCompletedAmountMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getRoundingAdjustmentIncludedMoney
```
public Money getRoundingAdjustmentIncludedMoney()
```
    Getter for RoundingAdjustmentIncludedMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Converts this InvoicePaymentRequest into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public InvoicePaymentRequest.Builder toBuilder()
```
    Builds a new InvoicePaymentRequest.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new InvoicePaymentRequest.Builder object

Class InvoicePaymentRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InvoicePaymentRequest

InvoicePaymentRequest

Method Detail

internalGetUid

getUid

getRequestMethod

getRequestType

internalGetDueDate

getDueDate

getFixedAmountRequestedMoney

internalGetPercentageRequested

getPercentageRequested

internalGetTippingEnabled

getTippingEnabled

getAutomaticPaymentSource

internalGetCardId

getCardId

internalGetReminders

getReminders

getComputedAmountMoney

getTotalCompletedAmountMoney

getRoundingAdjustmentIncludedMoney

hashCode

equals

toString

toBuilder