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
inqb.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.LineItems.Add(New CreditMemoItem()) CreditMemo1.LineItems(0).ItemName = "Our Company's Product" '* CreditMemo1.LineItems(0).Amount = "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.
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.
ARAccountId | Reference to the Accounts Receivable account where money goes. |
ARAccountName | Reference to the Accounts Receivable account where money goes. |
BillingAddress | Address to bill to. |
CustomerId | A reference to the customer or customer job. |
CustomerMessageId | Reference to message to appear to customer. |
CustomerMessageName | Reference to message to appear to customer. |
CustomerName | A reference to the customer or customer job. |
DueDate | Date when payment is due. |
IncludeLinkedTxns | Indicates whether to include linked transactions in the response. |
IsPending | If true, this transaction has not been completed. |
IsToBePrinted | Whether this transaction is to be printed. |
LineItems | Collection of line items. |
LinkedTxns | Information used to reference a transaction that is linked to the existing transaction. |
Memo | Memo to appear on internal reports only. |
PONumber | P.O. number. |
QBConnectionString | An aggregate consisting of various QuickBooks connection properties. |
QBRequestAggregate | The request aggregate. |
QBRequestId | The Id of the next message to be sent to QuickBooks. |
QBRequestMode | Defines whether the request is made online or stored offline. |
QBResponseAggregate | The last QBXML response aggregate received from QuickBooks. |
QBXMLVersion | The version of QBXML used in the outgoing message. |
RefId | An alphanumerical identifier generated by the server. |
RefNumber | Reference number for the transaction. |
SalesRepId | Reference to (initials of) sales rep. |
SalesRepName | Reference to (initials of) sales rep. |
SalesTaxTotal | Total amount of sales tax. |
ShipDate | Date of shipping. |
ShipMethodId | Reference to preferred method of shipping. |
ShipMethodName | Reference to preferred method of shipping. |
ShippingAddress | Address to ship to. |
Subtotal | Gross subtotal; doesn't count taxes/amount already paid. |
TaxItemId | Reference to detailed taxation information. |
TaxItemName | Reference to detailed taxation information. |
TermsId | Reference to terms of payment. |
TermsName | Reference to terms of payment. |
TotalAmount | Subtotal + SalesTaxTotal. |
TransactionDate | Date 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.
Add | Adds the record into QuickBooks. |
Cancel | Cancels (voids) the transaction. |
CheckRequestStatus | Checks whether or not the specified request was processed by QuickBooks. |
CloseQBConnection | Closes a persistent connection to QuickBooks. |
Config | Sets or retrieves a configuration setting. |
Delete | Deletes the record from QuickBooks. |
Get | Gets a single record from QuickBooks. |
GetCustomField | Gets a custom field value from QuickBooks. |
ImportQBXML | Imports a QBXML response aggregate. |
OpenQBConnection | Opens a persistent connection to QuickBooks. |
Reset | Resets all properties to their defaults. |
SetCustomField | Sets a custom field value within QuickBooks. |
Update | Updates 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.
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Status | Shows the progress of the QuickBooks connection. |
Warning | Fired 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.
AppendAfter | Appends an XML tag after the specified QBXML element. |
AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
ClassId | A reference to the class of transaction. |
ClassName | A reference to the class of transaction. |
CreditRemaining | Available Credit. |
CustomerSalesTaxId | Reference to sales tax information for the CUSTOMER. |
CustomerSalesTaxName | Reference to sales tax information for the CUSTOMER. |
EditSequence | An identifier for this copy of the object. |
EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
ExchangeRate | Indicates the exchange rate for the transaction. |
FirstName | A first name. |
FOB | Freight On Board: the place from where shipped. |
GetHighestVersion | Highest QBXMLVersion supported by the installed instance of QuickBooks. |
GetRequestProcessorDLLVersion | Returns the version of the QB Request Processor that is installed on your system. |
GetSupportedVersions | Returns a list of QBXMLVersions that are supported by QuickBooks. |
IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
IsToBeEmailed | When true, if no email address is on file for the customer the transaction will fail. |
Items[index].OverrideItemAccountId | An account which will override the default account for the line item. |
Items[index].OverrideItemAccountName | An account which will override the default account for the line item. |
LastName | A last name. |
MiddleInitial | A middle initial. |
PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
QBConnectionMode | The mode of connection to QuickBooks. |
QBFileStatus | The status of the company file as it pertains to accepting connections. |
QBOpenCompanyFile | The file currently open in QuickBooks. |
SalesTaxPercentage | Percent paid as sales tax. |
Salutation | A salutation, such as Mr., Mrs., etc. |
SendRawXML | Sends specified XML to quickbooks without modification. |
SeparateContact | A contact person other than the person specified by Salutation, FirstName, MiddleInitial, and LastName. |
SSLAcceptServerCert | The SSL certificate being used by the Remote Connector. |
SSLAcceptServerCertFile | The SSL certificate file being used by the Remote Connector. |
StopOnError | Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. |
Tax1Total | Canadian field used for Goods and Services Tax, or GST. |
Tax2Total | Canadian field used for Provincial Sales Taxes, or PST. |
TemplateId | The ID of an existing template to apply to the transaction. |
TemplateName | The name of an existing template to apply to the transaction. |
TimeCreated | The time the object was created. |
TimeModified | The time the object was created. |
UnattendedModePref | Whether connecting while QuickBooks is closed is required or optional for the user. |
WarningCodes | A comma-separated list of QuickBooks warning codes that should not result in an exception. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the class whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
UseDaemonThreads | Whether threads created by the class are daemon threads. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |