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

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: 20418

x_property_idstringrequired

The external ID of the property from the integration vendor

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	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

Example: null

x_invoice_idnullrequired

The external ID of the invoice from the integration vendor

Notice

This field will always be null for YARDI

Example: null

x_vendor_idstring | nullnullablerequired

The external ID of the vendor from the integration vendor

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: v10294

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

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders

Example: 19140

numberstring | nullnullablerequired

The number of the purchase order

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: 20418

is_closedboolean | nullnullablerequired

Whether the purchase order is closed or not

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

descriptionstring | nullnullablerequired

Description of the purchase order

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: Unit turnover supplies for building B

total_amount_in_centsnumber | nullnullablerequired

The amount of the purchase order, in cents

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: 482500

order_datestring | nullnullablerequired

The order date for the purchase order

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: 2024-05-20T00:00:00.000Z

expense_typestring | nullnullablerequired

The expense type of the purchase order

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: Repairs

display_typestring | nullnullablerequired

The display type of the purchase order

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: Standard

status_rawstring | nullnullablerequired

The raw status associated with the purchase order

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: Completed

shipping_address_1string | nullnullablerequired

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

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: 1842 Cedar Avenue

shipping_address_2string | nullnullablerequired

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

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: Building C

shipping_citystring | nullnullablerequired

The city associated with the shipping address for the purchase order

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: Oakland

shipping_statestring | nullnullablerequired

The state associated with the shipping address for the purchase order

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: CA

shipping_zipstring | nullnullablerequired

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

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: 94612

shipping_countrystring | nullnullablerequired

The country associated with the shipping address for the purchase order

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: United States

billing_address_1string | nullnullablerequired

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

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: 500 Market Street

billing_address_2string | nullnullablerequired

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

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: Suite 1200

billing_citystring | nullnullablerequired

The city associated with the billing address for the purchase order

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: San Francisco

billing_statestring | nullnullablerequired

The state associated with the billing address for the purchase order

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: CA

billing_zipstring | nullnullablerequired

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

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: 94105

billing_countrystring | nullnullablerequired

The country associated with the billing address for the purchase order

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: United States

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

property_idstringrequired

The Propexo unique identifier for the property

Example: clwi5xiix000008l6ctdgafyh

integration_idstringrequired

The Propexo unique identifier for the integration

Example: clwh5u07w000508me66sfh3um

integration_vendorEnum24required

The property management system of record

Show 13 enum values

YARDIAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDI_REST

Example: YARDI

invoice_idnullrequired

The Propexo unique identifier for the invoice

Notice

This field will always be null for YARDI

Example: null

vendor_idstring | nullnullablerequired

The Propexo unique identifier for the vendor

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders
Job Cost	GetPurchaseOrders
Vendor Invoicing	GetPurchaseOrders

Example: cmfcvfgli748737487413g1beb1709zj0

parent_purchase_order_idstring | nullnullablerequired

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

Interface	Method
Job Cost	GetPOChangeOrders
Vendor Invoicing	GetPOChangeOrders

Example: cl8k2nqwe0017jsxq9ab1c2du

Errors

400Bad Request

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": "20418",
    "x_property_id": "na",
    "x_location_id": null,
    "x_invoice_id": null,
    "x_vendor_id": "v10294",
    "x_parent_purchase_order_id": "19140",
    "number": "20418",
    "is_closed": true,
    "description": "Unit turnover supplies for building B",
    "total_amount_in_cents": 482500,
    "order_date": "2024-05-20T00:00:00.000Z",
    "expense_type": "Repairs",
    "display_type": "Standard",
    "status_raw": "Completed",
    "shipping_address_1": "1842 Cedar Avenue",
    "shipping_address_2": "Building C",
    "shipping_city": "Oakland",
    "shipping_state": "CA",
    "shipping_zip": "94612",
    "shipping_country": "United States",
    "billing_address_1": "500 Market Street",
    "billing_address_2": "Suite 1200",
    "billing_city": "San Francisco",
    "billing_state": "CA",
    "billing_zip": "94105",
    "billing_country": "United States",
    "custom_data": "Unknown Type: object,null",
    "associated_invoice_ids": [
      "string"
    ],
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "YARDI",
    "invoice_id": null,
    "vendor_id": "cmfcvfgli748737487413g1beb1709zj0",
    "parent_purchase_order_id": "cl8k2nqwe0017jsxq9ab1c2du"
  }
}

Get purchase order by ID

Authentication​

Path parameters​

Query parameters​

Response​

Errors​

Authentication

Path parameters

Query parameters

Response

Errors