java.lang.Object
- com.xero.models.accounting.Overpayment

```
public class Overpayment
extends Object
```
Overpayment

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Overpayment.StatusEnum
See Overpayment Status Codes

static class Overpayment.TypeEnum
See Overpayment Types

Constructor Summary

Constructors
Constructor Description

Overpayment()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Overpayment`	`addAllocationsItem(Allocation allocationsItem)`	See Allocations
`Overpayment`	`addAttachmentsItem(Attachment attachmentsItem)`	See Attachments
`Overpayment`	`addLineItemsItem(LineItem lineItemsItem)`	See Overpayment Line Items
`Overpayment`	`addPaymentsItem(Payment paymentsItem)`	See Payments
`Overpayment`	`allocations(List<Allocation> allocations)`	See Allocations
`Overpayment`	`appliedAmount(Double appliedAmount)`	The amount of applied to an invoice
`Overpayment`	`attachments(List<Attachment> attachments)`	See Attachments
`Overpayment`	`contact(Contact contact)`	contact
`Overpayment`	`currencyCode(CurrencyCode currencyCode)`	currencyCode
`Overpayment`	`currencyRate(Double currencyRate)`	The currency rate for a multicurrency overpayment.
`Overpayment`	`date(String date)`	The date the overpayment is created YYYY-MM-DD
`boolean`	`equals(Object o)`
`List<Allocation>`	`getAllocations()`	See Allocations
`Double`	`getAppliedAmount()`	The amount of applied to an invoice
`List<Attachment>`	`getAttachments()`	See Attachments
`Contact`	`getContact()`	Get contact
`CurrencyCode`	`getCurrencyCode()`	Get currencyCode
`Double`	`getCurrencyRate()`	The currency rate for a multicurrency overpayment.
`String`	`getDate()`	The date the overpayment is created YYYY-MM-DD
`org.threeten.bp.LocalDate`	`getDateAsDate()`	The date the overpayment is created YYYY-MM-DD
`Boolean`	`getHasAttachments()`	boolean to indicate if a overpayment has an attachment
`LineAmountTypes`	`getLineAmountTypes()`	Get lineAmountTypes
`List<LineItem>`	`getLineItems()`	See Overpayment Line Items
`UUID`	`getOverpaymentID()`	Xero generated unique identifier
`List<Payment>`	`getPayments()`	See Payments
`Double`	`getRemainingCredit()`	The remaining credit balance on the overpayment
`Overpayment.StatusEnum`	`getStatus()`	See Overpayment Status Codes
`Double`	`getSubTotal()`	The subtotal of the overpayment excluding taxes
`Double`	`getTotal()`	The total of the overpayment (subtotal + total tax)
`Double`	`getTotalTax()`	The total tax on the overpayment
`Overpayment.TypeEnum`	`getType()`	See Overpayment Types
`String`	`getUpdatedDateUTC()`	UTC timestamp of last update to the overpayment
`org.threeten.bp.OffsetDateTime`	`getUpdatedDateUTCAsDate()`	UTC timestamp of last update to the overpayment
`int`	`hashCode()`
`Overpayment`	`lineAmountTypes(LineAmountTypes lineAmountTypes)`	lineAmountTypes
`Overpayment`	`lineItems(List<LineItem> lineItems)`	See Overpayment Line Items
`Overpayment`	`overpaymentID(UUID overpaymentID)`	Xero generated unique identifier
`Overpayment`	`payments(List<Payment> payments)`	See Payments
`Overpayment`	`remainingCredit(Double remainingCredit)`	The remaining credit balance on the overpayment
`void`	`setAllocations(List<Allocation> allocations)`	See Allocations
`void`	`setAppliedAmount(Double appliedAmount)`	The amount of applied to an invoice
`void`	`setAttachments(List<Attachment> attachments)`	See Attachments
`void`	`setContact(Contact contact)`	contact
`void`	`setCurrencyCode(CurrencyCode currencyCode)`	currencyCode
`void`	`setCurrencyRate(Double currencyRate)`	The currency rate for a multicurrency overpayment.
`void`	`setDate(String date)`	The date the overpayment is created YYYY-MM-DD
`void`	`setDate(org.threeten.bp.LocalDate date)`	The date the overpayment is created YYYY-MM-DD
`void`	`setLineAmountTypes(LineAmountTypes lineAmountTypes)`	lineAmountTypes
`void`	`setLineItems(List<LineItem> lineItems)`	See Overpayment Line Items
`void`	`setOverpaymentID(UUID overpaymentID)`	Xero generated unique identifier
`void`	`setPayments(List<Payment> payments)`	See Payments
`void`	`setRemainingCredit(Double remainingCredit)`	The remaining credit balance on the overpayment
`void`	`setStatus(Overpayment.StatusEnum status)`	See Overpayment Status Codes
`void`	`setSubTotal(Double subTotal)`	The subtotal of the overpayment excluding taxes
`void`	`setTotal(Double total)`	The total of the overpayment (subtotal + total tax)
`void`	`setTotalTax(Double totalTax)`	The total tax on the overpayment
`void`	`setType(Overpayment.TypeEnum type)`	See Overpayment Types
`Overpayment`	`status(Overpayment.StatusEnum status)`	See Overpayment Status Codes
`Overpayment`	`subTotal(Double subTotal)`	The subtotal of the overpayment excluding taxes
`String`	`toString()`
`Overpayment`	`total(Double total)`	The total of the overpayment (subtotal + total tax)
`Overpayment`	`totalTax(Double totalTax)`	The total tax on the overpayment
`Overpayment`	`type(Overpayment.TypeEnum type)`	See Overpayment Types

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

- Constructor Detail
  - Overpayment
```
public Overpayment()
```
- Method Detail
  - type
```
public Overpayment type(Overpayment.TypeEnum type)
```
    See Overpayment Types
    
    Parameters:
    
    type - TypeEnum
    
    Returns:
    
    Overpayment
  - getType
```
public Overpayment.TypeEnum getType()
```
    See Overpayment Types
    
    Returns:
    
    type
  - setType
```
public void setType(Overpayment.TypeEnum type)
```
    See Overpayment Types
    
    Parameters:
    
    type - TypeEnum
  - contact
```
public Overpayment contact(Contact contact)
```
    contact
    
    Parameters:
    
    contact - Contact
    
    Returns:
    
    Overpayment
  - getContact
```
public Contact getContact()
```
    Get contact
    
    Returns:
    
    contact
  - setContact
```
public void setContact(Contact contact)
```
    contact
    
    Parameters:
    
    contact - Contact
  - date
```
public Overpayment date(String date)
```
    The date the overpayment is created YYYY-MM-DD
    
    Parameters:
    
    date - String
    
    Returns:
    
    Overpayment
  - getDate
```
public String getDate()
```
    The date the overpayment is created YYYY-MM-DD
    
    Returns:
    
    date
  - getDateAsDate
```
public org.threeten.bp.LocalDate getDateAsDate()
```
    The date the overpayment is created YYYY-MM-DD
    
    Returns:
    
    LocalDate
  - setDate
```
public void setDate(String date)
```
    The date the overpayment is created YYYY-MM-DD
    
    Parameters:
    
    date - String
  - setDate
```
public void setDate(org.threeten.bp.LocalDate date)
```
    The date the overpayment is created YYYY-MM-DD
    
    Parameters:
    
    date - LocalDateTime
  - status
```
public Overpayment status(Overpayment.StatusEnum status)
```
    See Overpayment Status Codes
    
    Parameters:
    
    status - StatusEnum
    
    Returns:
    
    Overpayment
  - getStatus
```
public Overpayment.StatusEnum getStatus()
```
    See Overpayment Status Codes
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(Overpayment.StatusEnum status)
```
    See Overpayment Status Codes
    
    Parameters:
    
    status - StatusEnum
  - lineAmountTypes
