Payment (IPP V3 Java DevKit 3.0.0 API)

java.lang.Object
- com.intuit.ipp.data.IntuitEntity
- - com.intuit.ipp.data.Transaction
  - - com.intuit.ipp.data.Payment

All Implemented Interfaces:: IEntity, Serializable, org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2

public class Payment
extends Transaction
implements Serializable, org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2

Financial transaction representing a payment from a customer applied to one or more sales transactions

Java class for Payment complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Payment">
   <complexContent>
     <extension base="{http://schema.intuit.com/finance/v3}Transaction">
       <sequence>
         <element name="CustomerRef" type="{http://schema.intuit.com/finance/v3}ReferenceType" minOccurs="0"/>
         <element name="RemitToRef" type="{http://schema.intuit.com/finance/v3}ReferenceType" minOccurs="0"/>
         <element name="ARAccountRef" type="{http://schema.intuit.com/finance/v3}ReferenceType" minOccurs="0"/>
         <element name="DepositToAccountRef" type="{http://schema.intuit.com/finance/v3}ReferenceType" minOccurs="0"/>
         <element name="PaymentMethodRef" type="{http://schema.intuit.com/finance/v3}ReferenceType" minOccurs="0"/>
         <element name="PaymentRefNum" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="PaymentType" type="{http://schema.intuit.com/finance/v3}PaymentTypeEnum" minOccurs="0"/>
         <choice minOccurs="0">
           <element name="CheckPayment" type="{http://schema.intuit.com/finance/v3}CheckPayment" minOccurs="0"/>
           <element name="CreditCardPayment" type="{http://schema.intuit.com/finance/v3}CreditCardPayment" minOccurs="0"/>
         </choice>
         <element name="TotalAmt" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
         <element name="UnappliedAmt" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
         <element name="ProcessPayment" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="PaymentEx" type="{http://schema.intuit.com/finance/v3}IntuitAnyType" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected ReferenceType`	`arAccountRef`
`protected CheckPayment`	`checkPayment`
`protected CreditCardPayment`	`creditCardPayment`
`protected ReferenceType`	`customerRef`
`protected ReferenceType`	`depositToAccountRef`
`protected IntuitAnyType`	`paymentEx`
`protected ReferenceType`	`paymentMethodRef`
`protected String`	`paymentRefNum`
`protected PaymentTypeEnum`	`paymentType`
`protected Boolean`	`processPayment`
`protected ReferenceType`	`remitToRef`
`protected BigDecimal`	`totalAmt`
`protected BigDecimal`	`unappliedAmt`

Fields inherited from class com.intuit.ipp.data.Transaction
currencyRef, departmentRef, docNumber, exchangeRate, line, linkedTxn, privateNote, taxFormNum, taxFormType, transactionLocationType, txnDate, txnSource, txnStatus, txnTaxDetail

Fields inherited from class com.intuit.ipp.data.IntuitEntity
attachableRef, customField, domain, id, metaData, sparse, status, syncToken

Constructor Summary

Constructors
Constructor and Description

Payment()

Constructors
Constructor and Description
`Payment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)`
`boolean`	`equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)`
`ReferenceType`	`getARAccountRef()` Gets the value of the arAccountRef property.
`CheckPayment`	`getCheckPayment()` Gets the value of the checkPayment property.
`CreditCardPayment`	`getCreditCardPayment()` Gets the value of the creditCardPayment property.
`ReferenceType`	`getCustomerRef()` Gets the value of the customerRef property.
`ReferenceType`	`getDepositToAccountRef()` Gets the value of the depositToAccountRef property.
`IntuitAnyType`	`getPaymentEx()` Gets the value of the paymentEx property.
`ReferenceType`	`getPaymentMethodRef()` Gets the value of the paymentMethodRef property.
`String`	`getPaymentRefNum()` Gets the value of the paymentRefNum property.
`PaymentTypeEnum`	`getPaymentType()` Gets the value of the paymentType property.
`ReferenceType`	`getRemitToRef()` Gets the value of the remitToRef property.
`BigDecimal`	`getTotalAmt()` Gets the value of the totalAmt property.
`BigDecimal`	`getUnappliedAmt()` Gets the value of the unappliedAmt property.
`int`	`hashCode()`
`int`	`hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)`
`Boolean`	`isProcessPayment()` Gets the value of the processPayment property.
`void`	`setARAccountRef(ReferenceType value)` Sets the value of the arAccountRef property.
`void`	`setCheckPayment(CheckPayment value)` Sets the value of the checkPayment property.
`void`	`setCreditCardPayment(CreditCardPayment value)` Sets the value of the creditCardPayment property.
`void`	`setCustomerRef(ReferenceType value)` Sets the value of the customerRef property.
`void`	`setDepositToAccountRef(ReferenceType value)` Sets the value of the depositToAccountRef property.
`void`	`setPaymentEx(IntuitAnyType value)` Sets the value of the paymentEx property.
`void`	`setPaymentMethodRef(ReferenceType value)` Sets the value of the paymentMethodRef property.
`void`	`setPaymentRefNum(String value)` Sets the value of the paymentRefNum property.
`void`	`setPaymentType(PaymentTypeEnum value)` Sets the value of the paymentType property.
`void`	`setProcessPayment(Boolean value)` Sets the value of the processPayment property.
`void`	`setRemitToRef(ReferenceType value)` Sets the value of the remitToRef property.
`void`	`setTotalAmt(BigDecimal value)` Sets the value of the totalAmt property.
`void`	`setUnappliedAmt(BigDecimal value)` Sets the value of the unappliedAmt property.

Methods inherited from class com.intuit.ipp.data.Transaction
getCurrencyRef, getDepartmentRef, getDocNumber, getExchangeRate, getLine, getLinkedTxn, getPrivateNote, getTaxFormNum, getTaxFormType, getTransactionLocationType, getTxnDate, getTxnSource, getTxnStatus, getTxnTaxDetail, setCurrencyRef, setDepartmentRef, setDocNumber, setExchangeRate, setLine, setLinkedTxn, setPrivateNote, setTaxFormNum, setTaxFormType, setTransactionLocationType, setTxnDate, setTxnSource, setTxnStatus, setTxnTaxDetail

Methods inherited from class com.intuit.ipp.data.IntuitEntity
getAttachableRef, getCustomField, getDomain, getId, getMetaData, getStatus, getSyncToken, isSparse, setAttachableRef, setCustomField, setDomain, setId, setMetaData, setSparse, setStatus, setSyncToken

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

- Field Detail
  - customerRef
```
protected ReferenceType customerRef
```
  - remitToRef
```
protected ReferenceType remitToRef
```
  - arAccountRef
```
protected ReferenceType arAccountRef
```
  - depositToAccountRef
```
protected ReferenceType depositToAccountRef
```
  - paymentMethodRef
```
protected ReferenceType paymentMethodRef
```
  - paymentRefNum
```
protected String paymentRefNum
```
  - paymentType
```
protected PaymentTypeEnum paymentType
```
  - checkPayment
```
protected CheckPayment checkPayment
```
  - creditCardPayment
```
protected CreditCardPayment creditCardPayment
```
  - totalAmt
```
protected BigDecimal totalAmt
```
  - unappliedAmt
```
protected BigDecimal unappliedAmt
```
  - processPayment
```
protected Boolean processPayment
```
  - paymentEx
```
protected IntuitAnyType paymentEx
```
- Constructor Detail
  - Payment
```
public Payment()
```
- Method Detail
  - getCustomerRef
```
public ReferenceType getCustomerRef()
```
    Gets the value of the customerRef property.
    
    Returns:
    
    possible object is ReferenceType
  - setCustomerRef
```
public void setCustomerRef(ReferenceType value)
```
    Sets the value of the customerRef property.
    
    Parameters:
    
    value - allowed object is ReferenceType
  - getRemitToRef
```
public ReferenceType getRemitToRef()
```
    Gets the value of the remitToRef property.
    
    Returns:
    
    possible object is ReferenceType
  - setRemitToRef
```
public void setRemitToRef(ReferenceType value)
```
    Sets the value of the remitToRef property.
    
    Parameters:
    
    value - allowed object is ReferenceType
  - getARAccountRef
```
public ReferenceType getARAccountRef()
```
    Gets the value of the arAccountRef property.
    
    Returns:
    
    possible object is ReferenceType
  - setARAccountRef
```
public void setARAccountRef(ReferenceType value)
```
    Sets the value of the arAccountRef property.
    
    Parameters:
    
    value - allowed object is ReferenceType
  - getDepositToAccountRef
```
public ReferenceType getDepositToAccountRef()
```
    Gets the value of the depositToAccountRef property.
    
    Returns:
    
    possible object is ReferenceType
  - setDepositToAccountRef
```
public void setDepositToAccountRef(ReferenceType value)
```
    Sets the value of the depositToAccountRef property.
    
    Parameters:
    
    value - allowed object is ReferenceType
  - getPaymentMethodRef
```
public ReferenceType getPaymentMethodRef()
```
    Gets the value of the paymentMethodRef property.
    
    Returns:
    
    possible object is ReferenceType
  - setPaymentMethodRef
```
public void setPaymentMethodRef(ReferenceType value)
```
    Sets the value of the paymentMethodRef property.
    
    Parameters:
    
    value - allowed object is ReferenceType
  - getPaymentRefNum
```
public String getPaymentRefNum()
```
    Gets the value of the paymentRefNum property.
    
    Returns:
    
    possible object is String
  - setPaymentRefNum
```
public void setPaymentRefNum(String value)
```
    Sets the value of the paymentRefNum property.
    
    Parameters:
    
    value - allowed object is String
  - getPaymentType
```
public PaymentTypeEnum getPaymentType()
```
    Gets the value of the paymentType property.
    
    Returns:
    
    possible object is PaymentTypeEnum
  - setPaymentType
```
public void setPaymentType(PaymentTypeEnum value)
```
    Sets the value of the paymentType property.
    
    Parameters:
    
    value - allowed object is PaymentTypeEnum
  - getCheckPayment
```
public CheckPayment getCheckPayment()
```
    Gets the value of the checkPayment property.
    
    Returns:
    
    possible object is CheckPayment
  - setCheckPayment
```
public void setCheckPayment(CheckPayment value)
```
    Sets the value of the checkPayment property.
    
    Parameters:
    
    value - allowed object is CheckPayment
  - getCreditCardPayment
```
public CreditCardPayment getCreditCardPayment()
```
    Gets the value of the creditCardPayment property.
    
    Returns:
    
    possible object is CreditCardPayment
  - setCreditCardPayment
```
public void setCreditCardPayment(CreditCardPayment value)
```
    Sets the value of the creditCardPayment property.
    
    Parameters:
    
    value - allowed object is CreditCardPayment
  - getTotalAmt
```
public BigDecimal getTotalAmt()
```
    Gets the value of the totalAmt property.
    
    Returns:
    
    possible object is BigDecimal
  - setTotalAmt
```
public void setTotalAmt(BigDecimal value)
```
    Sets the value of the totalAmt property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getUnappliedAmt
```
public BigDecimal getUnappliedAmt()
```
    Gets the value of the unappliedAmt property.
    
    Returns:
    
    possible object is BigDecimal
  - setUnappliedAmt
```
public void setUnappliedAmt(BigDecimal value)
```
    Sets the value of the unappliedAmt property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - isProcessPayment
```
public Boolean isProcessPayment()
```
    Gets the value of the processPayment property.
    
    Returns:
    
    possible object is Boolean
  - setProcessPayment
```
public void setProcessPayment(Boolean value)
```
    Sets the value of the processPayment property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getPaymentEx
```
public IntuitAnyType getPaymentEx()
```
    Gets the value of the paymentEx property.
    
    Returns:
    
    possible object is IntuitAnyType
  - setPaymentEx
```
public void setPaymentEx(IntuitAnyType value)
```
    Sets the value of the paymentEx property.
    
    Parameters:
    
    value - allowed object is IntuitAnyType
  - equals
```
public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
                      org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
                      Object object,
                      org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)
```
    Specified by:
    
    equals in interface org.jvnet.jaxb2_commons.lang.Equals2
    
    Overrides:
    
    equals in class Transaction
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Transaction
  - hashCode
```
public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                    org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
```
    Specified by:
    
    hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode2
    
    Overrides:
    
    hashCode in class Transaction
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Transaction

Class Payment

Field Summary

Fields inherited from class com.intuit.ipp.data.Transaction

Fields inherited from class com.intuit.ipp.data.IntuitEntity

Constructor Summary

Method Summary

Methods inherited from class com.intuit.ipp.data.Transaction

Methods inherited from class com.intuit.ipp.data.IntuitEntity

Methods inherited from class java.lang.Object

Field Detail

customerRef

remitToRef

arAccountRef

depositToAccountRef

paymentMethodRef

paymentRefNum

paymentType

checkPayment

creditCardPayment

totalAmt

unappliedAmt

processPayment

paymentEx

Constructor Detail

Payment

Method Detail

getCustomerRef

setCustomerRef

getRemitToRef

setRemitToRef

getARAccountRef

setARAccountRef

getDepositToAccountRef

setDepositToAccountRef

getPaymentMethodRef

setPaymentMethodRef

getPaymentRefNum

setPaymentRefNum

getPaymentType

setPaymentType

getCheckPayment

setCheckPayment

getCreditCardPayment

setCreditCardPayment

getTotalAmt

setTotalAmt

getUnappliedAmt

setUnappliedAmt

isProcessPayment

setProcessPayment

getPaymentEx

setPaymentEx

equals

equals

hashCode

hashCode