PurchaseOrder Class
Properties Methods Events Configuration Settings Errors
A PurchaseOrder is used to order goods from a VENDOR .
Syntax
inqb.purchaseorder()
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 class supports a variety of other operations as well. The class's Get and Delete methods may be used to retrieve and delete PurchaseOrders, respectively. The ObjSearch Class 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 class with short descriptions. Click on the links for further details.
DueDate | Date when payment is due. |
ExpectedDate | Date shipment is expected. |
IncludeLinkedTxns | Indicates whether to include linked transactions in the response. |
IsFullyReceived | Indicates whether all of the items in the purchase order have been received. |
IsToBePrinted | Whether this transaction is to be printed. |
ItemCount | The number of records in the Item arrays. |
ItemLineId | Identification number of the transaction line, used for Updates. |
ItemAggregate | Contains an XML aggregate of the line item. |
ItemName | Line item property: Reference to the kind of item. |
ItemId | Line item property: Reference to the kind of item. |
ItemDescription | Line item property: Description of item. |
ItemQuantity | Line item property: Quantity of item or item group. |
ItemUnitOfMeasure | Unit of measure describing the Quantity . |
ItemRate | Unit rate of item. |
ItemClassName | Line item property: Reference to the class of the item. |
ItemClassId | Line item property: Reference to the class of the item. |
ItemAmount | Line item property: the total amount of this item. |
ItemCustomerName | Line item property: A reference to customer for whom the item was ordered. |
ItemCustomerId | Line item property: A reference to customer for whom the item was ordered. |
ItemServiceDate | Line item property: Date of service. |
ItemOverrideAccountName | An account which will override the default account for the line item. |
ItemOverrideAccountId | An account which will override the default account for the line item. |
ItemOther1 | Standard QuickBooks Custom Field available for transaction line items. |
ItemOther2 | Standard QuickBooks Custom Field available for transaction line items. |
ItemGroupName | Reference to a group of line items. |
ItemGroupId | Reference to a group of line items. |
ItemManuallyClosed | Indicates if the line item has been manually closed. |
ItemPartNumber | Manufacturer's part number. |
ItemReceivedQuantity | The quantity that has been received against this purchase order. |
LinkedTxnCount | The number of records in the LinkedTxn arrays. |
LinkedTxnAmount | The amount of the linked transaction. |
LinkedTxnDate | The date of the linked transaction. |
LinkedTxnLinkType | Indicates the nature of the link between the transactions. |
LinkedTxnRefNumber | This is the reference number assigned to the linked transaction. |
LinkedTxnId | This property can be used by another component to reference the original transaction which is linked to the current response. |
LinkedTxnType | This property indicates which type of linked transaction has been returned. |
ManuallyClosed | Whether the purchase order is manually closed. |
Memo | Memo to appear on internal reports only. |
Other1 | Pre-defined QuickBooks Custom Field. |
Other2 | Pre-defined QuickBooks Custom Field. |
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. |
ShipMethodId | Reference to preferred method of shipping. |
ShipMethodName | Reference to preferred method of shipping. |
ShippingAddress | Address to ship to. |
ShipToId | Reference to entity to whom shipment is to be made. |
ShipToName | Reference to entity to whom shipment is to be made. |
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 class with short descriptions. Click on the links for further details.
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 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 purchase order 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.
IsToBeEmailed | . |
IsTaxIncluded | Indicates whether the dollar amounts in the line items include tax or not. |
SalesTaxCodeName | The type of sales tax that will be charged for this Purchase Order. |
SalesTaxCodeId | The type of sales tax that will be charged for this Purchase Order. |
SendRawXML | Sends specified XML to quickbooks without modification. |
AppendAfter | Appends an XML tag after the specified QBXML element. |
TimeCreated | The time the object was created. |
TimeModified | The time the object was created. |
EditSequence | An identifier for this copy of the object. |
TemplateName | The name of an existing template to apply to the transaction. |
TemplateId | The ID of an existing template to apply to the transaction. |
FOB | Freight On Board: the place from where shipped. |
ClassName | A reference to the class of transaction. |
ClassId | A reference to the class of transaction. |
Items[index].OverrideItemAccountName | An account which will override the default account for the line item. |
Items[index].OverrideItemAccountId | An account which will override the default account for the line item. |
StopOnError | Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. |
SSLAcceptServerCert | The SSL certificate being used by the Remote Connector. |
SSLAcceptServerCertFile | The SSL certificate file being used by the Remote Connector. |
EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
GetHighestVersion | Highest QBXMLVersion supported by the installed instance of QuickBooks. |
GetSupportedVersions | Returns a list of QBXMLVersions that are supported by QuickBooks. |
GetRequestProcessorDLLVersion | Returns the version of the QB Request Processor that is installed on your system. |
IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
UnattendedModePref | Whether connecting while QuickBooks is closed is required or optional for the user. |
PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
QBOpenCompanyFile | The file currently open in QuickBooks. |
QBConnectionMode | The mode of connection to QuickBooks. |
QBFileStatus | The status of the company file as it pertains to accepting connections. |
WarningCodes | A comma-separated list of QuickBooks warning codes that should not result in an exception. |
Tax1Total | Canadian field used for Goods and Services Tax, or GST. |
Tax2Total | Canadian field used for Provincial Sales Taxes, or PST. |
ExchangeRate | Indicates the exchange rate for the transaction. |
CodePage | The system code page used for Unicode to Multibyte translations. |