> This page is for Unified. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.merge.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server. # /purchase-orders/{id} GET https://api.merge.dev/api/accounting/v1/purchase-orders/{id} Returns a `PurchaseOrder` object with the given `id`. Reference: https://docs.merge.dev/merge-unified/accounting/common-models/purchase-orders/retrieve ## Authentication - `Authorization` header (bearer token, required) — Token-based authentication with required prefix "Bearer" ## Servers - `https://api.merge.dev/api` (Production, default) - `https://api-eu.merge.dev/api` (ProductionEU) - `https://api-ap.merge.dev/api` (ProductionAPSE1) ## Request ### Path parameters - `id` (string, required) ### Query parameters - `expand` (list of enum, optional) — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - Allowed values: `accounting_period`, `company`, `delivery_address`, `line_items`, `payment_term`, `tracking_categories`, `vendor` - `include_remote_data` (boolean, optional) — Whether to include the original data Merge fetched from the third-party to produce these models. - `include_remote_fields` (boolean, optional) — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - `include_shell_data` (boolean, optional) — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - `remote_fields` (enum, optional) — Deprecated. Use show_enum_origins. - Allowed values: `status` - `show_enum_origins` (enum, optional) — 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: `status` ### Headers - `X-Account-Token` (string, required) — Token identifying the end user. ## Response ### 200 - `id` (string, optional) - `remote_id` (string, optional, nullable) — The third-party API ID of the matching object. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `status` (enum, optional, nullable) — 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: `DRAFT`, `SUBMITTED`, `AUTHORIZED`, `BILLED`, `DELETED` - `issue_date` (datetime, optional, nullable) — The purchase order's issue date. - `purchase_order_number` (string, optional, nullable) — The human-readable number of the purchase order. - `delivery_date` (datetime, optional, nullable) — The purchase order's delivery date. - `delivery_address` (string, optional, nullable) — The purchase order's delivery address. - `customer` (string, optional, nullable) — The contact making the purchase order. - `vendor` (string, optional, nullable) — The party fulfilling the purchase order. - `memo` (string, optional, nullable) — A memo attached to the purchase order. - `company` (string, optional, nullable) — The company the purchase order belongs to. - `total_amount` (double, optional, nullable) — The purchase order's total amount. - `currency` (enum, optional, nullable) — The purchase order's currency. The currency code in ISO 4217 format. - Allowed values: `XUA`, `AFN`, `AFA`, `ALL`, `ALK`, `DZD`, `ADP`, `AOA`, `AOK`, `AON`, `AOR`, `ARA`, `ARS`, `ARM`, `ARP`, `ARL`, `AMD`, `AWG`, `AUD`, `ATS`, `AZN`, `AZM`, `BSD`, `BHD`, `BDT`, `BBD`, `BYN`, `BYB`, `BYR`, `BEF`, `BEC`, `BEL`, `BZD`, `BMD`, `BTN`, `BOB`, `BOL`, `BOV`, `BOP`, `BAM`, `BAD`, `BAN`, `BWP`, `BRC`, `BRZ`, `BRE`, `BRR`, `BRN`, `BRB`, `BRL`, `GBP`, `BND`, `BGL`, `BGN`, `BGO`, `BGM`, `BUK`, `BIF`, `XPF`, `KHR`, `CAD`, `CVE`, `KYD`, `XAF`, `CLE`, `CLP`, `CLF`, `CNX`, `CNY`, `CNH`, `COP`, `COU`, `KMF`, `CDF`, `CRC`, `HRD`, `HRK`, `CUC`, `CUP`, `CYP`, `CZK`, `CSK`, `DKK`, `DJF`, `DOP`, `NLG`, `XCD`, `DDM`, `ECS`, `ECV`, `EGP`, `GQE`, `ERN`, `EEK`, `ETB`, `EUR`, `XBA`, `XEU`, `XBB`, `XBC`, `XBD`, `FKP`, `FJD`, `FIM`, `FRF`, `XFO`, `XFU`, `GMD`, `GEK`, `GEL`, `DEM`, `GHS`, `GHC`, `GIP`, `XAU`, `GRD`, `GTQ`, `GWP`, `GNF`, `GNS`, `GYD`, `HTG`, `HNL`, `HKD`, `HUF`, `IMP`, `ISK`, `ISJ`, `INR`, `IDR`, `IRR`, `IQD`, `IEP`, `ILS`, `ILP`, `ILR`, `ITL`, `JMD`, `JPY`, `JOD`, `KZT`, `KES`, `KWD`, `KGS`, `LAK`, `LVL`, `LVR`, `LBP`, `LSL`, `LRD`, `LYD`, `LTL`, `LTT`, `LUL`, `LUC`, `LUF`, `MOP`, `MKD`, `MKN`, `MGA`, `MGF`, `MWK`, `MYR`, `MVR`, `MVP`, `MLF`, `MTL`, `MTP`, `MRU`, `MRO`, `MUR`, `MXV`, `MXN`, `MXP`, `MDC`, `MDL`, `MCF`, `MNT`, `MAD`, `MAF`, `MZE`, `MZN`, `MZM`, `MMK`, `NAD`, `NPR`, `ANG`, `TWD`, `NZD`, `NIO`, `NIC`, `NGN`, `KPW`, `NOK`, `OMR`, `PKR`, `XPD`, `PAB`, `PGK`, `PYG`, `PEI`, `PEN`, `PES`, `PHP`, `XPT`, `PLN`, `PLZ`, `PTE`, `GWE`, `QAR`, `XRE`, `RHD`, `RON`, `ROL`, `RUB`, `RUR`, `RWF`, `SVC`, `WST`, `SAR`, `RSD`, `CSD`, `SCR`, `SLL`, `XAG`, `SGD`, `SKK`, `SIT`, `SBD`, `SOS`, `ZAR`, `ZAL`, `KRH`, `KRW`, `KRO`, `SSP`, `SUR`, `ESP`, `ESA`, `ESB`, `XDR`, `LKR`, `SHP`, `XSU`, `SDD`, `SDG`, `SDP`, `SRD`, `SRG`, `SZL`, `SEK`, `CHF`, `SYP`, `STN`, `STD`, `TVD`, `TJR`, `TJS`, `TZS`, `XTS`, `THB`, `XXX`, `TPE`, `TOP`, `TTD`, `TND`, `TRY`, `TRL`, `TMT`, `TMM`, `USD`, `USN`, `USS`, `UGX`, `UGS`, `UAH`, `UAK`, `AED`, `UYW`, `UYU`, `UYP`, `UYI`, `UZS`, `VUV`, `VES`, `VEB`, `VEF`, `VND`, `VNN`, `CHE`, `CHW`, `XOF`, `YDD`, `YER`, `YUN`, `YUD`, `YUM`, `YUR`, `ZWN`, `ZRN`, `ZRZ`, `ZMW`, `ZMK`, `ZWD`, `ZWR`, `ZWL` - `exchange_rate` (string, optional, nullable) — The purchase order's exchange rate. - `payment_term` (string, optional, nullable) — The payment term that applies to this transaction. - `line_items` (list of PurchaseOrderLineItem, optional) - `inclusive_of_tax` (boolean, optional, nullable) — If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. - `tracking_categories` (list of string, optional) - `accounting_period` (string, optional, nullable) — The accounting period that the PurchaseOrder was generated in. - `remote_created_at` (datetime, optional, nullable) — When the third party's purchase order note was created. - `remote_updated_at` (datetime, optional, nullable) — When the third party's purchase order note was updated. - `purchase_order_url` (string, optional, nullable) — The 3rd party URL of the purchase order. - `remote_was_deleted` (boolean, optional) — 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](https://docs.merge.dev/integrations/hris/supported-features/). - `field_mappings` (PurchaseOrderFieldMappings, optional, nullable) - `remote_data` (list of RemoteData, optional, nullable) - `remote_fields` (list of RemoteField, optional) ## Types ### PurchaseOrderLineItem # The PurchaseOrderLineItem Object ### Description The `PurchaseOrderLineItem` object is used to represent a purchase order's line item. ### Usage Example Fetch from the `GET PurchaseOrder` endpoint and view a company's purchase orders. - `id` (string, optional) - `remote_id` (string, optional, nullable) — The third-party API ID of the matching object. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `description` (string, optional, nullable) — A description of the good being purchased. - `unit_price` (double, optional, nullable) — The line item's unit price. - `quantity` (double, optional, nullable) — The line item's quantity. - `item` (string, optional, nullable) - `account` (string, optional, nullable) — The purchase order line item's account. - `tracking_categories` (list of string, optional) — The purchase order line item's associated tracking categories. - `tax_amount` (string, optional, nullable) — The purchase order line item's tax amount. - `total_line_amount` (string, optional, nullable) — The purchase order line item's total amount. - `currency` (enum, optional, nullable) — The purchase order line item's currency. The currency code in ISO 4217 format. - Allowed values: `XUA`, `AFN`, `AFA`, `ALL`, `ALK`, `DZD`, `ADP`, `AOA`, `AOK`, `AON`, `AOR`, `ARA`, `ARS`, `ARM`, `ARP`, `ARL`, `AMD`, `AWG`, `AUD`, `ATS`, `AZN`, `AZM`, `BSD`, `BHD`, `BDT`, `BBD`, `BYN`, `BYB`, `BYR`, `BEF`, `BEC`, `BEL`, `BZD`, `BMD`, `BTN`, `BOB`, `BOL`, `BOV`, `BOP`, `BAM`, `BAD`, `BAN`, `BWP`, `BRC`, `BRZ`, `BRE`, `BRR`, `BRN`, `BRB`, `BRL`, `GBP`, `BND`, `BGL`, `BGN`, `BGO`, `BGM`, `BUK`, `BIF`, `XPF`, `KHR`, `CAD`, `CVE`, `KYD`, `XAF`, `CLE`, `CLP`, `CLF`, `CNX`, `CNY`, `CNH`, `COP`, `COU`, `KMF`, `CDF`, `CRC`, `HRD`, `HRK`, `CUC`, `CUP`, `CYP`, `CZK`, `CSK`, `DKK`, `DJF`, `DOP`, `NLG`, `XCD`, `DDM`, `ECS`, `ECV`, `EGP`, `GQE`, `ERN`, `EEK`, `ETB`, `EUR`, `XBA`, `XEU`, `XBB`, `XBC`, `XBD`, `FKP`, `FJD`, `FIM`, `FRF`, `XFO`, `XFU`, `GMD`, `GEK`, `GEL`, `DEM`, `GHS`, `GHC`, `GIP`, `XAU`, `GRD`, `GTQ`, `GWP`, `GNF`, `GNS`, `GYD`, `HTG`, `HNL`, `HKD`, `HUF`, `IMP`, `ISK`, `ISJ`, `INR`, `IDR`, `IRR`, `IQD`, `IEP`, `ILS`, `ILP`, `ILR`, `ITL`, `JMD`, `JPY`, `JOD`, `KZT`, `KES`, `KWD`, `KGS`, `LAK`, `LVL`, `LVR`, `LBP`, `LSL`, `LRD`, `LYD`, `LTL`, `LTT`, `LUL`, `LUC`, `LUF`, `MOP`, `MKD`, `MKN`, `MGA`, `MGF`, `MWK`, `MYR`, `MVR`, `MVP`, `MLF`, `MTL`, `MTP`, `MRU`, `MRO`, `MUR`, `MXV`, `MXN`, `MXP`, `MDC`, `MDL`, `MCF`, `MNT`, `MAD`, `MAF`, `MZE`, `MZN`, `MZM`, `MMK`, `NAD`, `NPR`, `ANG`, `TWD`, `NZD`, `NIO`, `NIC`, `NGN`, `KPW`, `NOK`, `OMR`, `PKR`, `XPD`, `PAB`, `PGK`, `PYG`, `PEI`, `PEN`, `PES`, `PHP`, `XPT`, `PLN`, `PLZ`, `PTE`, `GWE`, `QAR`, `XRE`, `RHD`, `RON`, `ROL`, `RUB`, `RUR`, `RWF`, `SVC`, `WST`, `SAR`, `RSD`, `CSD`, `SCR`, `SLL`, `XAG`, `SGD`, `SKK`, `SIT`, `SBD`, `SOS`, `ZAR`, `ZAL`, `KRH`, `KRW`, `KRO`, `SSP`, `SUR`, `ESP`, `ESA`, `ESB`, `XDR`, `LKR`, `SHP`, `XSU`, `SDD`, `SDG`, `SDP`, `SRD`, `SRG`, `SZL`, `SEK`, `CHF`, `SYP`, `STN`, `STD`, `TVD`, `TJR`, `TJS`, `TZS`, `XTS`, `THB`, `XXX`, `TPE`, `TOP`, `TTD`, `TND`, `TRY`, `TRL`, `TMT`, `TMM`, `USD`, `USN`, `USS`, `UGX`, `UGS`, `UAH`, `UAK`, `AED`, `UYW`, `UYU`, `UYP`, `UYI`, `UZS`, `VUV`, `VES`, `VEB`, `VEF`, `VND`, `VNN`, `CHE`, `CHW`, `XOF`, `YDD`, `YER`, `YUN`, `YUD`, `YUM`, `YUR`, `ZWN`, `ZRN`, `ZRZ`, `ZMW`, `ZMK`, `ZWD`, `ZWR`, `ZWL` - `tax_rate` (string, optional, nullable) — The tax rate that applies to this line item. - `exchange_rate` (string, optional, nullable) — The purchase order line item's exchange rate. - `company` (string, optional, nullable) — The company the purchase order line item belongs to. - `remote_was_deleted` (boolean, optional) — 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](https://docs.merge.dev/integrations/hris/supported-features/). - `remote_fields` (list of RemoteField, optional) - `tracking_category` (string, optional, nullable, deprecated) — The purchase order line item's associated tracking category. ### PurchaseOrderFieldMappings - `organization_defined_targets` (map from string to any, optional) - `linked_account_defined_targets` (map from string to any, optional) ### RemoteData # The RemoteData Object ### Description The `RemoteData` object is used to represent the full data pulled from the third-party API for an object. ### Usage Example TODO - `path` (string, required) — The third-party API path that is being called. - `data` (any, optional) — The data returned from the third-party for this object in its original, unnormalized format. ### RemoteField - `remote_field_class` (RemoteFieldClass, required) - `value` (map from string to any, optional) ### RemoteFieldClass - `id` (string, optional) - `display_name` (string, optional) - `remote_key_name` (string, optional) - `description` (string, optional) - `is_custom` (boolean, optional) - `is_common_model_field` (boolean, optional) - `is_required` (boolean, optional) - `field_type` (enum, optional) - Allowed values: `string`, `number`, `date`, `datetime`, `bool`, `list` - `field_format` (enum, optional) - Allowed values: `string`, `number`, `date`, `datetime`, `bool`, `list` - `field_choices` (list of string, optional) - `item_schema` (ItemSchema, optional) ### ItemSchema - `item_type` (enum, optional) - Allowed values: `string`, `number`, `date`, `datetime`, `bool`, `list` - `item_format` (enum, optional) - Allowed values: `string`, `number`, `date`, `datetime`, `bool`, `list` - `item_choices` (list of string, optional) ## Examples **Response** ```json { "id": "0048ea5b-911e-4dff-9364-92070dea62ff", "remote_id": "239741", "created_at": "2021-09-15T00:00:00Z", "modified_at": "2021-10-16T00:00:00Z", "status": "SUBMITTED", "issue_date": "2020-03-31T00:00:00Z", "purchase_order_number": "PO1234", "delivery_date": "2020-04-15T00:00:00Z", "delivery_address": { "city": "New York", "country": "US", "state": "NY", "street_1": "2920 Broadway", "street_2": "2nd Floor", "zip_code": "10027" }, "customer": "3e442c5d-8f51-4103-b5c9-dcee39c30a08", "vendor": "2c22ce34-5c6e-4fc7-a594-7f26bb4cf78b", "memo": "private note", "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5", "total_amount": 260, "currency": "USD", "exchange_rate": "2.9", "payment_term": "89d329de-825f-4ac6-8369-3c58b4e68bee", "line_items": [ { "remote_id": "121222", "description": "Pickleball paddles", "unit_price": 25, "quantity": 10, "item": "0958cbc6-6040-430a-848e-aafacbadf4ae", "tracking_categories": [ "f1214c24-2702-4617-b74b-3ddecfc0d384", "9b840d2-686a-465a-8a8e-7b028498f8e4", "a47e11b6-c73b-4a0c-be31-130fc48177fa" ], "tax_amount": "10", "total_line_amount": "260", "currency": "USD", "tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384", "exchange_rate": "2.9", "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5", "remote_was_deleted": false }, { "description": "Pickleball Balls", "unit_price": 1, "quantity": 10, "item": "249c9faa-3045-4a31-953b-8f22d3613301", "tracking_categories": [ "f1214c24-2702-4617-b74b-3ddecfc0d384", "9b840d2-686a-465a-8a8e-7b028498f8e4", "a47e11b6-c73b-4a0c-be31-130fc48177fa" ], "tax_amount": "10", "total_line_amount": "20" } ], "inclusive_of_tax": true, "tracking_categories": [ "b38c59b0-a9d7-4740-b1ee-5436c6751e3d", "9b840d2-686a-465a-8a8e-7b028498f8e4", "a47e11b6-c73b-4a0c-be31-130fc48177fa" ], "accounting_period": "2c22ce34-5c6e-4fc7-a594-7f26bb4cf78b", "remote_created_at": "2020-03-31T00:00:00Z", "remote_updated_at": "2020-03-31T00:00:00Z", "purchase_order_url": "https://qbo.intuit.com/app/purchaseorder/239741", "remote_was_deleted": true, "field_mappings": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } }, "remote_data": [ { "path": "/actions", "data": null } ], "remote_fields": [ { "remote_field_class": { "id": "string", "display_name": "string", "remote_key_name": "string", "description": "string", "is_custom": true, "is_common_model_field": true, "is_required": true, "field_type": "string", "field_format": "string", "field_choices": [ "string" ], "item_schema": { "item_type": "string", "item_format": "string", "item_choices": [ "string" ] } }, "value": "string" } ] } ``` **SDK Code** ```python import requests url = "https://api.merge.dev/api/accounting/v1/purchase-orders/id" querystring = {"include_remote_data":"true"} headers = { "X-Account-Token": "X-Account-Token", "Authorization": "Bearer " } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.merge.dev/api/accounting/v1/purchase-orders/id?include_remote_data=true'; const options = { method: 'GET', headers: {'X-Account-Token': 'X-Account-Token', Authorization: 'Bearer '} }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.merge.dev/api/accounting/v1/purchase-orders/id?include_remote_data=true" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Account-Token", "X-Account-Token") req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.merge.dev/api/accounting/v1/purchase-orders/id?include_remote_data=true") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Account-Token"] = 'X-Account-Token' request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.merge.dev/api/accounting/v1/purchase-orders/id?include_remote_data=true") .header("X-Account-Token", "X-Account-Token") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.merge.dev/api/accounting/v1/purchase-orders/id?include_remote_data=true', [ 'headers' => [ 'Authorization' => 'Bearer ', 'X-Account-Token' => 'X-Account-Token', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.merge.dev/api/accounting/v1/purchase-orders/id?include_remote_data=true"); var request = new RestRequest(Method.GET); request.AddHeader("X-Account-Token", "X-Account-Token"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-Account-Token": "X-Account-Token", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.merge.dev/api/accounting/v1/purchase-orders/id?include_remote_data=true")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```