com.intuit.ipp.data

Class Invoice

java.lang.Object

com.intuit.ipp.data.IntuitEntity

com.intuit.ipp.data.Transaction

com.intuit.ipp.data.SalesTransaction

com.intuit.ipp.data.Invoice

All Implemented Interfaces:

IEntity, Serializable, org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2

public class Invoice
extends SalesTransaction
implements Serializable, org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2

Product: QBO Description: The Invoice entity represents an invoice to a customer. Invoice could be based on salesterm with invoice and due dates for payment. Invoice supports sales tax, and shipping charges as a special line item. Invoice can be printed and emailed to a customer. Business Rules: [li] An invoice must have at least one line that describes the item and an amount.[/li][li] An invoice must have a reference to a customer in the header.[/li] Product: QBW Description: An Invoice is a financial transaction representing a request for payment for goods or services that have been sold. An invoice is a form that records the details of a customer's purchase, such as quantity and price of the goods or services. An invoice records the amount owed by a customer who does not pay in full at the time of purchase. If full payment is received at the time of purchase, the sale may be recorded as a sales receipt, not an invoice. An invoice must contain a valid customer reference in the CustomerId field and at least one line item. The referenced customer must already exist in the QuickBooks company at the desktop and any line items must also already exists in the QuickBooks company, or the attempt to sync will fail.[br /]In general, it is a good practice to specify all the header fields if you have the data. You should always specify the ARAccountId; otherwise a default AR account will be used and this may give you unexpected results.[/br] If you want to apply one tax to all the transaction line items, use the TaxId or TaxGroupId field. If you want to use more than one tax, you need to use Tax Line items instead. Business Rules: [li] An invoice must have at least one line that describes the item. [/li][li] If an account is specified in the header, the account must be of the Accounts Receivable (AR) type. [/li][li] An invoice must have a reference to a customer in the header.[/li]

Java class for Invoice complex type.

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

 <complexType name="Invoice">
   <complexContent>
     <extension base="{http://schema.intuit.com/finance/v3}SalesTransaction">
       <sequence>
         <element name="Deposit" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
         <element name="AllowIPNPayment" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="AllowOnlinePayment" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="AllowOnlineCreditCardPayment" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="AllowOnlineACHPayment" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="EInvoiceStatus" type="{http://schema.intuit.com/finance/v3}ETransactionStatusEnum" minOccurs="0"/>
         <element name="ECloudStatusTimeStamp" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="invoiceStatus" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="callToAction" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="invoiceStatusLog" type="{http://schema.intuit.com/finance/v3}StatusInfo" maxOccurs="unbounded" minOccurs="0"/>
         <element name="InvoiceEx" 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 Boolean	allowIPNPayment
protected Boolean	allowOnlineACHPayment
protected Boolean	allowOnlineCreditCardPayment
protected Boolean	allowOnlinePayment
protected String	callToAction
protected BigDecimal	deposit
protected Date	eCloudStatusTimeStamp
protected ETransactionStatusEnum	eInvoiceStatus
protected IntuitAnyType	invoiceEx
protected String	invoiceStatus
protected List<StatusInfo>	invoiceStatusLog

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

applyTaxAfterDiscount, arAccountRef, autoDocNumber, balance, billAddr, billEmail, billEmailBcc, billEmailCc, checkPayment, classRef, creditCardPayment, customerMemo, customerRef, deliveryInfo, depositToAccountRef, discountAmt, discountRate, dueDate, emailStatus, financeCharge, fob, globalTaxCalculation, govtTxnRefIdentifier, homeBalance, homeTotalAmt, paymentMethodRef, paymentRefNum, paymentType, poNumber, printStatus, remitToRef, salesRepRef, salesTermRef, shipAddr, shipDate, shipMethodRef, templateRef, totalAmt, trackingNum

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
Invoice()

