Global API
Request

Purchase Order

7min

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

Reference to the Class associated with the transaction

CurrencyRef

value_name

Reference to the currency in which all amounts on the associated transaction are expressed.

CustomField

CustomField

One of, up to three custom fields for the transaction. Available for custom fields so configured for the company

DocNumber*

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*

LineItem

Individual line items of a transaction

Id

String

Unique identifier for this object and ReadOnly field

Metadata

Metadata

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

Identifies the address where the goods must be shipped

ShipMethodRef

value_name

Reference to the ShipMethod associated with the transaction

SalesTermRef

value_name

Reference to a SalesTerm associated with this company object

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*

value_name

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

Field Name

Data Type

Description

AccountBasedExpenseLineDetail



Amount

Decimal



DetailType

String

Provide the DetailType as SalesItemDetail, DiscountLineDetail, etc.

For Shipping charge apply the DetailType as 'SalesItemLineDetail'

Id

String



ItemBasedExpenseLineDetail



AccountBasedExpenseLineDetail

Field Name

Data Type

Description

APAccountRef

value_name



BillableStatus

String



ClassRef

value_name



VendorRef

value_name



ItemRef

value_name



Qty

Decimal



UnitPrice

Decimal



ItemBasedExpenseLine

Field Name

Data Type

Description

BillableStatus

String



VendorRef

value_name



ItemRef

value_name



Qty

Decimal



UnitPrice

Decimal





Updated 23 May 2024
Doc contributor
Did this page help you?