CreditNote

java.lang.Object
- com.connectifier.xeroclient.models.CreditNote

public class CreditNote
extends java.lang.Object

Java class for CreditNote complex type.

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

 <complexType name="CreditNote">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <all>
         <element name="ValidationErrors" type="{}ArrayOfValidationError" minOccurs="0"/>
         <element name="Warnings" type="{}ArrayOfWarning" minOccurs="0"/>
         <element name="Contact" type="{}Contact" minOccurs="0"/>
         <element name="Date" type="{http://www.w3.org/2001/XMLSchema}dateTime"/>
         <element name="DueDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="BrandingThemeID" type="{}uniqueIdentifier" minOccurs="0"/>
         <element name="Status" type="{}invoiceStatus" minOccurs="0"/>
         <element name="LineAmountTypes" type="{}lineAmountType" minOccurs="0"/>
         <element name="LineItems" type="{}ArrayOfLineItem" minOccurs="0"/>
         <element name="SubTotal" type="{}itemPrice" minOccurs="0"/>
         <element name="TotalTax" type="{}itemPrice" minOccurs="0"/>
         <element name="Total" type="{}itemPrice"/>
         <element name="UpdatedDateUTC" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="CurrencyCode" type="{}currencyCode" minOccurs="0"/>
         <element name="FullyPaidOnDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="Type" type="{}creditNoteType" minOccurs="0"/>
         <element name="Reference" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CreditNoteID" type="{}uniqueIdentifier"/>
         <element name="CreditNoteNumber" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SentToContact" type="{}trueOrFalse" minOccurs="0"/>
         <element name="AppliedAmount" type="{}itemPrice" minOccurs="0"/>
         <element name="CurrencyRate" type="{}currencyRate" minOccurs="0"/>
       </all>
       <attribute name="status" type="{}entityValidationStatus" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.math.BigDecimal`	`appliedAmount`
`protected java.lang.String`	`brandingThemeID`
`protected Contact`	`contact`
`protected java.lang.String`	`creditNoteID`
`protected java.lang.String`	`creditNoteNumber`
`protected CurrencyCode`	`currencyCode`
`protected java.math.BigDecimal`	`currencyRate`
`protected java.util.Date`	`date`
`protected java.util.Date`	`dueDate`
`protected java.util.Date`	`fullyPaidOnDate`
`protected java.util.List<java.lang.String>`	`lineAmountTypes`
`protected ArrayOfLineItem`	`lineItems`
`protected java.lang.String`	`reference`
`protected TrueOrFalse`	`sentToContact`
`protected InvoiceStatus`	`status`
`protected java.math.BigDecimal`	`subTotal`
`protected java.math.BigDecimal`	`total`
`protected java.math.BigDecimal`	`totalTax`
`protected CreditNoteType`	`type`
`protected java.util.Date`	`updatedDateUTC`
`protected ArrayOfValidationError`	`validationErrors`
`protected EntityValidationStatus`	`validationStatus`
`protected ArrayOfWarning`	`warnings`

Constructor Summary

Constructors
Constructor and Description

CreditNote()

Constructors
Constructor and Description
`CreditNote()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.math.BigDecimal`	`getAppliedAmount()` Gets the value of the appliedAmount property.
`java.lang.String`	`getBrandingThemeID()` Gets the value of the brandingThemeID property.
`Contact`	`getContact()` Gets the value of the contact property.
`java.lang.String`	`getCreditNoteID()` Gets the value of the creditNoteID property.
`java.lang.String`	`getCreditNoteNumber()` Gets the value of the creditNoteNumber property.
`CurrencyCode`	`getCurrencyCode()` Gets the value of the currencyCode property.
`java.math.BigDecimal`	`getCurrencyRate()` Gets the value of the currencyRate property.
`java.util.Date`	`getDate()` Gets the value of the date property.
`java.util.Date`	`getDueDate()` Gets the value of the dueDate property.
`java.util.Date`	`getFullyPaidOnDate()` Gets the value of the fullyPaidOnDate property.
`java.util.List<java.lang.String>`	`getLineAmountTypes()` Gets the value of the lineAmountTypes property.
`java.util.List<LineItem>`	`getLineItems()`
`java.lang.String`	`getReference()` Gets the value of the reference property.
`TrueOrFalse`	`getSentToContact()` Gets the value of the sentToContact property.
`InvoiceStatus`	`getStatus()` Gets the value of the status property.
`java.math.BigDecimal`	`getSubTotal()` Gets the value of the subTotal property.
`java.math.BigDecimal`	`getTotal()` Gets the value of the total property.
`java.math.BigDecimal`	`getTotalTax()` Gets the value of the totalTax property.
`CreditNoteType`	`getType()` Gets the value of the type property.
`java.util.Date`	`getUpdatedDateUTC()` Gets the value of the updatedDateUTC property.
`java.util.List<ValidationError>`	`getValidationErrors()`
`EntityValidationStatus`	`getValidationStatus()` Gets the value of the validationStatus property.
`java.util.List<Warning>`	`getWarnings()`
`void`	`setAppliedAmount(java.math.BigDecimal value)` Sets the value of the appliedAmount property.
`void`	`setBrandingThemeID(java.lang.String value)` Sets the value of the brandingThemeID property.
`void`	`setContact(Contact value)` Sets the value of the contact property.
`void`	`setCreditNoteID(java.lang.String value)` Sets the value of the creditNoteID property.
`void`	`setCreditNoteNumber(java.lang.String value)` Sets the value of the creditNoteNumber property.
`void`	`setCurrencyCode(CurrencyCode value)` Sets the value of the currencyCode property.
`void`	`setCurrencyRate(java.math.BigDecimal value)` Sets the value of the currencyRate property.
`void`	`setDate(java.util.Date value)` Sets the value of the date property.
`void`	`setDueDate(java.util.Date value)` Sets the value of the dueDate property.
`void`	`setFullyPaidOnDate(java.util.Date value)` Sets the value of the fullyPaidOnDate property.
`void`	`setLineItems(java.util.List<LineItem> value)`
`void`	`setReference(java.lang.String value)` Sets the value of the reference property.
`void`	`setSentToContact(TrueOrFalse value)` Sets the value of the sentToContact property.
`void`	`setStatus(InvoiceStatus value)` Sets the value of the status property.
`void`	`setSubTotal(java.math.BigDecimal value)` Sets the value of the subTotal property.
`void`	`setTotal(java.math.BigDecimal value)` Sets the value of the total property.
`void`	`setTotalTax(java.math.BigDecimal value)` Sets the value of the totalTax property.
`void`	`setType(CreditNoteType value)` Sets the value of the type property.
`void`	`setUpdatedDateUTC(java.util.Date value)` Sets the value of the updatedDateUTC property.
`void`	`setValidationErrors(java.util.List<ValidationError> value)`
`void`	`setValidationStatus(EntityValidationStatus value)` Sets the value of the validationStatus property.
`void`	`setWarnings(java.util.List<Warning> value)`

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

- Field Detail
  - validationErrors
```
protected ArrayOfValidationError validationErrors
```
  - warnings
```
protected ArrayOfWarning warnings
```
  - contact
```
protected Contact contact
```
  - date
```
protected java.util.Date date
```
  - dueDate
```
protected java.util.Date dueDate
```
  - brandingThemeID
```
protected java.lang.String brandingThemeID
```
  - status
```
protected InvoiceStatus status
```
  - lineAmountTypes
```
protected java.util.List<java.lang.String> lineAmountTypes
```
  - lineItems
```
protected ArrayOfLineItem lineItems
```
  - subTotal
```
protected java.math.BigDecimal subTotal
```
  - totalTax
```
protected java.math.BigDecimal totalTax
```
  - total
```
protected java.math.BigDecimal total
```
  - updatedDateUTC
```
protected java.util.Date updatedDateUTC
```
  - currencyCode
```
protected CurrencyCode currencyCode
```
  - fullyPaidOnDate
```
protected java.util.Date fullyPaidOnDate
```
  - type
```
protected CreditNoteType type
```
  - reference
```
protected java.lang.String reference
```
  - creditNoteID
```
protected java.lang.String creditNoteID
```
  - creditNoteNumber
```
protected java.lang.String creditNoteNumber
```
  - sentToContact
```
protected TrueOrFalse sentToContact
```
  - appliedAmount
```
protected java.math.BigDecimal appliedAmount
```
  - currencyRate
```
protected java.math.BigDecimal currencyRate
```
  - validationStatus
```
protected EntityValidationStatus validationStatus
```
- Constructor Detail
  - CreditNote
```
public CreditNote()
```
- Method Detail
  - getContact
```
public Contact getContact()
```
    Gets the value of the contact property.
    
    Returns:
    
    possible object is Contact
  - setContact
```
public void setContact(Contact value)
```
    Sets the value of the contact property.
    
    Parameters:
    
    value - allowed object is Contact
  - getDate
```
public java.util.Date getDate()
```
    Gets the value of the date property.
    
    Returns:
    
    possible object is String
  - setDate
```
public void setDate(java.util.Date value)
```
    Sets the value of the date property.
    
    Parameters:
    
    value - allowed object is String
  - getDueDate
```
public java.util.Date getDueDate()
```
    Gets the value of the dueDate property.
    
    Returns:
    
    possible object is String
  - setDueDate
```
public void setDueDate(java.util.Date value)
```
    Sets the value of the dueDate property.
    
    Parameters:
    
    value - allowed object is String
  - getBrandingThemeID
```
public java.lang.String getBrandingThemeID()
```
    Gets the value of the brandingThemeID property.
    
    Returns:
    
    possible object is String
  - setBrandingThemeID
```
public void setBrandingThemeID(java.lang.String value)
```
    Sets the value of the brandingThemeID property.
    
    Parameters:
    
    value - allowed object is String
  - getStatus
```
public InvoiceStatus getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is InvoiceStatus
  - setStatus
```
public void setStatus(InvoiceStatus value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is InvoiceStatus
  - getLineAmountTypes
```
public java.util.List<java.lang.String> getLineAmountTypes()
```
    Gets the value of the lineAmountTypes property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the lineAmountTypes property.
    For example, to add a new item, do as follows:
```
    getLineAmountTypes().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getSubTotal
```
public java.math.BigDecimal getSubTotal()
```
    Gets the value of the subTotal property.
    
    Returns:
    
    possible object is BigDecimal
  - setSubTotal
```
public void setSubTotal(java.math.BigDecimal value)
```
    Sets the value of the subTotal property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getTotalTax
```
public java.math.BigDecimal getTotalTax()
```
    Gets the value of the totalTax property.
    
    Returns:
    
    possible object is BigDecimal
  - setTotalTax
```
public void setTotalTax(java.math.BigDecimal value)
```
    Sets the value of the totalTax property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getTotal
```
public java.math.BigDecimal getTotal()
```
    Gets the value of the total property.
    
    Returns:
    
    possible object is BigDecimal
  - setTotal
```
public void setTotal(java.math.BigDecimal value)
```
    Sets the value of the total property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getUpdatedDateUTC
```
public java.util.Date getUpdatedDateUTC()
```
    Gets the value of the updatedDateUTC property.
    
    Returns:
    
    possible object is String
  - setUpdatedDateUTC
