PMS Generic APIsPurchase Orders

Create a purchase order

Create a purchase order for an integration.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
integration_idstringRequired
vendor_idstringOptional
The Propexo unique identifier for the vendor
vendor_location_idstringOptional
The Propexo unique identifier for the vendor location
property_idstringOptional
The Propexo unique identifier for the property
ap_financial_account_idstringOptional
The Propexo unique identifier for the financial account. You'll likely want to work with your customer to know what value is appropriate here.
post_datestringOptional
The post date for the purchase order
descriptionstringOptional
Description of the purchase order
shipping_amount_in_centsintegerOptional
The cost of shipping, in cents, of the purchase order
discount_amount_in_centsintegerOptional
The discount, in cents, of the purchase order
purchase_order_itemslist of objectsOptional
A list of the items associated with the purchase orders
numberstringOptional<=8 characters
The number of the purchase order
total_amount_in_centsdoubleOptional
The amount of the purchase order, in cents
order_datestringOptional
The order date for the purchase order
expense_typestringOptional
The expense type of the purchase order. You'll have to request this data from your customer
display_typestringOptional
The display type of the purchase order. You'll have to request this data from your customer
shipping_address_1stringOptional
The first address line associated with the shipping address for the purchase order
shipping_address_2stringOptional
The second address line associated with the shipping address for the purchase order
shipping_citystringOptional
The city associated with the shipping address for the purchase order
shipping_stateenum or stringOptional
The state associated with the shipping address for the purchase order. This must be a state abbreviation
shipping_zipstringOptional
The zip code associated with the shipping address for the purchase order
shipping_countrystringOptional
The country associated with the shipping address for the purchase order
billing_address_1stringOptional
The first address line associated with the billing address for the purchase order
billing_address_2stringOptional
The second address line associated with the billing address for the purchase order
billing_citystringOptional
The city associated with the billing address for the purchase order
billing_stateenum or stringOptional
The state associated with the billing address for the purchase order. This must be a state abbreviation
billing_zipstringOptional
The zip code associated with the billing address for the purchase order
billing_countrystringOptional
The country associated with the billing address for the purchase order

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors