---
title: Purchase Order
slug: quickbooks/purchase-order
docTags: 
createdAt: 2024-03-06T10:30:19.097Z
---

When processing a Purchase Order, use the requestJSON to pass the Purchase Order data. The returned response will contain a responseJSON section with the Purchase Order response returned by Breadwinner for QuickBooks.

The Purchase Order object has the following parameters.

### Purchase Order

| **Field Name**                          | **Data Type**                                  | **Description**                                                                                                                                            |
| --------------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ClassRef                                | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK)    | Reference to the Class associated with the transaction                                                                                                     |
| CurrencyRef                             | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK)    | Reference to the currency in which all amounts on the associated transaction are expressed.                                                                |
| CustomField                             | [CustomField](docId\:j53AXK0QEbupb8e_WaV9-)    | One of, up to three custom fields for the transaction. Available for custom fields so configured for the company                                           |
| DocNumber<font color="#e00707">*</font> | String                                         | Purchase Order Number                                                                                                                                      |
| DueDate                                 | String                                         | Date when the payment of the transaction is due. (add by converting date to string)                                                                        |
| EmailStatus                             | String                                         | Email status of the PO. Valid values: NotSet, NeedToSend, EmailSent                                                                                        |
| ExchangeRate                            | Decimal                                        | The number of home currency units it takes to equal one unit of currency specified by CurrencyRef, Applicable if multicurrency is enabled for the company. |
| GlobalTaxCalculation                    | String                                         | Fixed values (NotApplicable, TaxInclusive,TaxExcluded)                                                                                                     |
| HomeBalance                             | Decimal                                        | Read Only                                                                                                                                                  |
| Line<font color="#e00707">*</font>      | [LineItem](docId\:j53AXK0QEbupb8e_WaV9-)       | Individual line items of a transaction                                                                                                                     |
| Id                                      | String                                         | Unique identifier for this object and ReadOnly field                                                                                                       |
| Metadata                                | [Metadata](docId\:GoAsZtQI8wCZGotEKYtEK)       | Descriptive information about the object. The MetaData values are set by Data Services and are read only                                                   |
| PrivateNote                             | String                                         | User entered, organization-private note about the transaction                                                                                              |
| ShipAddr                                | [AddressWrapper](docId\:GoAsZtQI8wCZGotEKYtEK) | Identifies the address where the goods must be shipped                                                                                                     |
| ShipMethodRef                           | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK)    | Reference to the ShipMethod associated with the transaction                                                                                                |
| SalesTermRef                            | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK)    | Reference to a SalesTerm associated with this company object                                                                                               |
| Sparse                                  | Boolean                                        | Allows updating only specified properties of an object while leaving unspecified properties unchanged.                                                     |
| SyncToken                               | String                                         | Version number of the object. It is used to lock an object for use by one app at a time. Read Only                                                         |
| TotalAmt                                | Decimal                                        | Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Read Only                                |
| TxnDate                                 | String                                         | The date entered by the user when this transaction occurred. (add by converting date to string in yyyy-mm-dd format)                                       |
| VendorRef<font color="#e00707">*</font> | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK)    | The ID (Unique QuickBooks Online ID) for the referenced vendor                                                                                             |

### POEmailClass

| **Field Name** | **Data Type**  | **Description** |
| -------------- | -------------- | --------------- |
| POEmail        | String         |                 |

### CustomFieldDetails 

| **Field Name** | **Data Type**  | **Description** |
| -------------- | -------------- | --------------- |
| DefinitionId   | String         |                 |
| Name           | String         |                 |
| Type           | String         |                 |

### LineItem&#x20;

| **Field Name**                | **Data Type**                                                 | **Description**                                                                                                                             |
| ----------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| AccountBasedExpenseLineDetail | [AccountBasedExpenseLineDetail](docId\:j53AXK0QEbupb8e_WaV9-) |                                                                                                                                             |
| Amount                        | Decimal                                                       |                                                                                                                                             |
| DetailType                    | String                                                        | Provide the DetailType as SalesItemDetail, DiscountLineDetail, etc. <br />For Shipping charge apply the DetailType as 'SalesItemLineDetail' |
| Id                            | String                                                        |                                                                                                                                             |
| ItemBasedExpenseLineDetail    | [ItemBasedExpenseLineDetail](docId\:j53AXK0QEbupb8e_WaV9-)    |                                                                                                                                             |

### AccountBasedExpenseLineDetail

| **Field Name** | **Data Type**                               | **Description** |
| -------------- | ------------------------------------------- | --------------- |
| APAccountRef   | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) |                 |
| BillableStatus | String                                      |                 |
| ClassRef       | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) |                 |
| VendorRef      | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) |                 |
| ItemRef        | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) |                 |
| Qty            | Decimal                                     |                 |
| UnitPrice      | Decimal                                     |                 |

### ItemBasedExpenseLine

| **Field Name** | **Data Type**                               | **Description** |
| -------------- | ------------------------------------------- | --------------- |
| BillableStatus | String                                      |                 |
| VendorRef      | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) |                 |
| ItemRef        | [value\_name](docId\:GoAsZtQI8wCZGotEKYtEK) |                 |
| Qty            | Decimal                                     |                 |
| UnitPrice      | Decimal                                     |                 |

###





