Purchase Orders
The PurchaseOrder object is a record of request for a product or service between a buyer and seller.The PurchaseOrder object
Properties
statusEnumOptional
The purchase order's status. Possible values include:
DRAFT, SUBMITTED, AUTHORIZED, BILLED, DELETED, or - in cases where there is no clear mapping - the original value passed through.issue_dateStringOptional
The purchase order's issue date.
delivery_dateStringOptional
The purchase order's delivery date.
delivery_addressStringOptional
The purchase order's delivery address.
customerStringOptional
The contact making the purchase order.
vendorStringOptional
The party fulfilling the purchase order.
memoStringOptional
A memo attached to the purchase order.
companyStringOptional
The company the purchase order belongs to.
total_amountNumberOptional
The purchase order's total amount.
currencyEnumOptional
The purchase order's currency. Possible values include:
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, or - in cases where there is no clear mapping - the original value passed through.exchange_rateStringOptional
The purchase order's exchange rate.
line_itemsPurchaseOrderLineItem[]Required
The PurchaseOrderLineItem object
The
PurchaseOrderLineItem object is used to represent a purchase order's line item.JSON
{"remote_id": "121222","description": "Pickleball paddles","unit_price": 25,"quantity": 10,"item": "0958cbc6-6040-430a-848e-aafacbadf4ae","account": "3fa85f64-5717-4562-b3fc-2c963f66afa6","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","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","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","modified_at": "2021-10-16T00:00:00Z"}
Properties
tracking_categoriesArrayRequired
The purchase order line item's associated tracking categories.
remote_idStringOptional
The third-party API ID of the matching object.
descriptionStringOptional
A description of the good being purchased.
unit_priceNumberOptional
The line item's unit price.
quantityNumberOptional
The line item's quantity.
itemStringOptional
accountStringOptional
The purchase order line item's account.
tracking_categoryStringOptional
The purchase order line item's associated tracking category.
tax_amountStringOptional
The purchase order line item's tax amount.
total_line_amountStringOptional
The purchase order line item's total amount.
currencyEnumOptional
The purchase order line item's currency. Possible values include:
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, or - in cases where there is no clear mapping - the original value passed through.exchange_rateStringOptional
The purchase order line item's exchange rate.
companyStringOptional
The company the purchase order line item belongs to.
modified_atStringRequired
This is the datetime that this object was last updated by Merge
tracking_categoriesArrayRequired
remote_created_atStringOptional
When the third party's purchase order note was created.
remote_updated_atStringOptional
When the third party's purchase order note was updated.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
field_mappingsObjectOptional
modified_atStringRequired
This is the datetime that this object was last updated by Merge
remote_dataRemoteData[]Optional
The PurchaseOrder object
JSON
{"status": "SUBMITTED","issue_date": "2020-03-31T00:00:00Z0","delivery_date": "2020-04-15T00:00:00Z","delivery_address": {"street_1": "2920 Broadway","street_2": "2nd Floor","city": "New York","state": "NY","country": "USA","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","line_items": [{"remote_id": "121222","description": "Pickleball paddles","unit_price": 25,"quantity": 10,"item": "0958cbc6-6040-430a-848e-aafacbadf4ae","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","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","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"},{"description": "Pickleball Balls","unit_price": 1,"quantity": 10,"item": "249c9faa-3045-4a31-953b-8f22d3613301","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tracking_categories": ["f1214c24-2702-4617-b74b-3ddecfc0d384","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"tax_amount": 10,"total_line_amount": 20}],"tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","remote_was_deleted": true,"id": "0048ea5b-911e-4dff-9364-92070dea62ff","remote_id": "239741",Show advanced fields}
GET
/purchase-orders
Returns a list of PurchaseOrder objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
company_idStringOptional
If provided, will only return purchase orders for this company.
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
issue_date_afterStringOptional
If provided, will only return objects created after this datetime.
issue_date_beforeStringOptional
If provided, will only return objects created before this datetime.
modified_afterStringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeStringOptional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
Which fields should be returned in non-normalized form.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"status": "SUBMITTED","issue_date": "2020-03-31T00:00:00Z0","delivery_date": "2020-04-15T00:00:00Z","delivery_address": {"street_1": "2920 Broadway","street_2": "2nd Floor","city": "New York","state": "NY","country": "USA","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","line_items": [{"remote_id": "121222","description": "Pickleball paddles","unit_price": 25,"quantity": 10,"item": "0958cbc6-6040-430a-848e-aafacbadf4ae","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","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","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"},{"description": "Pickleball Balls","unit_price": 1,"quantity": 10,"item": "249c9faa-3045-4a31-953b-8f22d3613301","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tracking_categories": ["f1214c24-2702-4617-b74b-3ddecfc0d384","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"tax_amount": 10,"total_line_amount": 20}],"tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","remote_was_deleted": true,"id": "0048ea5b-911e-4dff-9364-92070dea62ff","remote_id": "239741",Show advanced fields}]}
Field support by platform
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsPurchaseOrderLineItem[]remote_idstringdescriptionstringunit_pricenumberquantitynumberitemstringaccountstringtracking_categoriesarraytax_amountstringtotal_line_amountstringcurrencyEnumdelivery_addressStringissue_dateStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertracking_categoriesArrayvendorString
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsPurchaseOrderLineItem[]remote_idstringunit_pricenumberquantitynumberitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringexchange_ratestringcompanyStringcurrencyEnumexchange_rateStringissue_dateStringmemoStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertracking_categoriesArrayvendorString
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsPurchaseOrderLineItem[]remote_idstringdescriptionstringunit_pricenumberquantitynumberitemstringtracking_categoriesarraytotal_line_amountstringcurrencyEnumdelivery_addressStringexchange_rateStringissue_dateStringmemoStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertracking_categoriesArrayvendorString
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsPurchaseOrderLineItem[]remote_idstringdescriptionstringunit_pricenumberquantitynumberitemstringaccountstringtracking_categoriesarraytax_amountstringtotal_line_amountstringcurrencyEnumdelivery_dateStringexchange_rateStringissue_dateStringmemoStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbervendorString
Zoho Books
Hint: Use the /linked-accounts endpoint to pull platform support information.
POST
/purchase-orders
Creates a PurchaseOrder object with the given values.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.statusEnumThe purchase order's status. Must pass in one of the following choices:
DRAFT, SUBMITTED, AUTHORIZED, BILLED, DELETED.issue_dateStringThe purchase order's issue date.
delivery_dateStringThe purchase order's delivery date.
delivery_addressStringThe purchase order's delivery address. Must pass in a valid Merge ID, which can be obtained from the
id field in the Address object.customerStringThe contact making the purchase order. Must pass in a valid Merge ID, which can be obtained from the
id field in the Customer object.vendorStringThe party fulfilling the purchase order. Must pass in a valid Merge ID, which can be obtained from the
id field in the Contact object.memoStringA memo attached to the purchase order.
companyStringThe company the purchase order belongs to. Must pass in a valid Merge ID, which can be obtained from the
id field in the CompanyInfo object.total_amountNumberThe purchase order's total amount.
currencyEnumThe purchase order's currency. Must pass in one of the following choices:
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_rateStringThe purchase order's exchange rate.
line_itemsArrayintegration_paramsObjectlinked_account_paramsObjectPOST v1/purchase-orders
JSON
{"model": {"issue_date": "2023-05-26T22:33:51.581Z","delivery_date": "2023-05-26T22:33:51.581Z","delivery_address": "3fa85f64-5717-4562-b3fc-2c963f66afa6","customer": "3fa85f64-5717-4562-b3fc-2c963f66afa6","vendor": "3fa85f64-5717-4562-b3fc-2c963f66afa6","memo": "string","company": "3fa85f64-5717-4562-b3fc-2c963f66afa6","total_amount": 0,"exchange_rate": "string","line_items": [{"remote_id": "121222","description": "Pickleball paddles","unit_price": 25,"quantity": 10,"item": "0958cbc6-6040-430a-848e-aafacbadf4ae","account": "3fa85f64-5717-4562-b3fc-2c963f66afa6","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","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","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"}]}}
Response
JSON
{"model": {"status": "SUBMITTED","issue_date": "2020-03-31T00:00:00Z0","delivery_date": "2020-04-15T00:00:00Z","delivery_address": {"street_1": "2920 Broadway","street_2": "2nd Floor","city": "New York","state": "NY","country": "USA","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","line_items": [{"remote_id": "121222","description": "Pickleball paddles","unit_price": 25,"quantity": 10,"item": "0958cbc6-6040-430a-848e-aafacbadf4ae","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","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","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"},{"description": "Pickleball Balls","unit_price": 1,"quantity": 10,"item": "249c9faa-3045-4a31-953b-8f22d3613301","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tracking_categories": ["f1214c24-2702-4617-b74b-3ddecfc0d384","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"tax_amount": 10,"total_line_amount": 20}],"tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","remote_was_deleted": true,"id": "0048ea5b-911e-4dff-9364-92070dea62ff","remote_id": "239741",Show advanced fields}}
Field support by platform
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
companyStringRequired
currencyEnumRequired
delivery_addressStringOptional
exchange_rateStringRequired
issue_dateStringOptional
memoStringOptional
remote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
statusEnumOptional
total_amountNumberOptional
vendorStringRequired
Additional POST Parameters
line_itemsStringRequired
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
remote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
total_amountNumberOptional
vendorStringOptional
Additional POST Parameters
integration_paramsObjectRequired
accountStringRequired
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/purchase-orders/{id}
Returns a PurchaseOrder object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
Which fields should be returned in non-normalized form.
Response
JSON
{"status": "SUBMITTED","issue_date": "2020-03-31T00:00:00Z0","delivery_date": "2020-04-15T00:00:00Z","delivery_address": {"street_1": "2920 Broadway","street_2": "2nd Floor","city": "New York","state": "NY","country": "USA","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","line_items": [{"remote_id": "121222","description": "Pickleball paddles","unit_price": 25,"quantity": 10,"item": "0958cbc6-6040-430a-848e-aafacbadf4ae","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","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","exchange_rate": "2.9","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"},{"description": "Pickleball Balls","unit_price": 1,"quantity": 10,"item": "249c9faa-3045-4a31-953b-8f22d3613301","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tracking_categories": ["f1214c24-2702-4617-b74b-3ddecfc0d384","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"tax_amount": 10,"total_line_amount": 20}],"tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","remote_was_deleted": true,"id": "0048ea5b-911e-4dff-9364-92070dea62ff","remote_id": "239741",Show advanced fields}
Field support by platform
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsPurchaseOrderLineItem[]remote_idstringdescriptionstringunit_pricenumberquantitynumberitemstringaccountstringtracking_categoriesarraytax_amountstringtotal_line_amountstringcurrencyEnumdelivery_addressStringissue_dateStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertracking_categoriesArrayvendorStringNetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsPurchaseOrderLineItem[]remote_idstringunit_pricenumberquantitynumberitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstringexchange_ratestringcompanyStringcurrencyEnumexchange_rateStringissue_dateStringmemoStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertracking_categoriesArrayvendorStringQuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsPurchaseOrderLineItem[]remote_idstringdescriptionstringunit_pricenumberquantitynumberitemstringtracking_categoriesarraytotal_line_amountstringcurrencyEnumdelivery_addressStringexchange_rateStringissue_dateStringmemoStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertracking_categoriesArrayvendorStringXero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsPurchaseOrderLineItem[]remote_idstringdescriptionstringunit_pricenumberquantitynumberitemstringaccountstringtracking_categoriesarraytax_amountstringtotal_line_amountstringcurrencyEnumdelivery_dateStringexchange_rateStringissue_dateStringmemoStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbervendorStringZoho Books
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/purchase-orders/meta/post
Returns metadata for PurchaseOrder POSTs.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Response
JSON
{"request_schema": {},"remote_field_classes": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}
Field support by platform
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsPurchaseOrderLineItem[]remote_idstringdescriptionstringunit_pricenumberquantitynumberitemstringaccountstringtracking_categoriesarraytax_amountstringtotal_line_amountstringcurrencyEnumdelivery_addressStringissue_dateStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtotal_amountNumbertracking_categoriesArrayvendorStringNetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_itemsPurchaseOrderLineItem[]remote_idstringunit_pricenumberquantitynumberitemstringaccountstringtracking_categorystringtracking_categoriesarraytotal_line_amountstring