QuickBooks Integrator V6 - Online Help
QuickBooks Integrator V6
Questions / Feedback?

SalesReceipt Component

Properties   Methods   Events   Configuration Settings   Errors  

A SalesReceipt is used to record point-of-sale payments.

Syntax

nsoftware.InQB.Salesreceipt

Remarks

The SalesReceipt component represents a point-of-sale payment by a Customer. A SalesReceipt should be used in place of an Invoice when full payment is received at the time of sale.

Required Fields (Add): Customer*, Items

Supported Methods: Add, Get (Id), Cancel, Delete

Example

SalesReceipt1.CustomerName = "John Q. Customer"             '*
SalesReceipt1.TransactionDate = "1/17/03"
SalesReceipt1.LineItems.Add(New SalesReceiptItem())
SalesReceipt1.LineItems(0).ItemName = "Our Company's Product"         '*
SalesReceipt1.LineItems(0).Amount = "140.00" 
SalesReceipt1.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 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 SalesReceipts, respectively. The ObjSearch Component may be used to search for SalesReceipts 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.

BillingAddressAddress to bill to.
CheckNumberCheck number (if payment was made by check).
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.
DepositToAccountIdReference to account where money will be deposited.
DepositToAccountNameReference to account where money will be deposited.
DueDateDate when payment is due.
IsPendingIf true, this transaction has not been completed.
IsToBePrintedWhether this transaction is to be printed.
LineItemsCollection of line items.
MemoMemo to appear on internal reports only.
PaymentMethodIdReference to method of payment.
PaymentMethodNameReference to method of payment.
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.
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 sales order 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.

SendRawXMLSends specified XML to quickbooks without modification.
AppendAfterAppends an XML tag after the specified QBXML element.
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.
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.
CreditCardTxnInfoXML aggregate containing the result of an actual credit card transaction to be reconciled with QuickBooks.
IsToBeEmailed.
IsTaxIncludedIndicates whether the dollar amounts in the line items include tax or not.
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.
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.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0