```
public Overpayment lineAmountTypes(LineAmountTypes lineAmountTypes)
```
    lineAmountTypes
    
    Parameters:
    
    lineAmountTypes - LineAmountTypes
    
    Returns:
    
    Overpayment
  - getLineAmountTypes
```
public LineAmountTypes getLineAmountTypes()
```
    Get lineAmountTypes
    
    Returns:
    
    lineAmountTypes
  - setLineAmountTypes
```
public void setLineAmountTypes(LineAmountTypes lineAmountTypes)
```
    lineAmountTypes
    
    Parameters:
    
    lineAmountTypes - LineAmountTypes
  - lineItems
```
public Overpayment lineItems(List<LineItem> lineItems)
```
    See Overpayment Line Items
    
    Parameters:
    
    lineItems - List<LineItem>
    
    Returns:
    
    Overpayment
  - addLineItemsItem
```
public Overpayment addLineItemsItem(LineItem lineItemsItem)
```
    See Overpayment Line Items
    
    Parameters:
    
    lineItemsItem - LineItem
    
    Returns:
    
    Overpayment
  - getLineItems
```
public List<LineItem> getLineItems()
```
    See Overpayment Line Items
    
    Returns:
    
    lineItems
  - setLineItems
```
public void setLineItems(List<LineItem> lineItems)
```
    See Overpayment Line Items
    
    Parameters:
    
    lineItems - List<LineItem>
  - subTotal
