Skip to navigation
Common ModelsPurchase Orders

The PurchaseOrder object

A PurchaseOrder represents a request to purchase goods or services from a vendor. It outlines the details of the purchase, such as the items or services requested, quantities, prices, and delivery details.

A PurchaseOrder is a crucial component of the procurement process, but does not typically result in any impact on the company’s general ledger. The general ledger is typically only affected when the PurchaseOrder is fulfilled as an Accounts Payable Invoice object (also known as a Bill).

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
statusenum or nullOptional

The purchase order's status. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=status to receive the integration's own value instead.

Allowed values:
issue_datedatetime or nullOptional
The purchase order's issue date.
purchase_order_numberstring or nullOptional<=100 characters

The human-readable number of the purchase order.

delivery_datedatetime or nullOptional
The purchase order's delivery date.
delivery_addressstring or nullOptionalformat: "uuid"
The purchase order's delivery address.
customerstring or nullOptionalformat: "uuid"
The contact making the purchase order.
vendorstring or nullOptionalformat: "uuid"
The party fulfilling the purchase order.
memostring or nullOptional
A memo attached to the purchase order.
companystring or nullOptionalformat: "uuid"
The company the purchase order belongs to.
total_amountdouble or nullOptional
The purchase order's total amount.
currencyenum or nullOptional
The purchase order's currency. The currency code in ISO 4217 format.
exchange_ratestring or nullOptionalformat: "decimal"
The purchase order's exchange rate.
payment_termstring or nullOptionalformat: "uuid"
The payment term that applies to this transaction.
line_itemslist of objectsOptionalRead-only
inclusive_of_taxboolean or nullOptional

If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.

tracking_categorieslist of stringsOptional
accounting_periodstring or nullOptionalformat: "uuid"
The accounting period that the PurchaseOrder was generated in.
remote_created_atdatetime or nullOptional
When the third party's purchase order note was created.
remote_updated_atdatetime or nullOptional
When the third party's purchase order note was updated.
purchase_order_urlstring or nullOptionalformat: "uri"<=2000 characters
The 3rd party URL of the purchase order.
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only