The Net Tools Company - 800.225.4190
Search: 
Available in: QUICKBOOKS
CCCredit Component [QuickBooks Integrator V5]

Properties   Methods   Events   Configuration Settings  

A CCCredit is used to record credit card refunds.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

Credit card credits are issued when the QuickBooks company returns merchandise and receives a credit. A CCCredit is the opposite of a CCCHARGE, and the operation of the two components is identical.

Required Fields (Add): Account*, Payee*, TransactionDate, Items or Expenses

Supported Methods: Add, Get (Id), Cancel, Delete

Online Edition: Add only expense lines (no item lines).

Example

CCCredit1.PayeeName = "ACME Inc."             '*
CCCredit1.AccountName = "Corporate MasterCard"     '*
CCCredit1.TransactionDate = "1/17/03"
CCCredit1.ItemCount = 1
CCCredit1.ItemName(0) = "ACME Widget X"  '*
CCCredit1.ItemAmount(0) = "299.95" 
CCCredit1.ExpenseCount = 1
CCCredit1.ExpenseAccountName(0) = "Shipping"       '*
CCCredit1.ExpenseAmount(0) = "12.00"
CCCredit1.Add()

'*: Item must already exist in QuickBooks.

When entering a CCCharge or CCCredit, the Account*, Payee*, and TransactionDate properties must be specified. The Account is the bank or credit card account to whom money is owed (in a CCCharge), or to which the credit is applied (in a CCCredit); this account must already be specified in QuickBooks.

Payee refers to the entity from whom merchandise was purchased, typically but not always a VENDOR. The Account is the account from which funds are being drawn; for example, "Checking" or "Corporate MasterCard". The Payee and Account must already be specified in QuickBooks. Amount is the total of the item lines and (if present) expense lines. It is computed automatically, and should never be set.

Item Lines: Item lines are used to track the purchase of goods or services. Line items may be added by first setting ItemCount. Then, for each line set the Item ID (or Name), Cost, Quantity, Description, Class, Customer, and Amount.

Note: For advanced users, the entire XML item structure may be set and retrieved through the Item's Aggregate property. However, it is up to the developer to ensure that this aggregate is formatted correctly.

Expense Lines: Expense lines are used to track portions of the total amount to expense accounts. To add expense lines to the transaction, first set ExpenseCount. This will initialize the Expenses array. Each expense will be tracked to the account specified in ExpenseAccount. The ExpenseAmount should also be specified for each expense; optionally, the ExpenseClass, ExpenseCustomer, and ExpenseMemo properties may be set as well.

The CCCredit component supports a variety of other operations as well. The component's Get, Cancel, and Delete methods may be used to retrieve, cancel, and delete CCCredits, respectively. The OBJSEARCH Component may be used to search for CCCredits in the QuickBooks database.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AccountIdReference to the bank or credit card company.
AccountNameReference to the bank or credit card company.
AmountAmount of transaction.
ExpenseCountThe number of records in the Expense arrays.
ExpenseAccountIdA reference to the account to which this expense is be charged.
ExpenseAccountNameA reference to the account to which this expense is be charged.
ExpenseAmountThe total amount of this expense line.
ExpenseBillableStatusThe billing status of this expense line.
ExpenseClassIdA reference to the class of this expense.
ExpenseClassNameA reference to the class of this expense.
ExpenseCustomerIdThe customer associated with this expense line.
ExpenseCustomerNameThe customer associated with this expense line.
ExpenseLineIdIdentification number of the expense line, used for Updates.
ExpenseMemoA memo for this expense line, which will appear to the QuickBooks user only.
ExpenseTaxCodeIdLine item property: Sales tax information for this item.
ExpenseTaxCodeNameLine item property: Sales tax information for this item.
ItemCountThe number of records in the Item arrays.
ItemLineIdIdentification number of the transaction line, used for Updates.
ItemAggregateContains an XML aggregate of the line item.
ItemNameLine item property: Reference to the kind of item.
ItemIdLine item property: Reference to the kind of item.
ItemDescriptionLine item property: Description of item.
ItemQuantityLine item property: Quantity of item or item group.
ItemUnitOfMeasureUnit of measure describing the Quantity .
ItemCostLine item property: Unit cost for item.
ItemAmountLine item property: the total amount of this item.
ItemCustomerNameLine item property: A reference to customer for whom the item was ordered.
ItemCustomerIdLine item property: A reference to customer for whom the item was ordered.
ItemClassNameLine item property: Reference to the class of the item.
ItemClassIdLine item property: Reference to the class of the item.
ItemTaxCodeNameLine item property: Sales tax information for this item.
ItemTaxCodeIdLine item property: Sales tax information for this item.
ItemBillableStatusLine item property: Billing status of this item.
ItemOverrideAccountNameAn account which will override the default account for the line item.
ItemOverrideAccountIdAn account which will override the default account for the line item.
ItemGroupIdReference to a group of line items.
ItemGroupNameReference to a group of line items.
MemoMemo to appear on internal reports only.
PayeeIdReference to entity from whom merchandise was purchased.
PayeeNameReference to entity from whom merchandise was purchased.
QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
QBRequestIdThe Id of the next message to be sent to QuickBooks.
QBResponseAggregateThe last XML response aggregate received from QuickBooks.
QBXMLVersionThe version of QBXML used in the outgoing message.
RefIdAn alphanumerical identifier generated by the server.
RefNumberReference number for the transaction.
TransactionDateDate of transaction.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

AddAdds the record into QuickBooks.
CancelCancels (voids) the transaction.
CheckRequestStatusChecks whether or not the specified request was processed by QuickBooks.
CloseQBConnectionCloses a persistent connection to QuickBooks.
ConfigSets or retrieves a configuration setting.
DeleteDeletes the record from QuickBooks.
GetGets a single record from QuickBooks.
GetCustomFieldGets a custom field value from QuickBooks.
GetQBAddRequestAggregateRequest aggregate for an Add.
GetQBUpdateRequestAggregateRequest aggregate for an Update.
OpenQBConnectionOpens a persistent connection to QuickBooks.
ResetResets all properties to their defaults.
SetCustomFieldSets a custom field value within QuickBooks.
UpdateUpdates the bill in QuickBooks.
XMLExportExports the object.
XMLImportImports the object.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusShows the progress of the QuickBooks connection.
WarningFired when a warning occurs.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

SendRawXMLSends specified XML to quickbooks without modification.
AppendAfterAppends an XML tag after the specified QBXML element.
TimeCreatedThe time the object was created.
TimeModifiedThe time the object was created.
EditSequenceAn identifier for this copy of the object.
Items[index].OverrideItemAccountNameAn account which will override the default account for the line item.
Items[index].OverrideItemAccountIdAn account which will override the default account for the line item.
ItemsAggregateAllows the user to set the item XML directly.
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
SSLAcceptServerCertThe SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFileThe SSL certificate file being used by the Remote Connector.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
IgnoreQBOEWarningsIgnores warnings returned from QuickBooks Online.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
QBOpenCompanyFileThe file currently open in QuickBooks.
QBConnectionModeThe mode of connection to QuickBooks.
Tax1TotalCanadian field used for Goods and Services Tax, or GST.
Tax2TotalCanadian field used for Provincial Sales Taxes, or PST.
ExchangeRateIndicates the exchange rate for the transaction.
CodePageThe system code page used for Unicode to Multibyte translations.
| About | Privacy Policy | Terms of Use |
© Copyright 2012 /n software inc.