QuickBooks Integrator 2020 iOS Edition

Questions / Feedback?

CreditMemo Class

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

InQBCreditMemo
InQBCreditMemoSwift

Remarks

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

- 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.
- itemAggregate:(int)itemIndexContains an XML aggregate of the line item.
- itemAmount:(int)itemIndexLine item property: the total amount of this item.
- itemClassId:(int)itemIndexLine item property: Reference to the class of the item.
- itemClassName:(int)itemIndexLine item property: Reference to the class of the item.
- itemDescription:(int)itemIndexLine item property: Description of item.
- itemGroupId:(int)itemIndexReference to a group of line items.
- itemGroupName:(int)itemIndexReference to a group of line items.
- itemId:(int)itemIndexLine item property: Reference to the kind of item.
- itemName:(int)itemIndexLine item property: Reference to the kind of item.
- itemLineId:(int)itemIndexIdentification number of the transaction line, used for Updates.
- itemOther1:(int)itemIndexStandard QuickBooks Custom Field available for transaction line items.
- itemOther2:(int)itemIndexStandard QuickBooks Custom Field available for transaction line items.
- itemOverrideAccountId:(int)itemIndexAn account which will override the default account for the line item.
- itemOverrideAccountName:(int)itemIndexAn account which will override the default account for the line item.
- itemPriceLevelId:(int)itemIndexLine Item property: Used to specify custom pricing for specific customers.
- itemPriceLevelName:(int)itemIndexLine Item property: Specify custom pricing for specific customers.
- itemQuantity:(int)itemIndexLine item property: Quantity of item or item group.
- itemRate:(int)itemIndexUnit rate of item.
- itemRatePercent:(int)itemIndexLine item property: A markup or discount percentage.
- itemServiceDate:(int)itemIndexLine item property: Date of service.
- itemTaxCodeId:(int)itemIndexLine item property: Sales tax information for this item.
- itemTaxCodeName:(int)itemIndexLine item property: Sales tax information for this item.
- itemUnitOfMeasure:(int)itemIndexUnit of measure describing the Quantity .
- linkedTxnCountThe number of records in the LinkedTxn arrays.
- linkedTxnAmount:(int)linkedTxnIndexThe amount of the linked transaction.
- linkedTxnDate:(int)linkedTxnIndexThe date of the linked transaction.
- linkedTxnLinkType:(int)linkedTxnIndexIndicates the nature of the link between the transactions.
- linkedTxnRefNumber:(int)linkedTxnIndexThis is the reference number assigned to the linked transaction.
- linkedTxnId:(int)linkedTxnIndexThis property can be used by another class to reference the original transaction which is linked to the current response.
- linkedTxnType:(int)linkedTxnIndexThis 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 class 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 class with short descriptions. Click on the links for further details.

- onErrorInformation about errors during data delivery.
- onSSLServerAuthenticationFired after the server presents its certificate to the client.
- onSSLStatusShows the progress of the secure connection.
- onStatusShows the progress of the QuickBooks connection.
- onWarningFired 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).
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.
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 iOS Edition - Version 20.0 [Build 7941]