public final enum

OnlineEntityType

extends Enum<E extends Enum<E>>
java.lang.Object
   ↳ java.lang.Enum<E extends java.lang.Enum<E>>
     ↳ org.mule.modules.quickbooks.online.OnlineEntityType

Class Overview

The supported objects for Data Services for QuickBooks Online.

Summary

Enum Values
OnlineEntityType  ACCOUNT  The Account object represents the accounts that you keep to track your business. 
OnlineEntityType  BILL  The Bill object represents an expense to the business. 
OnlineEntityType  BILLPAYMENT  BillPayment represents the financial transaction of payment of bills that the business owner receives from a vendor for goods or services purchased from the vendor. 
OnlineEntityType  CASHPURCHASE  CashPurchase represents an expense to the business as a cash transaction. 
OnlineEntityType  CHANGEDATADELETED  ChangeDataDeleted (Beta) ONLY FOR FIND-OBJECTS PROCESSOR

Use this service to get all of the transactions and objects that have been deleted on the Data Serices server. 

OnlineEntityType  CHECK  The Check object represents an expense to the business paid as a check transaction. 
OnlineEntityType  CREDITCARDCHARGE  The CreditCardCharge object represents an expense to the business as a credit card charge transaction. 
OnlineEntityType  CUSTOMER  The Customer object represents the consumer of the service or the product that your business offers. 
OnlineEntityType  ESTIMATE  The Estimate object represents a proposal for a financial transaction from a business to a customer for goods or services proposed to be sold, including proposed pricing. 
OnlineEntityType  INVOICE  The Invoice object represents an invoice to a customer. 
OnlineEntityType  ITEM  The Item object represents any product or service that is sold or purchased. 
OnlineEntityType  PAYMENT  The Payment object represents the financial transaction that signifies a payment from a customer for one or more sales transactions. 
OnlineEntityType  PAYMENTMETHOD  PaymentMethod represents the method of payment for a transaction. 
OnlineEntityType  SALESRECEIPT  SalesReceipt represents the sales receipt that is given to a customer. 
OnlineEntityType  SALESTERM  The SalesTerm object represents the terms under which a sale is made. 
OnlineEntityType  VENDOR  The Vendor object represents the buyer from whom you purchase any service or product for your organization. 
Fields
private final String cdmCollectionName
private final String simpleName
private final Class<?> type
[Expand]
Inherited Fields
From class java.lang.Enum
Public Methods
String getCdmCollectionName()
String getResouceName()
Answers the resource name of this entity type as present in the entity uri
String getResouceNameForFind()
Answers the resource name of this entity type as present in the entity uri
String getSimpleName()
<A> Class<A> getType()
<A> A newInstance()
static OnlineEntityType valueOf(String name)
final static OnlineEntityType[] values()
[Expand]
Inherited Methods
From class java.lang.Enum
From class java.lang.Object
From interface java.lang.Comparable

Enum Values

public static final OnlineEntityType ACCOUNT

The Account object represents the accounts that you keep to track your business. Account is a component of a chart of accounts, and is part of a ledger. You can use Account to record the total monetary amount that is allocated for a specific use.

public static final OnlineEntityType BILL

The Bill object represents an expense to the business.

public static final OnlineEntityType BILLPAYMENT

BillPayment represents the financial transaction of payment of bills that the business owner receives from a vendor for goods or services purchased from the vendor. QBO supports bill payments through a credit card or a bank account.

public static final OnlineEntityType CASHPURCHASE

CashPurchase represents an expense to the business as a cash transaction.

public static final OnlineEntityType CHANGEDATADELETED

ChangeDataDeleted (Beta) ONLY FOR FIND-OBJECTS PROCESSOR

Use this service to get all of the transactions and objects that have been deleted on the Data Serices server. Your application may consume QBO data by getting a snapshot of the data and caching it for later use. You can do this on an object-specific basis, querying for the object and applying a filter. However, this service provides a quick update of only those objects deleted, saving you the trouble of coding a lengthy query. Since the deleted object list is intended only for clearing the local cache, the returned information is a subset of the object fields: Id, EntityType, and L astUpdatedTime (when the object was deleted).

