QuickBooks Integrator 2020 C++ Builder Edition

Questions / Feedback?

CreditMemo Component

Properties   Methods   Events   Configuration Settings   Errors  

A CreditMemo indicates that a CUSTOMER is owed money by the QuickBooks company. A CreditMemo is the opposite of an INVOICE .

Syntax

TiqbCreditMemo

Remarks

The CreditMemo component represents a credit memo sent to a Customer. When a CreditMemo is added, the total amount is automatically entered into the Accounts Receivable register.

Required Fields (Add): Customer*, Items

Supported Methods: Add, Get (Id), Cancel, Delete DueDate, SalesRep*, FOB, ShipMethod, TaxItem, and CustomerSalesTax.

Example

CreditMemo1.CustomerName = "John Q. Customer"             '*
CreditMemo1.TransactionDate = "1/17/03"
CreditMemo1.ItemCount = 1
CreditMemo1.ItemName(0) = "Our Company's Product"         '*
CreditMemo1.ItemAmount(0) = "140.00" 
CreditMemo1.Add()

'*: Item must already exist in QuickBooks.

TotalAmount is the total of the item lines. It is computed automatically, and should never be set.

Item Lines: Item lines are used to track the sale of goods or services. Line items may be added by first setting ItemCount. Then for each line set the Item Id (or Name) or Group. You may also optionally set the Rate/RatePercent/PriceLevel, Quantity, Description, Class, TaxCode, ServiceDate, and Amount for each item as well.

The 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 CreditMemos, respectively. The ObjSearch Component may be used to search for CreditMemos 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.

ARAccountIdReference to the Accounts Receivable account where money goes.
ARAccountNameReference to the Accounts Receivable account where money goes.
BillingAddressAddress to bill to.
CustomerIdA reference to the customer or customer job.
CustomerMessageIdReference to message to appear to customer.
CustomerMessageNameReference to message to appear to customer.
CustomerNameA reference to the customer or customer job.
DueDateDate when payment is due.
IncludeLinkedTxnsIndicates whether to include linked transactions in the response.
IsPendingIf true, this transaction has not been completed.
IsToBePrintedWhether this transaction is to be printed.
ItemCountThe number of records in the Item arrays.
ItemAggregateContains an XML aggregate of the line item.
ItemAmountLine item property: the total amount of this item.
ItemClassIdLine item property: Reference to the class of the item.
ItemClassNameLine item property: Reference to the class of the item.
ItemDescriptionLine item property: Description of item.
ItemGroupIdReference to a group of line items.
ItemGroupNameReference to a group of line items.
ItemIdLine item property: Reference to the kind of item.
ItemNameLine item property: Reference to the kind of item.
ItemLineIdIdentification number of the transaction line, used for Updates.
ItemOther1Standard QuickBooks Custom Field available for transaction line items.
ItemOther2Standard QuickBooks Custom Field available for transaction line items.
ItemOverrideAccountIdAn account which will override the default account for the line item.
ItemOverrideAccountNameAn account which will override the default account for the line item.
ItemPriceLevelIdLine Item property: Used to specify custom pricing for specific customers.
ItemPriceLevelNameLine Item property: Specify custom pricing for specific customers.
ItemQuantityLine item property: Quantity of item or item group.
ItemRateUnit rate of item.
ItemRatePercentLine item property: A markup or discount percentage.
ItemServiceDateLine item property: Date of service.
ItemTaxCodeIdLine item property: Sales tax information for this item.
ItemTaxCodeNameLine item property: Sales tax information for this item.
ItemUnitOfMeasureUnit of measure describing the Quantity .
LinkedTxnCountThe number of records in the LinkedTxn arrays.
LinkedTxnAmountThe amount of the linked transaction.
LinkedTxnDateThe date of the linked transaction.
LinkedTxnLinkTypeIndicates the nature of the link between the transactions.
LinkedTxnRefNumberThis is the reference number assigned to the linked transaction.
LinkedTxnIdThis property can be used by another component to reference the original transaction which is linked to the current response.
LinkedTxnTypeThis property indicates which type of linked transaction has been returned.
MemoMemo to appear on internal reports only.
PONumberP.O. number.
QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
QBRequestAggregateThe request aggregate.
QBRequestIdThe Id of the next message to be sent to QuickBooks.
QBRequestModeDefines whether the request is made online or stored offline.
QBResponseAggregateThe last QBXML 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.
SalesRepIdReference to (initials of) sales rep.
SalesRepNameReference to (initials of) sales rep.
SalesTaxTotalTotal amount of sales tax.
ShipDateDate of shipping.
ShipMethodIdReference to preferred method of shipping.
ShipMethodNameReference to preferred method of shipping.
ShippingAddressAddress to ship to.
SubtotalGross subtotal; doesn't count taxes/amount already paid.
TaxItemIdReference to detailed taxation information.
TaxItemNameReference to detailed taxation information.
TermsIdReference to terms of payment.
TermsNameReference to terms of payment.
TotalAmountSubtotal + SalesTaxTotal.
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.
ImportQBXMLImports a QBXML response aggregate.
OpenQBConnectionOpens a persistent connection to QuickBooks.
ResetResets all properties to their defaults.
SetCustomFieldSets 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 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.

AppendAfterAppends an XML tag after the specified QBXML element.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
ClassIdA reference to the class of transaction.
ClassNameA reference to the class of transaction.
CreditRemainingAvailable Credit.
CustomerSalesTaxIdReference to sales tax information for the CUSTOMER.
CustomerSalesTaxNameReference to sales tax information for the CUSTOMER.
EditSequenceAn identifier for this copy of the object.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
ExchangeRateIndicates the exchange rate for the transaction.
FirstNameA first name.
FOBFreight On Board: the place from where shipped.
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.
IsToBeEmailedWhen true, if no email address is on file for the customer the transaction will fail.
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.
LastNameA last name.
MiddleInitialA middle initial.
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.
SalesTaxPercentagePercent paid as sales tax.
SalutationA salutation, such as Mr., Mrs., etc.
SendRawXMLSends specified XML to quickbooks without modification.
SeparateContactA contact person other than the person specified by Salutation, FirstName, MiddleInitial, and LastName.
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.
TemplateIdThe ID of an existing template to apply to the transaction.
TemplateNameThe name of an existing template to apply to the transaction.
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.
UseInternalSecurityAPITells the component 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 C++ Builder Edition - Version 20.0 [Build 7941]