QuickBooks Integrator 2020 Delphi Edition

Questions / Feedback?

PurchaseOrder Component

Properties   Methods   Events   Configuration Settings   Errors  

A PurchaseOrder is used to order goods from a VENDOR .

Syntax

TiqbPurchaseOrder

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

Example

PurchaseOrder1.VendorName = "ACME Inc."            '*
PurchaseOrder1.TransactionDate = "1/17/03"
PurchaseOrder1.ItemCount = 1
PurchaseOrder1.ItemName(0) = "ACME Widget X"  '*
PurchaseOrder1.ItemAmount(0) = "299.95"
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 ItemCount. This will initialize the Items array. For each item you add, set the Item Id (or Name) to an item that has been defined in QuickBooks. The Item Rate, Quantity, Description, Class, Customer, ServiceDate, and Amount properties may be optionally 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 further details.

DueDateDate when payment is due.
ExpectedDateDate shipment is expected.
IncludeLinkedTxnsIndicates whether to include linked transactions in the response.
IsFullyReceivedIndicates whether all of the items in the purchase order have been received.
IsToBePrintedWhether this transaction is to be printed.
LineItemsCollection of line items.
LinkedTxnsInformation used to reference a transaction that is linked to the existing transaction.
ManuallyClosedWhether the purchase order is manually closed.
MemoMemo to appear on internal reports only.
Other1Pre-defined QuickBooks Custom Field.
Other2Pre-defined QuickBooks Custom Field.
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.
ShipMethodIdReference to preferred method of shipping.
ShipMethodNameReference to preferred method of shipping.
ShippingAddressAddress to ship to.
ShipToIdReference to entity to whom shipment is to be made.
ShipToNameReference to entity to whom shipment is to be made.
TermsIdReference to terms of payment.
TermsNameReference to terms of payment.
TotalAmountThe total amount.
TransactionDateDate of transaction.
VendorAddressAddress of vendor.
VendorIdReference to the vendor for this transaction.
VendorMessageMessage to appear to vendor.
VendorNameReference 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 further details.

AddAdds the record into QuickBooks.
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 purchase 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.

AppendAfterAppends an XML tag after the specified QBXML element.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
ClassIdA reference to the class of transaction.
ClassNameA reference to the class of transaction.
EditSequenceAn identifier for this copy of the object.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
ExchangeRateIndicates the exchange rate for the transaction.
FOBFreight On Board: the place from where shipped.
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnlyThis causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
IsTaxIncludedIndicates whether the dollar amounts in the line items include tax or not.
IsToBeEmailed.
Items[index].OverrideItemAccountIdAn account which will override the default account for the line item.
Items[index].OverrideItemAccountNameAn account which will override the default account for the line item.
PersonalDataPrefWhether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionModeThe mode of connection to QuickBooks.
QBFileStatusThe status of the company file as it pertains to accepting connections.
QBOpenCompanyFileThe file currently open in QuickBooks.
SalesTaxCodeIdThe type of sales tax that will be charged for this Purchase Order.
SalesTaxCodeNameThe type of sales tax that will be charged for this Purchase Order.
SendRawXMLSends specified XML to quickbooks without modification.
SSLAcceptServerCertThe SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFileThe SSL certificate file being used by the Remote Connector.
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
Tax1TotalCanadian field used for Goods and Services Tax, or GST.
Tax2TotalCanadian field used for Provincial Sales Taxes, or PST.
TemplateIdThe ID of an existing template to apply to the transaction.
TemplateNameThe name of an existing template to apply to the transaction.
TimeCreatedThe time the object was created.
TimeModifiedThe time the object was created.
UnattendedModePrefWhether connecting while QuickBooks is closed is required or optional for the user.
WarningCodesA comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 Delphi Edition - Version 20.0 [Build 7941]