QuickBooks Integrator 2016 macOS Edition
QuickBooks Integrator 2016 macOS 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

CreditMemo

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)itemIndex Contains an XML aggregate of the line item.
- itemAmount:(int)itemIndex Line item property: the total amount of this item.
- itemClassId:(int)itemIndex Line item property: Reference to the class of the item.
- itemClassName:(int)itemIndex Line item property: Reference to the class of the item.
- itemDescription:(int)itemIndex Line item property: Description of item.
- itemGroupId:(int)itemIndex Reference to a group of line items.
- itemGroupName:(int)itemIndex Reference to a group of line items.
- itemId:(int)itemIndex Line item property: Reference to the kind of item.
- itemName:(int)itemIndex Line item property: Reference to the kind of item.
- itemLineId:(int)itemIndex Identification number of the transaction line, used for Updates.
- itemOther1:(int)itemIndex Standard QuickBooks Custom Field available for transaction line items.
- itemOther2:(int)itemIndex Standard QuickBooks Custom Field available for transaction line items.
- itemOverrideAccountId:(int)itemIndex An account which will override the default account for the line item.
- itemOverrideAccountName:(int)itemIndex An account which will override the default account for the line item.
- itemPriceLevelId:(int)itemIndex Line Item property: Used to specify custom pricing for specific customers.
- itemPriceLevelName:(int)itemIndex Line Item property: Specify custom pricing for specific customers.
- itemQuantity:(int)itemIndex Line item property: Quantity of item or item group.
- itemRate:(int)itemIndex Unit rate of item.
- itemRatePercent:(int)itemIndex Line item property: A markup or discount percentage.
- itemServiceDate:(int)itemIndex Line item property: Date of service.
- itemTaxCodeId:(int)itemIndex Line item property: Sales tax information for this item.
- itemTaxCodeName:(int)itemIndex Line item property: Sales tax information for this item.
- itemUnitOfMeasure:(int)itemIndex Unit of measure describing the Quantity .
- linkedTxnCountThe number of records in the LinkedTxn arrays.
- linkedTxnAmount:(int)linkedTxnIndex The amount of the linked transaction.
- linkedTxnDate:(int)linkedTxnIndex The date of the linked transaction.
- linkedTxnLinkType:(int)linkedTxnIndex Indicates the nature of the link between the transactions.
- linkedTxnRefNumber:(int)linkedTxnIndex This is the reference number assigned to the linked transaction.
- linkedTxnId:(int)linkedTxnIndex This property can be used by another component to reference the original transaction which is linked to the current response.
- linkedTxnType:(int)linkedTxnIndex This 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.

CreditRemainingAvailable Credit.
SendRawXMLSends specified XML to quickbooks without modification.
AppendAfterAppends an XML tag after the specified QBXML element.
SalutationA salutation, such as Mr., Mrs., etc.
FirstNameA first name.
MiddleInitialA middle initial.
LastNameA last name.
SeparateContactA contact person other than the person specified by Salutation, FirstName, MiddleInitial, and LastName.
TimeCreatedThe time the object was created.
TimeModifiedThe time the object was created.
EditSequenceAn identifier for this copy of the object.
TemplateNameThe name of an existing template to apply to the transaction.
TemplateIdThe ID of an existing template to apply to the transaction.
CustomerSalesTaxNameReference to sales tax information for the CUSTOMER.
CustomerSalesTaxIdReference to sales tax information for the CUSTOMER.
SalesTaxPercentagePercent paid as sales tax.
FOBFreight On Board: the place from where shipped.
ClassNameA reference to the class of transaction.
ClassIdA reference to the class of transaction.
IsToBeEmailedWhen true, if no email address is on file for the customer the transaction will fail.
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.
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.
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.
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.
IsReadOnlyThis causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
UnattendedModePrefWhether connecting while QuickBooks is closed is required or optional for the user.
PersonalDataPrefWhether the connecting application will require access to personal data such as SSN or credit card information.
QBOpenCompanyFileThe file currently open in QuickBooks.
QBConnectionModeThe mode of connection to QuickBooks.
QBFileStatusThe status of the company file as it pertains to accepting connections.
WarningCodesA comma-separated list of QuickBooks warning codes that should not result in an exception.
SelectWaitMillisThe length of time in milliseconds the component will wait when DoEvents is called if there are no events to process.
CodePageThe system code page used for Unicode to Multibyte translations.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2020 /n software inc. - All rights reserved.
QuickBooks Integrator 2016 macOS Edition - Version 16.0 [Build 7353]