PayoutEntry (Square 20.0.0.20220512 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description
PayoutEntry(String id, String payoutId, String effectiveAt, String type, Money grossAmountMoney, Money feeAmountMoney, Money netAmountMoney, PaymentBalanceActivityAutomaticSavingsDetail typeAutomaticSavingsDetails, PaymentBalanceActivityAutomaticSavingsReversedDetail typeAutomaticSavingsReversedDetails, PaymentBalanceActivityChargeDetail typeChargeDetails, PaymentBalanceActivityDepositFeeDetail typeDepositFeeDetails, PaymentBalanceActivityDisputeDetail typeDisputeDetails, PaymentBalanceActivityFeeDetail typeFeeDetails, PaymentBalanceActivityFreeProcessingDetail typeFreeProcessingDetails, PaymentBalanceActivityHoldAdjustmentDetail typeHoldAdjustmentDetails, PaymentBalanceActivityOpenDisputeDetail typeOpenDisputeDetails, PaymentBalanceActivityOtherDetail typeOtherDetails, PaymentBalanceActivityOtherAdjustmentDetail typeOtherAdjustmentDetails, PaymentBalanceActivityRefundDetail typeRefundDetails, PaymentBalanceActivityReleaseAdjustmentDetail typeReleaseAdjustmentDetails, PaymentBalanceActivityReserveHoldDetail typeReserveHoldDetails, PaymentBalanceActivityReserveReleaseDetail typeReserveReleaseDetails, PaymentBalanceActivitySquareCapitalPaymentDetail typeSquareCapitalPaymentDetails, PaymentBalanceActivitySquareCapitalReversedPaymentDetail typeSquareCapitalReversedPaymentDetails, PaymentBalanceActivityTaxOnFeeDetail typeTaxOnFeeDetails, PaymentBalanceActivityThirdPartyFeeDetail typeThirdPartyFeeDetails, PaymentBalanceActivityThirdPartyFeeRefundDetail typeThirdPartyFeeRefundDetails) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getEffectiveAt()` Getter for EffectiveAt.
`Money`	`getFeeAmountMoney()` Getter for FeeAmountMoney.
`Money`	`getGrossAmountMoney()` Getter for GrossAmountMoney.
`String`	`getId()` Getter for Id.
`Money`	`getNetAmountMoney()` Getter for NetAmountMoney.
`String`	`getPayoutId()` Getter for PayoutId.
`String`	`getType()` Getter for Type.
`PaymentBalanceActivityAutomaticSavingsDetail`	`getTypeAutomaticSavingsDetails()` Getter for TypeAutomaticSavingsDetails.
`PaymentBalanceActivityAutomaticSavingsReversedDetail`	`getTypeAutomaticSavingsReversedDetails()` Getter for TypeAutomaticSavingsReversedDetails.
`PaymentBalanceActivityChargeDetail`	`getTypeChargeDetails()` Getter for TypeChargeDetails.
`PaymentBalanceActivityDepositFeeDetail`	`getTypeDepositFeeDetails()` Getter for TypeDepositFeeDetails.
`PaymentBalanceActivityDisputeDetail`	`getTypeDisputeDetails()` Getter for TypeDisputeDetails.
`PaymentBalanceActivityFeeDetail`	`getTypeFeeDetails()` Getter for TypeFeeDetails.
`PaymentBalanceActivityFreeProcessingDetail`	`getTypeFreeProcessingDetails()` Getter for TypeFreeProcessingDetails.
`PaymentBalanceActivityHoldAdjustmentDetail`	`getTypeHoldAdjustmentDetails()` Getter for TypeHoldAdjustmentDetails.
`PaymentBalanceActivityOpenDisputeDetail`	`getTypeOpenDisputeDetails()` Getter for TypeOpenDisputeDetails.
`PaymentBalanceActivityOtherAdjustmentDetail`	`getTypeOtherAdjustmentDetails()` Getter for TypeOtherAdjustmentDetails.
`PaymentBalanceActivityOtherDetail`	`getTypeOtherDetails()` Getter for TypeOtherDetails.
`PaymentBalanceActivityRefundDetail`	`getTypeRefundDetails()` Getter for TypeRefundDetails.
`PaymentBalanceActivityReleaseAdjustmentDetail`	`getTypeReleaseAdjustmentDetails()` Getter for TypeReleaseAdjustmentDetails.
`PaymentBalanceActivityReserveHoldDetail`	`getTypeReserveHoldDetails()` Getter for TypeReserveHoldDetails.
`PaymentBalanceActivityReserveReleaseDetail`	`getTypeReserveReleaseDetails()` Getter for TypeReserveReleaseDetails.
`PaymentBalanceActivitySquareCapitalPaymentDetail`	`getTypeSquareCapitalPaymentDetails()` Getter for TypeSquareCapitalPaymentDetails.
`PaymentBalanceActivitySquareCapitalReversedPaymentDetail`	`getTypeSquareCapitalReversedPaymentDetails()` Getter for TypeSquareCapitalReversedPaymentDetails.
`PaymentBalanceActivityTaxOnFeeDetail`	`getTypeTaxOnFeeDetails()` Getter for TypeTaxOnFeeDetails.
`PaymentBalanceActivityThirdPartyFeeDetail`	`getTypeThirdPartyFeeDetails()` Getter for TypeThirdPartyFeeDetails.
`PaymentBalanceActivityThirdPartyFeeRefundDetail`	`getTypeThirdPartyFeeRefundDetails()` Getter for TypeThirdPartyFeeRefundDetails.
`int`	`hashCode()`
`PayoutEntry.Builder`	`toBuilder()` Builds a new `PayoutEntry.Builder` object.
`String`	`toString()` Converts this PayoutEntry into string format.

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

- Constructor Detail
  - PayoutEntry
```
public PayoutEntry(String id,
                   String payoutId,
                   String effectiveAt,
                   String type,
                   Money grossAmountMoney,
                   Money feeAmountMoney,
                   Money netAmountMoney,
                   PaymentBalanceActivityAutomaticSavingsDetail typeAutomaticSavingsDetails,
                   PaymentBalanceActivityAutomaticSavingsReversedDetail typeAutomaticSavingsReversedDetails,
                   PaymentBalanceActivityChargeDetail typeChargeDetails,
                   PaymentBalanceActivityDepositFeeDetail typeDepositFeeDetails,
                   PaymentBalanceActivityDisputeDetail typeDisputeDetails,
                   PaymentBalanceActivityFeeDetail typeFeeDetails,
                   PaymentBalanceActivityFreeProcessingDetail typeFreeProcessingDetails,
                   PaymentBalanceActivityHoldAdjustmentDetail typeHoldAdjustmentDetails,
                   PaymentBalanceActivityOpenDisputeDetail typeOpenDisputeDetails,
                   PaymentBalanceActivityOtherDetail typeOtherDetails,
                   PaymentBalanceActivityOtherAdjustmentDetail typeOtherAdjustmentDetails,
                   PaymentBalanceActivityRefundDetail typeRefundDetails,
                   PaymentBalanceActivityReleaseAdjustmentDetail typeReleaseAdjustmentDetails,
                   PaymentBalanceActivityReserveHoldDetail typeReserveHoldDetails,
                   PaymentBalanceActivityReserveReleaseDetail typeReserveReleaseDetails,
                   PaymentBalanceActivitySquareCapitalPaymentDetail typeSquareCapitalPaymentDetails,
                   PaymentBalanceActivitySquareCapitalReversedPaymentDetail typeSquareCapitalReversedPaymentDetails,
                   PaymentBalanceActivityTaxOnFeeDetail typeTaxOnFeeDetails,
                   PaymentBalanceActivityThirdPartyFeeDetail typeThirdPartyFeeDetails,
                   PaymentBalanceActivityThirdPartyFeeRefundDetail typeThirdPartyFeeRefundDetails)
```
    Initialization constructor.
    
    Parameters:
    
    id - String value for id.
    
    payoutId - String value for payoutId.
    
    effectiveAt - String value for effectiveAt.
    
    type - String value for type.
    
    grossAmountMoney - Money value for grossAmountMoney.
    
    feeAmountMoney - Money value for feeAmountMoney.
    
    netAmountMoney - Money value for netAmountMoney.
    
    typeAutomaticSavingsDetails - PaymentBalanceActivityAutomaticSavingsDetail value for typeAutomaticSavingsDetails.
    
    typeAutomaticSavingsReversedDetails - PaymentBalanceActivityAutomaticSavingsReversedDetail value for typeAutomaticSavingsReversedDetails.
    
    typeChargeDetails - PaymentBalanceActivityChargeDetail value for typeChargeDetails.
    
    typeDepositFeeDetails - PaymentBalanceActivityDepositFeeDetail value for typeDepositFeeDetails.
    
    typeDisputeDetails - PaymentBalanceActivityDisputeDetail value for typeDisputeDetails.
    
    typeFeeDetails - PaymentBalanceActivityFeeDetail value for typeFeeDetails.
    
    typeFreeProcessingDetails - PaymentBalanceActivityFreeProcessingDetail value for typeFreeProcessingDetails.
    
    typeHoldAdjustmentDetails - PaymentBalanceActivityHoldAdjustmentDetail value for typeHoldAdjustmentDetails.
    
    typeOpenDisputeDetails - PaymentBalanceActivityOpenDisputeDetail value for typeOpenDisputeDetails.
    
    typeOtherDetails - PaymentBalanceActivityOtherDetail value for typeOtherDetails.
    
    typeOtherAdjustmentDetails - PaymentBalanceActivityOtherAdjustmentDetail value for typeOtherAdjustmentDetails.
    
    typeRefundDetails - PaymentBalanceActivityRefundDetail value for typeRefundDetails.
    
    typeReleaseAdjustmentDetails - PaymentBalanceActivityReleaseAdjustmentDetail value for typeReleaseAdjustmentDetails.
    
    typeReserveHoldDetails - PaymentBalanceActivityReserveHoldDetail value for typeReserveHoldDetails.
    
    typeReserveReleaseDetails - PaymentBalanceActivityReserveReleaseDetail value for typeReserveReleaseDetails.
    
    typeSquareCapitalPaymentDetails - PaymentBalanceActivitySquareCapitalPaymentDetail value for typeSquareCapitalPaymentDetails.
    
    typeSquareCapitalReversedPaymentDetails - PaymentBalanceActivitySquareCapitalReversedPaymentDetail value for typeSquareCapitalReversedPaymentDetails.
    
    typeTaxOnFeeDetails - PaymentBalanceActivityTaxOnFeeDetail value for typeTaxOnFeeDetails.
    
    typeThirdPartyFeeDetails - PaymentBalanceActivityThirdPartyFeeDetail value for typeThirdPartyFeeDetails.
    
    typeThirdPartyFeeRefundDetails - PaymentBalanceActivityThirdPartyFeeRefundDetail value for typeThirdPartyFeeRefundDetails.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. A unique ID for the payout entry.
    
    Returns:
    
    Returns the String
  - getPayoutId
```
public String getPayoutId()
```
    Getter for PayoutId. The ID of the payout entries’ associated payout.
    
    Returns:
    
    Returns the String
  - getEffectiveAt
```
public String getEffectiveAt()
```
    Getter for EffectiveAt. The timestamp of when the payout entry affected the balance, in RFC 3339 format.
    
    Returns:
    
    Returns the String
  - getType
```
public String getType()
```
    Getter for Type.
    
    Returns:
    
    Returns the String
  - getGrossAmountMoney
```
public Money getGrossAmountMoney()
```
    Getter for GrossAmountMoney. 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
  - getFeeAmountMoney
```
public Money getFeeAmountMoney()
```
    Getter for FeeAmountMoney. 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
  - getNetAmountMoney
```
public Money getNetAmountMoney()
```
    Getter for NetAmountMoney. 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
  - getTypeAutomaticSavingsDetails
```
public PaymentBalanceActivityAutomaticSavingsDetail getTypeAutomaticSavingsDetails()
```
    Getter for TypeAutomaticSavingsDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityAutomaticSavingsDetail
  - getTypeAutomaticSavingsReversedDetails
```
public PaymentBalanceActivityAutomaticSavingsReversedDetail getTypeAutomaticSavingsReversedDetails()
```
    Getter for TypeAutomaticSavingsReversedDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityAutomaticSavingsReversedDetail
  - getTypeChargeDetails
```
public PaymentBalanceActivityChargeDetail getTypeChargeDetails()
```
    Getter for TypeChargeDetails. DESCRIPTION OF PaymentBalanceActivityChargeDetail
    
    Returns:
    
    Returns the PaymentBalanceActivityChargeDetail
  - getTypeDepositFeeDetails
```
public PaymentBalanceActivityDepositFeeDetail getTypeDepositFeeDetails()
```
    Getter for TypeDepositFeeDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityDepositFeeDetail
  - getTypeDisputeDetails
```
public PaymentBalanceActivityDisputeDetail getTypeDisputeDetails()
```
    Getter for TypeDisputeDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityDisputeDetail
  - getTypeFeeDetails
```
public PaymentBalanceActivityFeeDetail getTypeFeeDetails()
```
    Getter for TypeFeeDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityFeeDetail
  - getTypeFreeProcessingDetails
```
public PaymentBalanceActivityFreeProcessingDetail getTypeFreeProcessingDetails()
```
    Getter for TypeFreeProcessingDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityFreeProcessingDetail
  - getTypeHoldAdjustmentDetails
```
public PaymentBalanceActivityHoldAdjustmentDetail getTypeHoldAdjustmentDetails()
```
    Getter for TypeHoldAdjustmentDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityHoldAdjustmentDetail
  - getTypeOpenDisputeDetails
```
public PaymentBalanceActivityOpenDisputeDetail getTypeOpenDisputeDetails()
```
    Getter for TypeOpenDisputeDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityOpenDisputeDetail
  - getTypeOtherDetails
```
public PaymentBalanceActivityOtherDetail getTypeOtherDetails()
```
    Getter for TypeOtherDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityOtherDetail
  - getTypeOtherAdjustmentDetails
```
public PaymentBalanceActivityOtherAdjustmentDetail getTypeOtherAdjustmentDetails()
```
    Getter for TypeOtherAdjustmentDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityOtherAdjustmentDetail
  - getTypeRefundDetails
```
public PaymentBalanceActivityRefundDetail getTypeRefundDetails()
```
    Getter for TypeRefundDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityRefundDetail
  - getTypeReleaseAdjustmentDetails
```
public PaymentBalanceActivityReleaseAdjustmentDetail getTypeReleaseAdjustmentDetails()
```
    Getter for TypeReleaseAdjustmentDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityReleaseAdjustmentDetail
  - getTypeReserveHoldDetails
```
public PaymentBalanceActivityReserveHoldDetail getTypeReserveHoldDetails()
```
    Getter for TypeReserveHoldDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityReserveHoldDetail
  - getTypeReserveReleaseDetails
```
public PaymentBalanceActivityReserveReleaseDetail getTypeReserveReleaseDetails()
```
    Getter for TypeReserveReleaseDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityReserveReleaseDetail
  - getTypeSquareCapitalPaymentDetails
```
public PaymentBalanceActivitySquareCapitalPaymentDetail getTypeSquareCapitalPaymentDetails()
```
    Getter for TypeSquareCapitalPaymentDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivitySquareCapitalPaymentDetail
  - getTypeSquareCapitalReversedPaymentDetails
```
public PaymentBalanceActivitySquareCapitalReversedPaymentDetail getTypeSquareCapitalReversedPaymentDetails()
```
    Getter for TypeSquareCapitalReversedPaymentDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivitySquareCapitalReversedPaymentDetail
  - getTypeTaxOnFeeDetails
```
public PaymentBalanceActivityTaxOnFeeDetail getTypeTaxOnFeeDetails()
```
    Getter for TypeTaxOnFeeDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityTaxOnFeeDetail
  - getTypeThirdPartyFeeDetails
```
public PaymentBalanceActivityThirdPartyFeeDetail getTypeThirdPartyFeeDetails()
```
    Getter for TypeThirdPartyFeeDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityThirdPartyFeeDetail
  - getTypeThirdPartyFeeRefundDetails
```
public PaymentBalanceActivityThirdPartyFeeRefundDetail getTypeThirdPartyFeeRefundDetails()
```
    Getter for TypeThirdPartyFeeRefundDetails.
    
    Returns:
    
    Returns the PaymentBalanceActivityThirdPartyFeeRefundDetail
  - 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 PayoutEntry into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public PayoutEntry.Builder toBuilder()
```
    Builds a new PayoutEntry.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new PayoutEntry.Builder object

Class PayoutEntry

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PayoutEntry

Method Detail

getId

getPayoutId

getEffectiveAt

getType

getGrossAmountMoney

getFeeAmountMoney

getNetAmountMoney

getTypeAutomaticSavingsDetails

getTypeAutomaticSavingsReversedDetails

getTypeChargeDetails

getTypeDepositFeeDetails

getTypeDisputeDetails

getTypeFeeDetails

getTypeFreeProcessingDetails

getTypeHoldAdjustmentDetails

getTypeOpenDisputeDetails

getTypeOtherDetails

getTypeOtherAdjustmentDetails

getTypeRefundDetails

getTypeReleaseAdjustmentDetails

getTypeReserveHoldDetails

getTypeReserveReleaseDetails

getTypeSquareCapitalPaymentDetails

getTypeSquareCapitalReversedPaymentDetails

getTypeTaxOnFeeDetails

getTypeThirdPartyFeeDetails

getTypeThirdPartyFeeRefundDetails

hashCode

equals

toString

toBuilder