Purchase Orders
ThePurchaseOrder
object is used to represent a company's purchase orders.The PurchaseOrder object
Properties
id
StringRequired
remote_id
StringOptional
The third-party API ID of the matching object.
remote_data
RemoteData[]Optional
status
EnumOptional
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_date
StringOptional
The purchase order's issue date.
delivery_date
StringOptional
The purchase order's delivery date.
delivery_address
StringOptional
The purchase order's delivery address.
customer
StringOptional
The purchase order's customer.
vendor
StringOptional
The purchase_order's vendor.
memo
StringOptional
A memo attached to the purchase order.
total_amount
NumberOptional
The purchase order's total amount.
currency
EnumOptional
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.line_items
PurchaseOrderLineItem[]Required
The PurchaseOrderLineItem object
The
PurchaseOrderLineItem
object is used to represent a purchase order's line item.JSON
{"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","tax_amount": 10,"total_line_amount": 260}
Properties
description
StringOptional
The line item's description.
unit_price
NumberOptional
The line item's unit price.
quantity
NumberOptional
The line item's quantity.
item
StringOptional
account
StringOptional
The purchase order line item's account.
tracking_category
StringOptional
The purchase order line item's associated tracking category.
tax_amount
StringOptional
The purchase order line item's tax amount.
total_line_amount
StringOptional
The purchase order line item's total amount.
remote_created_at
StringOptional
When the third party's purchase order note was created.
remote_updated_at
StringOptional
When the third party's purchase order note was updated.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
The PurchaseOrder object
JSON
{"id": "0048ea5b-911e-4dff-9364-92070dea62ff","remote_id": "239741","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"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","total_amount": 260,"currency": "USD","line_items": [{"description": "Pickleball paddles","unit_price": 25,"quantity": 10,"item": "0958cbc6-6040-430a-848e-aafacbadf4ae","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tax_amount": 10,"total_line_amount": 260},{"description": "Pickleball Balls","unit_price": 1,"quantity": 10,"item": "249c9faa-3045-4a31-953b-8f22d3613301","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tax_amount": 10,"total_line_amount": 20}],"remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","remote_was_deleted": true}
GET
/purchase-orders
Returns a list of PurchaseOrder
objects.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
created_after
StringOptional
If provided, will only return objects created after this datetime.
created_before
StringOptional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
StringOptional
If provided, will only return objects modified after this datetime.
modified_before
StringOptional
If provided, will only return objects modified before this datetime.
page_size
IntegerOptional
Number of results to return per page.
remote_fields
StringOptional
Which fields should be returned in non-normalized form.
remote_id
StringOptional
The API provider's ID for the given object.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "0048ea5b-911e-4dff-9364-92070dea62ff","remote_id": "239741","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"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","total_amount": 260,"currency": "USD","line_items": [{"description": "Pickleball paddles","unit_price": 25,"quantity": 10,"item": "0958cbc6-6040-430a-848e-aafacbadf4ae","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tax_amount": 10,"total_line_amount": 260},{"description": "Pickleball Balls","unit_price": 1,"quantity": 10,"item": "249c9faa-3045-4a31-953b-8f22d3613301","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tax_amount": 10,"total_line_amount": 20}],"remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","remote_was_deleted": true}]}
Field support by platform

NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
issue_date
Stringremote_created_at
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Number
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Enumdelivery_address
Stringissue_date
Stringremote_created_at
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Number
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Enumdelivery_date
Stringissue_date
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
NumberHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/purchase-orders/{id}
Returns a PurchaseOrder
object with the given id
.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
id
StringRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fields
StringOptional
Which fields should be returned in non-normalized form.
Response
JSON
{"id": "0048ea5b-911e-4dff-9364-92070dea62ff","remote_id": "239741","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"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","total_amount": 260,"currency": "USD","line_items": [{"description": "Pickleball paddles","unit_price": 25,"quantity": 10,"item": "0958cbc6-6040-430a-848e-aafacbadf4ae","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tax_amount": 10,"total_line_amount": 260},{"description": "Pickleball Balls","unit_price": 1,"quantity": 10,"item": "249c9faa-3045-4a31-953b-8f22d3613301","tracking_category": "f1214c24-2702-4617-b74b-3ddecfc0d384","tax_amount": 10,"total_line_amount": 20}],"remote_created_at": "2020-03-31T00:00:00Z","remote_updated_at": "2020-03-31T00:00:00Z","remote_was_deleted": true}
Field support by platform

NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
issue_date
Stringremote_created_at
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Number
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Enumdelivery_address
Stringissue_date
Stringremote_created_at
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
Number
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Enumdelivery_date
Stringissue_date
Stringremote_data
RemoteData[]remote_id
Stringremote_updated_at
Stringstatus
Enumtotal_amount
NumberHint: Use the /linked-accounts endpoint to pull platform support information.