Method Summary

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)
String	getCallToAction() Gets the value of the callToAction property.
BigDecimal	getDeposit() Gets the value of the deposit property.
Date	getECloudStatusTimeStamp() Gets the value of the eCloudStatusTimeStamp property.
ETransactionStatusEnum	getEInvoiceStatus() Gets the value of the eInvoiceStatus property.
IntuitAnyType	getInvoiceEx() Gets the value of the invoiceEx property.
String	getInvoiceStatus() Gets the value of the invoiceStatus property.
List<StatusInfo>	getInvoiceStatusLog() Gets the value of the invoiceStatusLog property.
int	hashCode()
int	hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
Boolean	isAllowIPNPayment() Gets the value of the allowIPNPayment property.
Boolean	isAllowOnlineACHPayment() Gets the value of the allowOnlineACHPayment property.
Boolean	isAllowOnlineCreditCardPayment() Gets the value of the allowOnlineCreditCardPayment property.
Boolean	isAllowOnlinePayment() Gets the value of the allowOnlinePayment property.
void	setAllowIPNPayment(Boolean value) Sets the value of the allowIPNPayment property.
void	setAllowOnlineACHPayment(Boolean value) Sets the value of the allowOnlineACHPayment property.
void	setAllowOnlineCreditCardPayment(Boolean value) Sets the value of the allowOnlineCreditCardPayment property.
void	setAllowOnlinePayment(Boolean value) Sets the value of the allowOnlinePayment property.
void	setCallToAction(String value) Sets the value of the callToAction property.
void	setDeposit(BigDecimal value) Sets the value of the deposit property.
void	setECloudStatusTimeStamp(Date value) Sets the value of the eCloudStatusTimeStamp property.
void	setEInvoiceStatus(ETransactionStatusEnum value) Sets the value of the eInvoiceStatus property.
void	setInvoiceEx(IntuitAnyType value) Sets the value of the invoiceEx property.
void	setInvoiceStatus(String value) Sets the value of the invoiceStatus property.
void	setInvoiceStatusLog(List<StatusInfo> invoiceStatusLog) Sets the value of the invoiceStatusLog property.

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

getARAccountRef, getBalance, getBillAddr, getBillEmail, getBillEmailBcc, getBillEmailCc, getCheckPayment, getClassRef, getCreditCardPayment, getCustomerMemo, getCustomerRef, getDeliveryInfo, getDepositToAccountRef, getDiscountAmt, getDiscountRate, getDueDate, getEmailStatus, getFOB, getGlobalTaxCalculation, getGovtTxnRefIdentifier, getHomeBalance, getHomeTotalAmt, getPaymentMethodRef, getPaymentRefNum, getPaymentType, getPONumber, getPrintStatus, getRemitToRef, getSalesRepRef, getSalesTermRef, getShipAddr, getShipDate, getShipMethodRef, getTemplateRef, getTotalAmt, getTrackingNum, isApplyTaxAfterDiscount, isAutoDocNumber, isFinanceCharge, setApplyTaxAfterDiscount, setARAccountRef, setAutoDocNumber, setBalance, setBillAddr, setBillEmail, setBillEmailBcc, setBillEmailCc, setCheckPayment, setClassRef, setCreditCardPayment, setCustomerMemo, setCustomerRef, setDeliveryInfo, setDepositToAccountRef, setDiscountAmt, setDiscountRate, setDueDate, setEmailStatus, setFinanceCharge, setFOB, setGlobalTaxCalculation, setGovtTxnRefIdentifier, setHomeBalance, setHomeTotalAmt, setPaymentMethodRef, setPaymentRefNum, setPaymentType, setPONumber, setPrintStatus, setRemitToRef, setSalesRepRef, setSalesTermRef, setShipAddr, setShipDate, setShipMethodRef, setTemplateRef, setTotalAmt, setTrackingNum

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

deposit

protected BigDecimal deposit

allowIPNPayment

protected Boolean allowIPNPayment

allowOnlinePayment

protected Boolean allowOnlinePayment

allowOnlineCreditCardPayment

protected Boolean allowOnlineCreditCardPayment

allowOnlineACHPayment

protected Boolean allowOnlineACHPayment

eInvoiceStatus

protected ETransactionStatusEnum eInvoiceStatus

eCloudStatusTimeStamp

protected Date eCloudStatusTimeStamp

invoiceStatus

protected String invoiceStatus

callToAction

protected String callToAction

invoiceStatusLog

protected List<StatusInfo> invoiceStatusLog