```
public Overpayment subTotal(Double subTotal)
```
    The subtotal of the overpayment excluding taxes
    
    Parameters:
    
    subTotal - Double
    
    Returns:
    
    Overpayment
  - getSubTotal
```
public Double getSubTotal()
```
    The subtotal of the overpayment excluding taxes
    
    Returns:
    
    subTotal
  - setSubTotal
```
public void setSubTotal(Double subTotal)
```
    The subtotal of the overpayment excluding taxes
    
    Parameters:
    
    subTotal - Double
  - totalTax
```
public Overpayment totalTax(Double totalTax)
```
    The total tax on the overpayment
    
    Parameters:
    
    totalTax - Double
    
    Returns:
    
    Overpayment
  - getTotalTax
```
public Double getTotalTax()
```
    The total tax on the overpayment
    
    Returns:
    
    totalTax
  - setTotalTax
```
public void setTotalTax(Double totalTax)
```
    The total tax on the overpayment
    
    Parameters:
    
    totalTax - Double
  - total
```
public Overpayment total(Double total)
```
    The total of the overpayment (subtotal + total tax)
    
    Parameters:
    
    total - Double
    
    Returns:
    
    Overpayment
  - getTotal
```
public Double getTotal()
```
    The total of the overpayment (subtotal + total tax)
    
    Returns:
    
    total
  - setTotal
```
public void setTotal(Double total)
```
    The total of the overpayment (subtotal + total tax)
    
    Parameters:
    
    total - Double
  - getUpdatedDateUTC
```
public String getUpdatedDateUTC()
```
    UTC timestamp of last update to the overpayment
    
    Returns:
    
    updatedDateUTC
  - getUpdatedDateUTCAsDate
```
public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()
```
    UTC timestamp of last update to the overpayment
    
    Returns:
    
    OffsetDateTime
  - currencyCode
```
public Overpayment currencyCode(CurrencyCode currencyCode)
```
    currencyCode
    
    Parameters:
    
    currencyCode - CurrencyCode
    
    Returns:
    
    Overpayment
  - getCurrencyCode
```
public CurrencyCode getCurrencyCode()
```
    Get currencyCode
    
    Returns:
    
    currencyCode
  - setCurrencyCode
```
public void setCurrencyCode(CurrencyCode currencyCode)
```
    currencyCode
    
    Parameters:
    
    currencyCode - CurrencyCode
  - overpaymentID
```
public Overpayment overpaymentID(UUID overpaymentID)
```
    Xero generated unique identifier
    
    Parameters:
    
    overpaymentID - UUID
    
    Returns:
    
    Overpayment
  - getOverpaymentID
```
public UUID getOverpaymentID()
```
    Xero generated unique identifier
    
    Returns:
    
    overpaymentID
  - setOverpaymentID
```
public void setOverpaymentID(UUID overpaymentID)
```
    Xero generated unique identifier
    
    Parameters:
    
    overpaymentID - UUID
  - currencyRate
```
public Overpayment currencyRate(Double currencyRate)
```
    The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used
    
    Parameters:
    
    currencyRate - Double
    
    Returns:
    
    Overpayment
  - getCurrencyRate
```
public Double getCurrencyRate()
```
    The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used
    
    Returns:
    
    currencyRate
  - setCurrencyRate
```
public void setCurrencyRate(Double currencyRate)
```
    The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used
    
    Parameters:
    
    currencyRate - Double
  - remainingCredit
```
public Overpayment remainingCredit(Double remainingCredit)
```
    The remaining credit balance on the overpayment
    
    Parameters:
    
    remainingCredit - Double
    
    Returns:
    
    Overpayment
  - getRemainingCredit
