Key

PurchaseTransactionKey

N/A

N/A

The purchase transaction key object that uniquely identifies the purchase order.

Type

PurchaseOrderType

N/A

Standard

Specifies the type of purchase order document.

VendorKey

VendorKey

N/A

N/A

The vendor key object that specifies the vendor who will be filling the purchase order.

VendorName

string

64

If not provided, the name is based on the vendor key.

The name of the vendor who will be filling the purchase order.

Date

dateTime

N/A

If blank, set to the system date.

The date of the purchase order.

BuyerKey

BuyerKey

N/A

Empty

The buyer key object that specifies the buyer responsible for the purchase order.

DoesAllowSalesOrder
Commitments

boolean

N/A

False

Specifies whether the purchase order can be committed to outstanding sales orders.

CustomerKey

CustomerKey

N/A

Empty

The customer key object that specifies which customer the purchase order will be drop shipped to. This value is required for drop ship purchase orders.

ShipToAddressKey

AddressKey

N/A

Will default based on CompanyKey

The address key object that specifies where the purchase order will be shipped.

ShipToAddress

BusinessAddress

N/A

Will default based on ShipToAddressKey

The address where the purchase order will be shipped.

PurchaseAddressKey

AddressKey

N/A

Will default based on VendorKey

The address key object that specifies the vendor’s address.

PurchaseAddress

BusinessAddress

N/A

Will default based on PurchaseAddressKey

The address for the vendor.

BillToAddressKey

AddressKey

N/A

Empty

The address key object that specifies who should be billed for the purchase.

ShippingMethodKey

ShippingMethodKey

N/A

Empty

The shipping method key that specifies the shipping method for the purchase.

PaymentTermsKey

PaymentTermsKey

N/A

Empty

The payment terms key object that specifies the payment terms for the purchase.

Terms

Terms

N/A

N/A

Specifies the payment terms (such as the discount) for the purchase.

TaxRegistrationNumber

string

25

Empty

The vendor’s tax registration number.

ConfirmWith

string

20

Empty

The person at the purchasing company that must confirm the purchase can be initiated.

CommentKey

CommentKey

N/A

Empty

The identifier for the comment that will apprear on the purchase order.

IsOnHold

boolean

N/A

False

Indicates whether the purchase is on hold.

TaxScheduleKey

TaxScheduleKey

N/A

Empty

The tax schedule key object that identifies the tax schedule for the purchasing company specific to the items being purchased.

FreightTaxBasis

PurchasingTaxBasis

N/A

Nontaxable

Specifies how taxes are calculated on freight for the purchase.

MiscellaneousTaxBasis

PurchasingTaxBasis

N/A

Nontaxable

Specifies how taxes are calculated on miscellaneous costs for the purchase.

FreightTaxScheduleKey

TaxScheduleKey

N/A

Empty

The tax schedule key object that identifies the tax schedule to use when calculating tax for the freight amount.

MiscellaneousTax
ScheduleKey

TaxScheduleKey

N/A

Empty

The tax schedule key object that identifies the tax schedule to use when calculating tax for the miscellaneous amount.

CurrencyKey

CurrencyKey

N/A

Empty

The currency key object that specifies the currency the purchase order was transacted in.

ExchangeRate

decimal

N/A

0

The exchange rate of the purchase order. Set this value only for multi-currency transactions. If there is triangulation and both rates are fixed, this is the originating to Euro fixed rate. Otherwise this is the variable rate.

ExchangeDate

dateTime

N/A

If not provided, will be set to the purchase order date.

The exchange date associated with the exchange rate provided.

CreatedBy

string

N/A

Set to the user ID who created the purchase order.

The user who created the purchase order. This property is read-only.

Status

PurchaseOrderStatus

N/A

New

The status of the purchase order. This property is read-only.

Comment

string

500

Empty

The comment associated with the purchase order.

PromisedDate

dateTime

N/A