invoiceEx

protected IntuitAnyType invoiceEx

Constructor Detail

Invoice

public Invoice()

Method Detail

getDeposit

public BigDecimal getDeposit()

Gets the value of the deposit property.

Returns:

possible object is BigDecimal

setDeposit

public void setDeposit(BigDecimal value)

Sets the value of the deposit property.

Parameters:

value - allowed object is BigDecimal

isAllowIPNPayment

public Boolean isAllowIPNPayment()

Gets the value of the allowIPNPayment property.

Returns:

possible object is Boolean

setAllowIPNPayment

public void setAllowIPNPayment(Boolean value)

Sets the value of the allowIPNPayment property.

Parameters:

value - allowed object is Boolean

isAllowOnlinePayment

public Boolean isAllowOnlinePayment()

Gets the value of the allowOnlinePayment property.

Returns:

possible object is Boolean

setAllowOnlinePayment

public void setAllowOnlinePayment(Boolean value)

Sets the value of the allowOnlinePayment property.

Parameters:

value - allowed object is Boolean

isAllowOnlineCreditCardPayment

public Boolean isAllowOnlineCreditCardPayment()

Gets the value of the allowOnlineCreditCardPayment property.

Returns:

possible object is Boolean

setAllowOnlineCreditCardPayment

public void setAllowOnlineCreditCardPayment(Boolean value)

Sets the value of the allowOnlineCreditCardPayment property.

Parameters:

value - allowed object is Boolean

isAllowOnlineACHPayment

public Boolean isAllowOnlineACHPayment()

Gets the value of the allowOnlineACHPayment property.

Returns:

possible object is Boolean

setAllowOnlineACHPayment

public void setAllowOnlineACHPayment(Boolean value)

Sets the value of the allowOnlineACHPayment property.

Parameters:

value - allowed object is Boolean

getEInvoiceStatus

public ETransactionStatusEnum getEInvoiceStatus()

Gets the value of the eInvoiceStatus property.

Returns:

possible object is ETransactionStatusEnum

setEInvoiceStatus

public void setEInvoiceStatus(ETransactionStatusEnum value)

Sets the value of the eInvoiceStatus property.

Parameters:

value - allowed object is ETransactionStatusEnum

getECloudStatusTimeStamp

public Date getECloudStatusTimeStamp()

Gets the value of the eCloudStatusTimeStamp property.

Returns:

possible object is String

setECloudStatusTimeStamp

public void setECloudStatusTimeStamp(Date value)

Sets the value of the eCloudStatusTimeStamp property.

Parameters:

value - allowed object is String

getInvoiceStatus

public String getInvoiceStatus()

Gets the value of the invoiceStatus property.

Returns:

possible object is String

setInvoiceStatus

public void setInvoiceStatus(String value)

Sets the value of the invoiceStatus property.

Parameters:

value - allowed object is String

getCallToAction

public String getCallToAction()

Gets the value of the callToAction property.

Returns:

possible object is String

setCallToAction

public void setCallToAction(String value)

Sets the value of the callToAction property.

Parameters:

value - allowed object is String

getInvoiceStatusLog

public List<StatusInfo> getInvoiceStatusLog()

Gets the value of the invoiceStatusLog 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 invoiceStatusLog property.

For example, to add a new item, do as follows:

    getInvoiceStatusLog().add(newItem);
 

Objects of the following type(s) are allowed in the list StatusInfo

getInvoiceEx

public IntuitAnyType getInvoiceEx()

Gets the value of the invoiceEx property.

Returns:

possible object is IntuitAnyType

setInvoiceEx

public void setInvoiceEx(IntuitAnyType value)

Sets the value of the invoiceEx property.

Parameters:

value - allowed object is IntuitAnyType

setInvoiceStatusLog

public void setInvoiceStatusLog(List<StatusInfo> invoiceStatusLog)

Sets the value of the invoiceStatusLog property.

Parameters:

invoiceStatusLog - allowed object is StatusInfo

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 SalesTransaction

equals

public boolean equals(Object object)

Overrides:

equals in class SalesTransaction

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 SalesTransaction

hashCode

public int hashCode()

Overrides:

hashCode in class SalesTransaction