Skip to main content

Get all purchase order items for a specific purchase order

GEThttps://api.propexo.com/v1/purchase-orders/:purchase_order_id/items

Authentication​

  • AuthorizationBearer
    Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters​

purchase_order_id stringrequired

The Propexo unique identifier for the purchase order

Query parameters​

order-by string

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

Default value: created_at:desc
updated_at_gte string | null

Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

updated_at_lte string | null

Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

last_seen_gte string | null

Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

last_seen_lte string | null

Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

offset integer | null

Possible values: >= 0

Can be used for paginating results

Default value: 0
limit integer | null

Possible values: >= 0 and <= 250

A number between 1 and 250 to determine the number of results to return in a single query

Default value: 100
property_id string

The Propexo unique identifier for the property

integration_id string

The Propexo unique identifier for the integration

integration_vendor string
Show 13 enum values
APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

The property management system of record

Response​

Successful response

    meta objectrequired
    offsetinteger

    The offset of the first result

    Possible values: >= 0

    Example: 0
    limitinteger

    The number of results to return

    Possible values: >= 0 and <= 250

    Example: 100
    orderBy object[]required

    The order of the results

  • Array [
    • object
  • ]
    • hasMoreboolean | nullnullable

    Whether there are more results

    totalinteger

    The total number of results

    Possible values: >= 0

    Example: 1000
    results object[]required
  • Array [
    • idstringrequired

    The Propexo unique identifier for the purchase order item

    Example: clwktsp9v000008l31iv218hn
    created_atstringrequired

    The date record first entered Propexo

    Example: 2024-03-21T15:38:08.337Z
    updated_atstringrequired

    The date record was last updated in Propexo

    Example: 2024-03-22T10:59:45.119Z
    last_seenstring | nullnullablerequired

    The date the record was last seen from the PMS

    Example: 2024-03-22T10:59:45.119Z
    x_idstringrequired

    The external ID from the integration vendor

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: cjld2cjxh0000qzrmn831i7rn
    x_property_idstringrequired

    The external ID of the property from the integration vendor

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: cjld2cyuq0000t3rmniod1foy
    x_location_idnullrequired

    The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

    Notice

    This field will always be null for YARDI_REST

    Example: null
    descriptionstring | nullnullablerequired

    Description of the purchase order item

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: Framing materials
    stock_codestring | nullnullablerequired

    The stock code for the purchase order item

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: STK-001
    quantity_orderedstring | nullnullablerequired

    The quantity ordered for the purchase order item

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: 10
    unit_price_in_centsnumber | nullnullablerequired

    The unit price, in cents, of the purchase order item

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: 5000
    total_cost_in_centsnumber | nullnullablerequired

    The total cost, in cents, of the purchase order item

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: 50000
    cost_codestring | nullnullablerequired

    The cost code of the purchase order item

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: 01-100
    category_codestring | nullnullablerequired

    The category code for the purchase order item

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: LABOR
    purchase_order_idstringrequired

    The Propexo unique identifier for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: cjld2cjxh0000qzrmn831i7rn
    construction_job_idstring | nullnullablerequired

    The Propexo unique identifier for the construction job

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: cjld2cjxh0000qzrmn831i7rn
    financial_account_idstring | nullnullablerequired

    The Propexo unique identifier for the financial account

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: cjld2cyuq0000t3rmniod1foy
    custom_data object | nullrequired
    object
    associated_invoice_idsstring[]required

    The IDs for invoices that are associated with the purchase order item

    Notice

    This field is not currently hydrated for YARDI_REST

    property_idstringrequired

    The Propexo unique identifier for the property

    Example: clwi5xiix000008l6ctdgafyh
    integration_idstringrequired

    The Propexo unique identifier for the integration

    Example: clwh5u07w000508me66sfh3um
    integration_vendorEnum25required

    The property management system of record

    Show 13 enum values
    YARDI_RESTAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDI
    Example: YARDI_REST
  • ]

Errors​

  • 400Bad Request
      error objectrequired
      codestringrequired
      Example: invalid_request
      messagestringrequired
      Example: invalid request
      details object
      property name*any
      Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}
GET /v1/purchase-orders/:purchase_order_id/items
curl https://api.propexo.com/v1/purchase-orders/:purchase_order_id/items \
     -H "Authorization: Bearer <token>"
200 Successful response
{
  "meta": {
    "offset": 0,
    "limit": 100,
    "orderBy": [
      {}
    ],
    "hasMore": true,
    "total": 1000
  },
  "results": [
    {
      "id": "clwktsp9v000008l31iv218hn",
      "created_at": "2024-03-21T15:38:08.337Z",
      "updated_at": "2024-03-22T10:59:45.119Z",
      "last_seen": "2024-03-22T10:59:45.119Z",
      "x_id": "cjld2cjxh0000qzrmn831i7rn",
      "x_property_id": "cjld2cyuq0000t3rmniod1foy",
      "x_location_id": null,
      "description": "Framing materials",
      "stock_code": "STK-001",
      "quantity_ordered": "10",
      "unit_price_in_cents": 5000,
      "total_cost_in_cents": 50000,
      "cost_code": "01-100",
      "category_code": "LABOR",
      "purchase_order_id": "cjld2cjxh0000qzrmn831i7rn",
      "construction_job_id": "cjld2cjxh0000qzrmn831i7rn",
      "financial_account_id": "cjld2cyuq0000t3rmniod1foy",
      "custom_data": "Unknown Type: object,null",
      "associated_invoice_ids": [
        "string"
      ],
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "YARDI_REST"
    }
  ]
}