Get purchase order by ID

GET

/v1/purchase-orders/:purchase_order_id

Path parameters

purchase_order_idstringRequired

The Propexo unique identifier for the purchase order

Query parameters

order-bystringOptional

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

offsetintegerOptional

Can be used for paginating results

limitintegerOptional

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

Response

Successful response

metaobject

resultsobject

Errors

GET

1 curl https://api.propexo.com/v1/purchase-orders/purchase_order_id \
2      -H "Authorization: Bearer <token>"

1 {
2   "meta": {
3     "orderBy": [
4       {}
5     ],
6     "offset": 0,
7     "limit": 100,
8     "hasMore": true,
9     "total": 1000
10   },
11   "results": {
12     "id": "id",
13     "created_at": "created_at",
14     "updated_at": "updated_at",
15     "x_id": "x_id",
16     "x_property_id": "x_property_id",
17     "associated_invoice_ids": [
18       "associated_invoice_ids"
19     ],
20     "property_id": "property_id",
21     "integration_id": "integration_id",
22     "integration_vendor": "SAMPLE2",
23     "last_seen": "last_seen",
24     "x_location_id": "x_location_id",
25     "x_invoice_id": "x_invoice_id",
26     "x_parent_purchase_order_id": "x_parent_purchase_order_id",
27     "number": "number",
28     "is_closed": true,
29     "description": "description",
30     "total_amount_in_cents": 1.1,
31     "order_date": "order_date",
32     "expense_type": "expense_type",
33     "display_type": "display_type",
34     "shipping_address_1": "shipping_address_1",
35     "shipping_address_2": "shipping_address_2",
36     "shipping_city": "shipping_city",
37     "shipping_state": "shipping_state",
38     "shipping_zip": "shipping_zip",
39     "shipping_country": "shipping_country",
40     "billing_address_1": "billing_address_1",
41     "billing_address_2": "billing_address_2",
42     "billing_city": "billing_city",
43     "billing_state": "billing_state",
44     "billing_zip": "billing_zip",
45     "billing_country": "billing_country",
46     "invoice_id": "invoice_id",
47     "parent_purchase_order_id": "parent_purchase_order_id"
48   }
49 }

Update a purchase order

Up Next

Built with

1	curl https://api.propexo.com/v1/purchase-orders/purchase_order_id \
2	-H "Authorization: Bearer <token>"

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 0,
7	"limit": 100,
8	"hasMore": true,
9	"total": 1000
10	},
11	"results": {
12	"id": "id",
13	"created_at": "created_at",
14	"updated_at": "updated_at",
15	"x_id": "x_id",
16	"x_property_id": "x_property_id",
17	"associated_invoice_ids": [
18	"associated_invoice_ids"
19	],
20	"property_id": "property_id",
21	"integration_id": "integration_id",
22	"integration_vendor": "SAMPLE2",
23	"last_seen": "last_seen",
24	"x_location_id": "x_location_id",
25	"x_invoice_id": "x_invoice_id",
26	"x_parent_purchase_order_id": "x_parent_purchase_order_id",
27	"number": "number",
28	"is_closed": true,
29	"description": "description",
30	"total_amount_in_cents": 1.1,
31	"order_date": "order_date",
32	"expense_type": "expense_type",
33	"display_type": "display_type",
34	"shipping_address_1": "shipping_address_1",
35	"shipping_address_2": "shipping_address_2",
36	"shipping_city": "shipping_city",
37	"shipping_state": "shipping_state",
38	"shipping_zip": "shipping_zip",
39	"shipping_country": "shipping_country",
40	"billing_address_1": "billing_address_1",
41	"billing_address_2": "billing_address_2",
42	"billing_city": "billing_city",
43	"billing_state": "billing_state",
44	"billing_zip": "billing_zip",
45	"billing_country": "billing_country",
46	"invoice_id": "invoice_id",
47	"parent_purchase_order_id": "parent_purchase_order_id"
48	}
49	}