ExternalPaymentScheduleRequest (com.plaid:plaid-java 29.0.0 API)

java.lang.Object
- com.plaid.client.model.ExternalPaymentScheduleRequest

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-14T16:41:31.650700Z[Etc/UTC]")
public class ExternalPaymentScheduleRequest
extends Object
```
The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specified, the payment will be executed only once.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ADJUSTED_START_DATE`
`static String`	`SERIALIZED_NAME_END_DATE`
`static String`	`SERIALIZED_NAME_INTERVAL`
`static String`	`SERIALIZED_NAME_INTERVAL_EXECUTION_DAY`
`static String`	`SERIALIZED_NAME_START_DATE`

Constructor Summary

Constructors
Constructor and Description

ExternalPaymentScheduleRequest()

Constructors
Constructor and Description
`ExternalPaymentScheduleRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExternalPaymentScheduleRequest`	`adjustedStartDate(LocalDate adjustedStartDate)`
`ExternalPaymentScheduleRequest`	`endDate(LocalDate endDate)`
`boolean`	`equals(Object o)`
`LocalDate`	`getAdjustedStartDate()` The start date sent to the bank after adjusting for holidays or weekends.
`LocalDate`	`getEndDate()` A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
`PaymentScheduleInterval`	`getInterval()` Get interval
`Integer`	`getIntervalExecutionDay()` The day of the interval on which to schedule the payment.
`LocalDate`	`getStartDate()` A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
`int`	`hashCode()`
`ExternalPaymentScheduleRequest`	`interval(PaymentScheduleInterval interval)`
`ExternalPaymentScheduleRequest`	`intervalExecutionDay(Integer intervalExecutionDay)`
`void`	`setAdjustedStartDate(LocalDate adjustedStartDate)`
`void`	`setEndDate(LocalDate endDate)`
`void`	`setInterval(PaymentScheduleInterval interval)`
`void`	`setIntervalExecutionDay(Integer intervalExecutionDay)`
`void`	`setStartDate(LocalDate startDate)`
`ExternalPaymentScheduleRequest`	`startDate(LocalDate startDate)`
`String`	`toString()`

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

- Field Detail
  - SERIALIZED_NAME_INTERVAL
```
public static final String SERIALIZED_NAME_INTERVAL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INTERVAL_EXECUTION_DAY
```
public static final String SERIALIZED_NAME_INTERVAL_EXECUTION_DAY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_START_DATE
```
public static final String SERIALIZED_NAME_START_DATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_END_DATE
```
public static final String SERIALIZED_NAME_END_DATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ADJUSTED_START_DATE
```
public static final String SERIALIZED_NAME_ADJUSTED_START_DATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExternalPaymentScheduleRequest
```
public ExternalPaymentScheduleRequest()
```
- Method Detail
  - interval
```
public ExternalPaymentScheduleRequest interval(PaymentScheduleInterval interval)
```
  - getInterval
```
public PaymentScheduleInterval getInterval()
```
    Get interval
    
    Returns:
    
    interval
  - setInterval
```
public void setInterval(PaymentScheduleInterval interval)
```
  - intervalExecutionDay
```
public ExternalPaymentScheduleRequest intervalExecutionDay(Integer intervalExecutionDay)
```
  - getIntervalExecutionDay
```
public Integer getIntervalExecutionDay()
```
    The day of the interval on which to schedule the payment. If the payment interval is weekly, `interval_execution_day` should be an integer from 1 (Monday) to 7 (Sunday). If the payment interval is monthly, `interval_execution_day` should be an integer indicating which day of the month to make the payment on. Integers from 1 to 28 can be used to make a payment on that day of the month. Negative integers from -1 to -5 can be used to make a payment relative to the end of the month. To make a payment on the last day of the month, use -1; to make the payment on the second-to-last day, use -2, and so on.
    
    Returns:
    
    intervalExecutionDay
  - setIntervalExecutionDay
```
public void setIntervalExecutionDay(Integer intervalExecutionDay)
```
  - startDate
```
public ExternalPaymentScheduleRequest startDate(LocalDate startDate)
```
  - getStartDate
```
public LocalDate getStartDate()
```
    A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Standing order payments will begin on the first `interval_execution_day` on or after the `start_date`. If the first `interval_execution_day` on or after the start date is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make the first payment on that day, but it is not guaranteed to do so.
    
    Returns:
    
    startDate
  - setStartDate
```
public void setStartDate(LocalDate startDate)
```
  - endDate
```
public ExternalPaymentScheduleRequest endDate(LocalDate endDate)
```
  - getEndDate
```
@Nullable
public LocalDate getEndDate()
```
    A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Standing order payments will end on the last `interval_execution_day` on or before the `end_date`. If the only `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make a payment on that day, but it is not guaranteed to do so.
    
    Returns:
    
    endDate
  - setEndDate
```
public void setEndDate(LocalDate endDate)
```
  - adjustedStartDate
```
public ExternalPaymentScheduleRequest adjustedStartDate(LocalDate adjustedStartDate)
```
  - getAdjustedStartDate
```
@Nullable
public LocalDate getAdjustedStartDate()
```
    The start date sent to the bank after adjusting for holidays or weekends. Will be provided in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). If the start date did not require adjustment, this field will be `null`.
    
    Returns:
    
    adjustedStartDate
  - setAdjustedStartDate
```
public void setAdjustedStartDate(LocalDate adjustedStartDate)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ExternalPaymentScheduleRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_INTERVAL

SERIALIZED_NAME_INTERVAL_EXECUTION_DAY

SERIALIZED_NAME_START_DATE

SERIALIZED_NAME_END_DATE

SERIALIZED_NAME_ADJUSTED_START_DATE

Constructor Detail

ExternalPaymentScheduleRequest

Method Detail

interval

getInterval

setInterval

intervalExecutionDay

getIntervalExecutionDay

setIntervalExecutionDay

startDate

getStartDate

setStartDate

endDate

getEndDate

setEndDate

adjustedStartDate

getAdjustedStartDate

setAdjustedStartDate

equals

hashCode

toString