Empty

The date the vendor promised the entire order would be received.

PromisedShipDate

dateTime

N/A

Empty

The date the vendor promised to ship the entire purchase order.

RequestedDate

dateTime

N/A

Empty

The date the entire purchase order must be received.

ContractEndDate

dateTime

N/A

Empty

The date the contract with the vendor expires.

StatusGroup

StatusGroup

N/A

Active

Indicates the status of a purchase order. This property is read-only.

RequisitionDate

dateTime

N/A

N/A

The requisition date (when the purchase order originated as a requisition). This property is read-only.

CompanyKey

CompanyKey

N/A

N/A

The company key object specifying the company. This property is read-only.

RemainingSubtotal

MoneyAmount

N/A

N/A

The cost of the items remaining to invoice for the purchase order. This property is read-only.

Subtotal

MoneyAmount

N/A

N/A

The total of the extended costs of all the line items for the purchase order before taxes, freight and miscellaneous charges are added to the costs and the trade discounts are subtracted from the costs. This property is read-only.

CanceledSubtotal

MoneyAmount

N/A

N/A

The total of the canceled line items for the purchase order. This property is read-only.

TradeDiscountAmount

MoneyAmount

N/A

0

The amount of the trade discount for the purchase order. If a trade discount percentage was specified for the customer the trade discount amount is calculated by the system.

FreightAmount

MoneyAmount

N/A

0

The freight amount for the purchase order.

MiscellaneousAmount

MoneyAmount

N/A

0

The amount of miscellaneous charges for the purchase order.

TaxAmount

MoneyAmount

N/A

N/A

The tax amount for the summed details for Tax, FreightTax and MiscelleaneousTax.

LastEditDate

dateTime

N/A

N/A

The date the purchase order was last edited. This property is read-only.

LastPrintedDate

dateTime

N/A

N/A

The date the purchase order was last printed. This property is read-only.

TimesPrinted

int

N/A

N/A

The number of time the purchase order has been printed. This property is read-only.

CreatedDate

dateTime

N/A

System date

The date the purchase order was created. This property is read-only.

ModifiedDate

dateTime

N/A

System date

The date the purchase order was last modified. The value is in Coordinated Universal Time (UTC). This property is read-only.

RevisionNumber

int

N/A

N/A

The purchase order’s revision number. This property is read-only.

TransactionState

PurchaseOrderTransactionState

N/A

Work

The state of the purchase order transaction. This property is read-only.

FreightTaxAmount

MoneyAmount

N/A

0

The freight tax amount.

MiscellaneousTaxAmount

MoneyAmount

N/A

0

The miscellaneous tax amount.

BackoutTaxAmount

MoneyAmount

N/A

N/A

The backout tax amount. This property is read-only.

BackoutFreightTax
Amount

MoneyAmount

N/A

N/A

The backout freight tax amount. This property is read-only.

BackoutMiscellaneousTax
Amount

MoneyAmount

N/A

N/A

The backout miscellaneous tax amount. This property is read-only.

FreightTaxes

ArrayOfPurchaseTax

N/A

N/A

The collection of freight taxes for the purchase order.

MiscellaneousTaxes

ArrayOfPurchaseTax

N/A

N/A

The collection of miscellaneous taxes for the purchase order.

Taxes

ArrayOfPurchaseTax

N/A

N/A

The collection of taxes for the purchase order.

Lines

ArrayOfPurchaseOrderLine

N/A

N/A

A collection of purchase order lines for the purchase order.

WorkflowPriority

WorkflowPriority

N/A

N/A

The priority of the purchase order in the workflow. This property is read-only.

Workflows

ArrayOfWorkflow

N/A

N/A

The collection of workflow objects for the purchase order. This property is read-only.

ContractNumber

string

20

Empty

The contract number for the purchase order. This property is read-only.

TotalAmount

MoneyAmount

N/A

N/A

The total amount of the purchase order.