QuickBooks Integrator 2020 Python Edition

Questions / Feedback?

CCCredit Class

Properties   Methods   Events   Configuration Settings   Errors  

A CCCredit is used to record credit card refunds.

Syntax

class inqb.CCCredit

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

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 transaction_date 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 class supports a variety of other operations as well. The class's get, cancel, and delete methods may be used to retrieve, cancel, and delete CCCredits, respectively. The ObjSearch Class may be used to search for CCCredits in the QuickBooks database.

Property List


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

account_idReference to the bank or credit card company.
account_nameReference to the bank or credit card company.
amountAmount of transaction.
expense_countThe number of records in the Expense arrays.
expense_account_idA reference to the account to which this expense is be charged.
expense_account_nameA reference to the account to which this expense is be charged.
expense_amountThe total amount of this expense line.
expense_billable_statusThe billing status of this expense line.
expense_class_idA reference to the class of this expense.
expense_class_nameA reference to the class of this expense.
expense_customer_idThe customer associated with this expense line.
expense_customer_nameThe customer associated with this expense line.
expense_line_idIdentification number of the expense line, used for Updates.
expense_memoA memo for this expense line, which will appear to the QuickBooks user only.
expense_tax_code_idLine item property: Sales tax information for this item.
expense_tax_code_nameLine item property: Sales tax information for this item.
item_countThe number of records in the Item arrays.
item_aggregateContains an XML aggregate of the line item.
item_amountLine item property: the total amount of this item.
item_billable_statusLine item property: Billing status of this item.
item_class_idLine item property: Reference to the class of the item.
item_class_nameLine item property: Reference to the class of the item.
item_costLine item property: Unit cost for item.
item_customer_idLine item property: A reference to customer for whom the item was ordered.
item_customer_nameLine item property: A reference to customer for whom the item was ordered.
item_descriptionLine item property: Description of item.
item_group_idReference to a group of line items.
item_group_nameReference to a group of line items.
item_idLine item property: Reference to the kind of item.
item_nameLine item property: Reference to the kind of item.
item_line_idIdentification number of the transaction line, used for Updates.
item_override_account_idAn account which will override the default account for the line item.
item_override_account_nameAn account which will override the default account for the line item.
item_quantityLine item property: Quantity of item or item group.
item_tax_code_idLine item property: Sales tax information for this item.
item_tax_code_nameLine item property: Sales tax information for this item.
item_unit_of_measureUnit of measure describing the Quantity .
memoMemo to appear on internal reports only.
payee_idReference to entity from whom merchandise was purchased.
payee_nameReference to entity from whom merchandise was purchased.
qb_connection_stringAn aggregate consisting of various QuickBooks connection properties.
qb_request_aggregateThe request aggregate.
qb_request_idThe Id of the next message to be sent to QuickBooks.
qb_request_modeDefines whether the request is made online or stored offline.
qb_response_aggregateThe last QBXML response aggregate received from QuickBooks.
qbxml_versionThe version of QBXML used in the outgoing message.
ref_idAn alphanumerical identifier generated by the server.
ref_numberReference number for the transaction.
transaction_dateDate of transaction.

Method List


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

addAdds the record into QuickBooks.
cancelCancels (voids) the transaction.
check_request_statusChecks whether or not the specified request was processed by QuickBooks.
close_qb_connectionCloses a persistent connection to QuickBooks.
configSets or retrieves a configuration setting.
deleteDeletes the record from QuickBooks.
getGets a single record from QuickBooks.
get_custom_fieldGets a custom field value from QuickBooks.
import_qbxmlImports a QBXML response aggregate.
open_qb_connectionOpens a persistent connection to QuickBooks.
resetResets all properties to their defaults.
set_custom_fieldSets a custom field value within QuickBooks.
updateUpdates the bill in QuickBooks.

Event List


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

on_errorInformation about errors during data delivery.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows the progress of the secure connection.
on_statusShows the progress of the QuickBooks connection.
on_warningFired when a warning occurs.

Configuration Settings


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

AppendAfterAppends an XML tag after the specified QBXML element.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
EditSequenceAn identifier for this copy of the object.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
ExchangeRateIndicates the exchange rate for the transaction.
ExpenseLineAggregate[index]Contains the XML aggregate of the expense line item.
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnlyThis causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
Items[index].OverrideItemAccountIdAn account which will override the default account for the line item.
Items[index].OverrideItemAccountNameAn account which will override the default account for the line item.
PersonalDataPrefWhether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionModeThe mode of connection to QuickBooks.
QBFileStatusThe status of the company file as it pertains to accepting connections.
QBOpenCompanyFileThe file currently open in QuickBooks.
SendRawXMLSends specified XML to quickbooks without modification.
SSLAcceptServerCertThe SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFileThe SSL certificate file being used by the Remote Connector.
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
Tax1TotalCanadian field used for Goods and Services Tax, or GST.
Tax2TotalCanadian field used for Provincial Sales Taxes, or PST.
TimeCreatedThe time the object was created.
TimeModifiedThe time the object was created.
UnattendedModePrefWhether connecting while QuickBooks is closed is required or optional for the user.
WarningCodesA comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 Python Edition - Version 20.0 [Build 7941]