```
public void setUpdatedDateUTC(java.util.Date value)
```
    Sets the value of the updatedDateUTC property.
    
    Parameters:
    
    value - allowed object is String
  - getCurrencyCode
```
public CurrencyCode getCurrencyCode()
```
    Gets the value of the currencyCode property.
    
    Returns:
    
    possible object is CurrencyCode
  - setCurrencyCode
```
public void setCurrencyCode(CurrencyCode value)
```
    Sets the value of the currencyCode property.
    
    Parameters:
    
    value - allowed object is CurrencyCode
  - getFullyPaidOnDate
```
public java.util.Date getFullyPaidOnDate()
```
    Gets the value of the fullyPaidOnDate property.
    
    Returns:
    
    possible object is String
  - setFullyPaidOnDate
```
public void setFullyPaidOnDate(java.util.Date value)
```
    Sets the value of the fullyPaidOnDate property.
    
    Parameters:
    
    value - allowed object is String
  - getType
```
public CreditNoteType getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is CreditNoteType
  - setType
```
public void setType(CreditNoteType value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is CreditNoteType
  - getReference
```
public java.lang.String getReference()
```
    Gets the value of the reference property.
    
    Returns:
    
    possible object is String
  - setReference
```
public void setReference(java.lang.String value)
```
    Sets the value of the reference property.
    
    Parameters:
    
    value - allowed object is String
  - getCreditNoteID
```
public java.lang.String getCreditNoteID()
```
    Gets the value of the creditNoteID property.
    
    Returns:
    
    possible object is String
  - setCreditNoteID
```
public void setCreditNoteID(java.lang.String value)
```
    Sets the value of the creditNoteID property.
    
    Parameters:
    
    value - allowed object is String
  - getCreditNoteNumber
```
public java.lang.String getCreditNoteNumber()
```
    Gets the value of the creditNoteNumber property.
    
    Returns:
    
    possible object is String
  - setCreditNoteNumber
```
public void setCreditNoteNumber(java.lang.String value)
```
    Sets the value of the creditNoteNumber property.
    
    Parameters:
    
    value - allowed object is String
  - getSentToContact
```
public TrueOrFalse getSentToContact()
```
    Gets the value of the sentToContact property.
    
    Returns:
    
    possible object is TrueOrFalse
  - setSentToContact
```
public void setSentToContact(TrueOrFalse value)
```
    Sets the value of the sentToContact property.
    
    Parameters:
    
    value - allowed object is TrueOrFalse
  - getAppliedAmount
```
public java.math.BigDecimal getAppliedAmount()
```
    Gets the value of the appliedAmount property.
    
    Returns:
    
    possible object is BigDecimal
  - setAppliedAmount
```
public void setAppliedAmount(java.math.BigDecimal value)
```
    Sets the value of the appliedAmount property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getCurrencyRate
```
public java.math.BigDecimal getCurrencyRate()
```
    Gets the value of the currencyRate property.
    
    Returns:
    
    possible object is BigDecimal
  - setCurrencyRate
```
public void setCurrencyRate(java.math.BigDecimal value)
```
    Sets the value of the currencyRate property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getValidationStatus
```
public EntityValidationStatus getValidationStatus()
```
    Gets the value of the validationStatus property.
    
    Returns:
    
    possible object is EntityValidationStatus
  - setValidationStatus
```
public void setValidationStatus(EntityValidationStatus value)
```
    Sets the value of the validationStatus property.
    
    Parameters:
    
    value - allowed object is EntityValidationStatus
  - getValidationErrors
```
public java.util.List<ValidationError> getValidationErrors()
```
  - getWarnings
```
public java.util.List<Warning> getWarnings()
```
  - getLineItems
```
public java.util.List<LineItem> getLineItems()
```
  - setValidationErrors
```
public void setValidationErrors(java.util.List<ValidationError> value)
```
  - setWarnings
```
public void setWarnings(java.util.List<Warning> value)
```
  - setLineItems
```
public void setLineItems(java.util.List<LineItem> value)
```

Class CreditNote

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

validationErrors

warnings

contact

date

dueDate

brandingThemeID

status

lineAmountTypes

lineItems

subTotal

totalTax

total

updatedDateUTC

currencyCode

fullyPaidOnDate

type

reference

creditNoteID

creditNoteNumber

sentToContact

appliedAmount

currencyRate

validationStatus

Constructor Detail

CreditNote

Method Detail

getContact

setContact

getDate

setDate

getDueDate

setDueDate

getBrandingThemeID

setBrandingThemeID

getStatus

setStatus

getLineAmountTypes

getSubTotal

setSubTotal

getTotalTax

setTotalTax

getTotal

setTotal

getUpdatedDateUTC

setUpdatedDateUTC

getCurrencyCode

setCurrencyCode

getFullyPaidOnDate

setFullyPaidOnDate

getType

setType

getReference

setReference

getCreditNoteID

setCreditNoteID

getCreditNoteNumber

setCreditNoteNumber

getSentToContact

setSentToContact

getAppliedAmount

setAppliedAmount

getCurrencyRate

setCurrencyRate

getValidationStatus

setValidationStatus

getValidationErrors

getWarnings

getLineItems

setValidationErrors

setWarnings

setLineItems