```
public Double getRemainingCredit()
```
    The remaining credit balance on the overpayment
    
    Returns:
    
    remainingCredit
  - setRemainingCredit
```
public void setRemainingCredit(Double remainingCredit)
```
    The remaining credit balance on the overpayment
    
    Parameters:
    
    remainingCredit - Double
  - allocations
```
public Overpayment allocations(List<Allocation> allocations)
```
    See Allocations
    
    Parameters:
    
    allocations - List<Allocation>
    
    Returns:
    
    Overpayment
  - addAllocationsItem
```
public Overpayment addAllocationsItem(Allocation allocationsItem)
```
    See Allocations
    
    Parameters:
    
    allocationsItem - Allocation
    
    Returns:
    
    Overpayment
  - getAllocations
```
public List<Allocation> getAllocations()
```
    See Allocations
    
    Returns:
    
    allocations
  - setAllocations
```
public void setAllocations(List<Allocation> allocations)
```
    See Allocations
    
    Parameters:
    
    allocations - List<Allocation>
  - appliedAmount
```
public Overpayment appliedAmount(Double appliedAmount)
```
    The amount of applied to an invoice
    
    Parameters:
    
    appliedAmount - Double
    
    Returns:
    
    Overpayment
  - getAppliedAmount
```
public Double getAppliedAmount()
```
    The amount of applied to an invoice
    
    Returns:
    
    appliedAmount
  - setAppliedAmount
```
public void setAppliedAmount(Double appliedAmount)
```
    The amount of applied to an invoice
    
    Parameters:
    
    appliedAmount - Double
  - payments
```
public Overpayment payments(List<Payment> payments)
```
    See Payments
    
    Parameters:
    
    payments - List<Payment>
    
    Returns:
    
    Overpayment
  - addPaymentsItem
```
public Overpayment addPaymentsItem(Payment paymentsItem)
```
    See Payments
    
    Parameters:
    
    paymentsItem - Payment
    
    Returns:
    
    Overpayment
  - getPayments
```
public List<Payment> getPayments()
```
    See Payments
    
    Returns:
    
    payments
  - setPayments
```
public void setPayments(List<Payment> payments)
```
    See Payments
    
    Parameters:
    
    payments - List<Payment>
  - getHasAttachments
```
public Boolean getHasAttachments()
```
    boolean to indicate if a overpayment has an attachment
    
    Returns:
    
    hasAttachments
  - attachments
```
public Overpayment attachments(List<Attachment> attachments)
```
    See Attachments
    
    Parameters:
    
    attachments - List<Attachment>
    
    Returns:
    
    Overpayment
  - addAttachmentsItem
```
public Overpayment addAttachmentsItem(Attachment attachmentsItem)
```
    See Attachments
    
    Parameters:
    
    attachmentsItem - Attachment
    
    Returns:
    
    Overpayment
  - getAttachments
```
public List<Attachment> getAttachments()
```
    See Attachments
    
    Returns:
    
    attachments
  - setAttachments
```
public void setAttachments(List<Attachment> attachments)
```
    See Attachments
    
    Parameters:
    
    attachments - List<Attachment>
  - 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

Modifier and Type	Class	Description
`static class`	`Overpayment.StatusEnum`	See Overpayment Status Codes
`static class`	`Overpayment.TypeEnum`	See Overpayment Types

Class Overpayment

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Overpayment

Method Detail

type

getType

setType

contact

getContact

setContact

date

getDate

getDateAsDate

setDate

setDate

status

getStatus

setStatus

lineAmountTypes

getLineAmountTypes

setLineAmountTypes

lineItems

addLineItemsItem

getLineItems

setLineItems

subTotal

getSubTotal

setSubTotal

totalTax

getTotalTax

setTotalTax

total

getTotal

setTotal

getUpdatedDateUTC

getUpdatedDateUTCAsDate

currencyCode

getCurrencyCode

setCurrencyCode

overpaymentID

getOverpaymentID

setOverpaymentID

currencyRate

getCurrencyRate

setCurrencyRate

remainingCredit

getRemainingCredit

setRemainingCredit

allocations

addAllocationsItem

getAllocations

setAllocations

appliedAmount

getAppliedAmount

setAppliedAmount

payments

addPaymentsItem

getPayments

setPayments

getHasAttachments

attachments

addAttachmentsItem

getAttachments

setAttachments

equals

hashCode

toString