API ReferencePurchase Orders

Create a purchase order

Create a purchase order for an integration.

Headers

AuthorizationstringRequired

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_datedatetime or stringOptional
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
The number of the purchase order
total_amount_in_centsdoubleOptional
The amount of the purchase order, in cents
order_datedatetime or stringOptional
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_state"AA" or "AE" or "AK" or "AL" or "AP" or "AR" or "AS" or "AZ" or "CA" or "CO" or "CT" or "DC" or "DE" or "FL" or "FM" or "GA" or "GU" or "HI" or "IA" or "ID" or "IN" or "KS" or "KY" or "LA" or "MA" or "MD" or "ME" or "MH" or "MI" or "MN" or "MO" or "MP" or "MS" or "MT" or "NC" or "NE" or "NL" or "NJ" or "NM" or "NV" or "NY" or "OH" or "OK" or "OR" or "PA" or "PR" or "SD" or "TN" or "TX" or "UT" or "VA" or "VI" or "VT" or "WA" or "WI" or "WV" or "WY" or "AB" or "BC" or "MB" or "NB" or "NT" or "NS" or "NU" or "ON" or "PE" or "QC" or "SK" or "YT" 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_state"AA" or "AE" or "AK" or "AL" or "AP" or "AR" or "AS" or "AZ" or "CA" or "CO" or "CT" or "DC" or "DE" or "FL" or "FM" or "GA" or "GU" or "HI" or "IA" or "ID" or "IN" or "KS" or "KY" or "LA" or "MA" or "MD" or "ME" or "MH" or "MI" or "MN" or "MO" or "MP" or "MS" or "MT" or "NC" or "NE" or "NL" or "NJ" or "NM" or "NV" or "NY" or "OH" or "OK" or "OR" or "PA" or "PR" or "SD" or "TN" or "TX" or "UT" or "VA" or "VI" or "VT" or "WA" or "WI" or "WV" or "WY" or "AB" or "BC" or "MB" or "NB" or "NT" or "NS" or "NU" or "ON" or "PE" or "QC" or "SK" or "YT" 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