Skip to main content

Get purchase order by ID

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

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

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 objectrequired
    idstringrequired

    The Propexo unique identifier for the purchase order

    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: CO-2024-001
    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: na
    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
    x_invoice_idnullrequired

    The external ID of the invoice from the integration vendor

    Notice

    This field will always be null for YARDI_REST

    Example: null
    x_vendor_idstring | nullnullablerequired

    The external ID of the vendor from the integration vendor

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: VENDOR001
    x_parent_purchase_order_idstring | nullnullablerequired

    The external ID of the purchase order from the integration vendor. This field is not null if this is a change order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Example: PO-2024-001
    numberstring | nullnullablerequired

    The number of the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: CO-2024-001
    is_closedboolean | nullnullablerequired

    Whether the purchase order is closed or not

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    descriptionstring | nullnullablerequired

    Description of the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: Construction materials
    total_amount_in_centsnumber | nullnullablerequired

    The amount of the purchase order, in cents

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: 500000
    order_datestring | nullnullablerequired

    The order date for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: 2024-01-15T00:00:00.000Z
    expense_typestring | nullnullablerequired

    The expense type of the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: Capital
    display_typestring | nullnullablerequired

    The display type of the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: Standard
    status_rawstring | nullnullablerequired

    The raw status associated with the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: Completed
    shipping_address_1string | nullnullablerequired

    The first address line associated with the shipping address for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: 456 Oak Ave
    shipping_address_2string | nullnullablerequired

    The second address line associated with the shipping address for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: Building B
    shipping_citystring | nullnullablerequired

    The city associated with the shipping address for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: Chicago
    shipping_statestring | nullnullablerequired

    The state associated with the shipping address for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: IL
    shipping_zipstring | nullnullablerequired

    The zip code associated with the shipping address for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: 60601
    shipping_countrystring | nullnullablerequired

    The country associated with the shipping address for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: US
    billing_address_1string | nullnullablerequired

    The first address line associated with the billing address for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: 123 Main St
    billing_address_2string | nullnullablerequired

    The second address line associated with the billing address for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: Suite 100
    billing_citystring | nullnullablerequired

    The city associated with the billing address for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: Chicago
    billing_statestring | nullnullablerequired

    The state associated with the billing address for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: IL
    billing_zipstring | nullnullablerequired

    The zip code associated with the billing address for the purchase order

    InterfaceMethod
    Job Cost/ItfJobCost/GetPOChangeOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPOChangeOrders
    Job Cost/ItfJobCost/GetPurchaseOrders
    Vendor Invoicing/ItfVendorInvoicing/GetPurchaseOrders
    Example: 60601
    billing_countrystring | nullnullablerequired

    The country associated with the billing address for the purchase order

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

    An array of all other invoices associated with a purchase order. This includes invoices that associated with specific purchase order items.

    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
    invoice_idnullrequired

    The Propexo unique identifier for the invoice

    Notice

    This field will always be null for YARDI_REST

    Example: null
    vendor_idstring | nullnullablerequired

    The Propexo unique identifier for the vendor

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

    The Propexo unique identifier for the purchase order. This field is not null if this is a change order

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

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
curl https://api.propexo.com/v1/purchase-orders/:purchase_order_id \
     -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": "CO-2024-001",
    "x_property_id": "na",
    "x_location_id": null,
    "x_invoice_id": null,
    "x_vendor_id": "VENDOR001",
    "x_parent_purchase_order_id": "PO-2024-001",
    "number": "CO-2024-001",
    "is_closed": true,
    "description": "Construction materials",
    "total_amount_in_cents": 500000,
    "order_date": "2024-01-15T00:00:00.000Z",
    "expense_type": "Capital",
    "display_type": "Standard",
    "status_raw": "Completed",
    "shipping_address_1": "456 Oak Ave",
    "shipping_address_2": "Building B",
    "shipping_city": "Chicago",
    "shipping_state": "IL",
    "shipping_zip": "60601",
    "shipping_country": "US",
    "billing_address_1": "123 Main St",
    "billing_address_2": "Suite 100",
    "billing_city": "Chicago",
    "billing_state": "IL",
    "billing_zip": "60601",
    "billing_country": "US",
    "custom_data": "Unknown Type: object,null",
    "associated_invoice_ids": [
      "string"
    ],
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "YARDI_REST",
    "invoice_id": null,
    "vendor_id": "cjld2cjxh0000qzrmn831i7rn",
    "parent_purchase_order_id": "cjld2cjxh0000qzrmn831i7rn"
  }
}