Supported Objects:

* Account

* Item

* Customer

* Vendor

* Term (a.k.a SalesTerm)

* PaymentMethod

* Employee

* Class

* Job

* Invoice

* Estimate

* SalesReceipt

* QboStatementCharge

* Bill

* Check

* BillPayment

* CreditCardCharge

* CreditCardCredit

* VendorCredit

* Payment

* CashPurchase

* Journal (a.k.a JournalEntry)

Limitations:

* If the request filter includes Job, the return value may contain a Customer as a Job. (QBO treats Job as sub-Customer.)

* Only objects that are supported can be requested at this time. Other objects will cause a validation error.

* The "Sort" parameter is not supported for this filter.

* By default, the most recently deleted objects are returned first (descending order for LastUpdatedTime).

The Filter parameter in the body of the request must have the following format:

Entity :in: ( {entity-type} [, {entity-type}]* ) [:and: LastUpdatedTime :after: {date-time}]

For example: Entity :in: (Customer, Invoice, Item) :and: LastUpdatedTime :after: 2011-06-30T01:00:00-0700

If the Filter is not specified, the query will return all deleted data.

Entity and LastUpdatedTime are the only parameters allowed in the filter.

All characters used in the filter syntax are case insensitive.

public static final OnlineEntityType CHECK

The Check object represents an expense to the business paid as a check transaction.

public static final OnlineEntityType CREDITCARDCHARGE

The CreditCardCharge object represents an expense to the business as a credit card charge transaction.

public static final OnlineEntityType CUSTOMER

The Customer object represents the consumer of the service or the product that your business offers. QBO allows categorizing the customers in a way that is meaningful to the business.

public static final OnlineEntityType ESTIMATE

The Estimate object represents a proposal for a financial transaction from a business to a customer for goods or services proposed to be sold, including proposed pricing. It is also known as quote.

public static final OnlineEntityType INVOICE

The Invoice object represents an invoice to a customer. Invoice could be based on salesterm with invoice and due dates for payment. Invoice supports tax, but as of now shipping charges are not supported.

public static final OnlineEntityType ITEM

The Item object represents any product or service that is sold or purchased.

public static final OnlineEntityType PAYMENT

The Payment object represents the financial transaction that signifies a payment from a customer for one or more sales transactions.

public static final OnlineEntityType PAYMENTMETHOD

PaymentMethod represents the method of payment for a transaction. It can be a credit card payment type or a non-credit card payment type.

public static final OnlineEntityType SALESRECEIPT

SalesReceipt represents the sales receipt that is given to a customer. A sales receipt is similar to an invoice. However, for a sales receipt, payment is received as part of the sale of goods and services. The sales receipt specifies a deposit account where the customer deposits the payment. If the deposit account is not specified, the payment type is classified as Undeposited Account.

public static final OnlineEntityType SALESTERM

The SalesTerm object represents the terms under which a sale is made. SalesTerm is typically expressed in the form of days due after the goods are received. There is an optional discount part of the sales term, where a discount of total amount can automatically be applied if payment is made within a few days of the stipulated time.

public static final OnlineEntityType VENDOR

The Vendor object represents the buyer from whom you purchase any service or product for your organization.

Fields

private final String cdmCollectionName

private final String simpleName

private final Class<?> type

Public Methods

public String getCdmCollectionName ()

public String getResouceName ()

Answers the resource name of this entity type as present in the entity uri

public String getResouceNameForFind ()

Answers the resource name of this entity type as present in the entity uri

public String getSimpleName ()

Returns
  • the simple name of the associated class for this entity type

public Class<A> getType ()

public A newInstance ()

public static OnlineEntityType valueOf (String name)

Parameters
name

public static final OnlineEntityType[] values ()