Search: 
Available in: QUICKBOOKS
SalesReceipt Component [IBiz Integrator for QuickBooks - V4]

Properties   Methods   Events   Configuration Settings  

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

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

Online Edition: Leave out IsPending, SalesRep*, FOB, ShipMethod, TaxItem, CustomerMessage*, and CustomerSalesTax. Example

   
SalesReceipt1.CustomerName = "John Q. Customer"             '*
SalesReceipt1.TransactionDate = "1/17/03"
SalesReceipt1.ItemCount = 1
SalesReceipt1.ItemName(0) = "Our Company's Product"         '*
SalesReceipt1.ItemAmount(0) = 14000 'number of cents
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.

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 Item* (ItemId or ItemName) or ItemGroup*, and optionally ItemRate, ItemRatePercent, ItemQuantity, ItemDescription, ItemClass*, ItemTaxCode*, ItemServiceDate, and ItemAmount 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 SalesReceipts, respectively. The OBJSEARCH component may be used to search for SalesReceipts in the QuickBooks database.

Starting with QuickBooks 2005, the SalesReceipt component can be used to reconcile credit card transactions made with the QBMSAUTHORIZE component into QuickBooks. After a successful authorization, set the CCAggregate property with the data returned from the QBMSAUTHORIZE's GetXMLAggregate method. Then do an Add as normal.

In order to be able to push credit card transactions into QuickBooks 2005 or greater, your merchant account must be signed up with QuickBooks Merchant Services. You may sign up for a live account through QuickBooks by selecting the Customers menu and then clicking on "Receive Payments". Now click on the "Process credit card payment when saving" checkbox, and follow the instructions.

If you wish to set up a TEST account, you will need to download Quickbooks SDK 5.0 from http://www.intuit.com and run the "QBMS use IDNBeta" tool. Then follow the same instructions above. When you get to the screen that indicates you should receive a confirmation email, your test account is set up, and you can now process test transactions from within QuickBooks, as well as reconcile charges made with the QBMSAUTHORIZE component using RECEIVEPAYMENT or SALESRECEIPT.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

BillingAddress Address to bill to.
CCAggregate Credit Card transaction aggregate from the QBMSAuthorize component.
CheckNumber Check number (if payment was made by check).
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.
DepositToAccountId Reference to account where money will be deposited.
DepositToAccountName Reference to account where money will be deposited.
DueDate Date when payment is due.
IsPending If true, this transaction has not been completed.
IsToBePrinted Whether this transaction is to be printed.
ItemAmount Line item property: the total amount of this line.
ItemClassId Line item property: Reference to the class of the item.
ItemClassName Line item property: Reference to the class of the item.
ItemCount Number of line items.
ItemDescription Line item property: Description of item.
ItemGroupId Line item property: Reference to a group of line items.
ItemGroupName Line item property: Reference to a group of line items.
ItemId Line item property: Reference to the kind of item.
ItemName Line item property: Reference to the kind of item.
ItemPriceLevelId Line Item Property: Specify custom pricing for specific customers.
ItemPriceLevelName Line Item Property: Specify custom pricing for specific customers.
ItemQuantity Line item property: Quantity of item or item group.
ItemRate Unit rate of item.
ItemRatePercent Line item property: A markup or discount percentage.
ItemServiceDate Line item property: Date of service.
ItemTaxCodeId Line item property: Sales tax information for this item.
ItemTaxCodeName Line item property: Sales tax information for this item.
Memo Memo to appear on internal reports only.
PaymentMethodId Reference to method of payment.
PaymentMethodName Reference to method of payment.
QBAddRequestAggregate Request aggregate for an Add.
QBConnectionMode The mode of connection to QuickBooks.
QBConnectionString An aggregate consisting of various QuickBooks connection properties.
QBOpenCompanyFile The file currently open in QuickBooks.
QBRequestId The Id of the next message to be sent to QuickBooks.
QBResponseAggregate The last XML response aggregate received from QuickBooks.
QBUpdateRequestAggregate Request aggregate for an Update.
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.
TotalAmount Subtotal + SalesTaxTotal.
TransactionDate Date of transaction.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.

AXMExport Exports the object.
AXMImport Imports the object.
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 component configuration setting.
Delete Deletes the record from QuickBooks.
Get Gets a single record from QuickBooks.
GetCustomField Gets a custom field value from QuickBooks.
OpenQBConnection Opens a persistent connection to QuickBooks.
Reset Resets all properties to their defaults.
SetCustomField Sets a custom field value within QuickBooks.
WebExport Exports the object to a web client.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

Error Information about errors during data delivery.
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 component with short descriptions. Click on the links for complete descriptions.

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.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
CreditCardTxnInfo XML aggregate containing the result of an actual credit card transaction to be reconciled with QuickBooks.
CustomerSalesTaxId Reference to sales tax information for the .
CustomerSalesTaxName Reference to sales tax information for the .
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.
FOB Freight On Board: the place from where shipped.
GetHighestVersion Highest QBXMLVersion supported by the installed instance of Quickbooks.
IgnoreQBOEWarnings Ignores warnings returned from QuickBooks Online.
ItemsAggregate Allows the user to set the item xml directly.
SSLAcceptServerCert The SSL certificate being used by the Remote Connector
SSLAcceptServerCertFile The SSL certificate file being used by the Remote Connector
SalesTaxPercentage Percent paid as sales tax.
SendRawXML Sends specified XML to quickbooks without modification.
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.
{Items[index].Amount} The amount in dollars for the line item at the specified index.
{Items[index].Cost} The cost in dollars for the line item at the specified index.
{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.
{Items[index].Quantity} The quantity for the line item at the specified index.
{Items[index].Rate} The rate in dollars for the line item at the specified index.

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.