/n software QuickBooks Integrator purchaseorder Component : purchaseorder OCX, purchaseorder .NET Component, purchaseorder Class, purchaseorder Bean, purchaseorder Object

Available in: QUICKBOOKS

PurchaseOrder Component [IBiz Integrator for QuickBooks - V4]

Properties Methods Events Configuration Settings

A PurchaseOrder is used to order goods from a VENDOR.

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

A PurchaseOrder is used when ordering goods from a VENDOR. It does not affect the company's balance sheet or income statement, and should be used when the QuickBooks company has not yet paid or received a BILL.

Required Fields (Add): Vendor*, Items

Supported Methods: Add, Get (Id), Delete

Online Edition: Not supported. Example

PurchaseOrder1.VendorName = "ACME Inc." '* PurchaseOrder1.TransactionDate = "1/17/03" PurchaseOrder1.ItemCount = 1 PurchaseOrder1.ItemName(0) = "ACME Widget X" '* PurchaseOrder1.ItemAmount(0) = 29995 'number of cents PurchaseOrder1.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 ordering of goods or services. To add item lines to the transaction, first set the value of ItemCount. This will initialize the Items array. Then, set each Item (ItemName or ItemId) to an item that has been defined in QuickBooks by setting ItemId or ItemName. The ItemRate, ItemRatePercent, ItemQuantity, ItemDescription, ItemClass, ItemCustomer, ItemServiceDate, and ItemAmount properties may be set for each item as well.

The component supports a variety of other operations as well. The component's Get and Delete methods may be used to retrieve and delete PurchaseOrders, respectively. The OBJSEARCH component may be used to search for PurchaseOrders in the QuickBooks database.

Note that unlike in posting transactions, there is no Cancel method.

Property List

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


DueDate	Date when payment is due.
ExpectedDate	Date shipment is expected.
IncludeLinkedTxns	Indicates whether to include linked transactions in the response.
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.
ItemCustomerId	Line item property: A reference to customer for whom the item was ordered.
ItemCustomerName	Line item property: A reference to customer for whom the item was ordered.
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.
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.
LinkedTxnAmount	Linked Transaction property: The amount of the transaction.
LinkedTxnCount	Linked Transaction property: Number of linked transactions.
LinkedTxnDate	Linked Transaction property: The date of the transaction.
LinkedTxnId	Linked Transaction property: Reference to the kind of item.
LinkedTxnLinkType	Linked Transaction property: Indicates the nature of the link between the transactions.
LinkedTxnRefNumber	Linked Transaction property: Reference number for the linked transaction.
LinkedTxnType	Linked Transaction property: The type of the transaction.
Memo	Memo to appear on internal reports only.
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.
ShipMethodId	Reference to preferred method of shipping.
ShipMethodName	Reference to preferred method of shipping.
ShipToId	Reference to entity to whom shipment is to be made.
ShipToName	Reference to entity to whom shipment is to be made.
ShippingAddress	Address to ship to.
TermsId	Reference to terms of payment.
TermsName	Reference to terms of payment.
TotalAmount	The total amount.
TransactionDate	Date of transaction.
VendorAddress	Address of vendor.
VendorId	Reference to the vendor for this transaction.
VendorMessage	Message to appear to vendor.
VendorName	Reference to the vendor for this 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.
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.
Update	Updates the purchase order in 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).
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.
IncludeLinkedTxns	Indicates to QuickBooks whether to return transactions linked to this request.
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
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.