Purchase Orders

The PurchaseOrder object is used to represent a company's purchase orders.

The PurchaseOrder object

Properties


idString
Optional

remote_idString
Optional
The third-party API ID of the matching object.

remote_dataRemoteData[]
Optional

statusEnum
Optional
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_dateString
Optional
The purchase order's issue date.

delivery_dateString
Optional
The purchase order's delivery date.

delivery_addressString
Optional
The purchase order's delivery address.

total_amountNumber
Optional
The purchase order's total amount.

currencyEnum
Optional
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_itemsArray
Optional

remote_created_atString
Optional
When the third party's purchase order note was created.

remote_updated_atString
Optional
When the third party's purchase order note was updated.

The PurchaseOrder object

{
  "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"
  },
  "total_amount": 260,
  "currency": "USD",
  "line_items": [
    {
      "description": "Pickleball paddles",
      "unit_price": 25,
      "quantity": 10,
      "item": "0958cbc6-6040-430a-848e-aafacbadf4ae"
    },
    {
      "description": "Pickleball Balls",
      "unit_price": 1,
      "quantity": 10,
      "item": "249c9faa-3045-4a31-953b-8f22d3613301"
    }
  ],
  "remote_created_at": "2020-03-31T00:00:00Z",
  "remote_updated_at": "2020-03-31T00:00:00Z"
}

GET

/purchase-orders

Returns a list of PurchaseOrder objects.


Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

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

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response

{
  "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"
      },
      "total_amount": 260,
      "currency": "USD",
      "line_items": [
        {
          "description": "Pickleball paddles",
          "unit_price": 25,
          "quantity": 10,
          "item": "0958cbc6-6040-430a-848e-aafacbadf4ae"
        },
        {
          "description": "Pickleball Balls",
          "unit_price": 1,
          "quantity": 10,
          "item": "249c9faa-3045-4a31-953b-8f22d3613301"
        }
      ],
      "remote_created_at": "2020-03-31T00:00:00Z",
      "remote_updated_at": "2020-03-31T00:00:00Z"
    }
  ]
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_updated_atString

total_amountNumber

remote_dataRemoteData[]

remote_created_atString

statusEnum

currencyEnum

delivery_addressString

issue_dateString

remote_idString
GET

/purchase-orders/{id}

Returns a PurchaseOrder object with the given id.


Query & Path Parameters


idString
Required

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

Response

{
  "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"
  },
  "total_amount": 260,
  "currency": "USD",
  "line_items": [
    {
      "description": "Pickleball paddles",
      "unit_price": 25,
      "quantity": 10,
      "item": "0958cbc6-6040-430a-848e-aafacbadf4ae"
    },
    {
      "description": "Pickleball Balls",
      "unit_price": 1,
      "quantity": 10,
      "item": "249c9faa-3045-4a31-953b-8f22d3613301"
    }
  ],
  "remote_created_at": "2020-03-31T00:00:00Z",
  "remote_updated_at": "2020-03-31T00:00:00Z"
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_updated_atString

total_amountNumber

remote_dataRemoteData[]

remote_created_atString

statusEnum

currencyEnum

delivery_addressString

issue_dateString

remote_idString