Common ModelsPurchase Orders

/purchase-orders/{id}

Returns a PurchaseOrder object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsbooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:
show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
Allowed values:

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
statusenum or null
The purchase order's status. * `DRAFT` - DRAFT * `SUBMITTED` - SUBMITTED * `AUTHORIZED` - AUTHORIZED * `BILLED` - BILLED * `DELETED` - DELETED
Allowed values:
issue_datedatetime or null
The purchase order's issue date.
purchase_order_numberstring or null<=100 characters

The human-readable number of the purchase order.

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

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

tracking_categorieslist of strings
accounting_periodstring or nullformat: "uuid"
The accounting period that the PurchaseOrder was generated in.
remote_created_atdatetime or null
When the third party's purchase order note was created.
remote_updated_atdatetime or null
When the third party's purchase order note was updated.
remote_was_deletedbooleanRead-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 nullRead-only
remote_datalist of objects or nullRead-only
remote_fieldslist of objectsRead-only

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information