created_atstring date-time
The date and time at which this record was created.
updated_atstring date-time
The date and time at which this record was most recently updated.
numberinteger required
Must be unique within the scope of your Account. You can either generate
your own number or leave it blank and Fleetio will generate one for you.
Fleetio will use the next number in the sequence based on your existing
Purchase Orders. This becomes the unique identifier, even in endpoints.
Id is never used.
descriptionstring nullable required
Open text field for Purchase Order description.
label_liststring[] required
A list of tags associated with this record.
state'draft' | 'submitted_for_approval' | 'rejected' | 'approved' | 'purchased' | 'received_partial' | 'received_full' | 'closed' nullable required
See the Purchase Order Lifecycle
Guide for more information about
Purchase Order states and how to transition between them.
created_bystring nullable
The name of the Contact associated with the User who
created this Purchase Order.
rejected_bystring nullable
The full name of the Contact that rejected the Purchase Order, if applicable.
submitted_for_approval_atstring date-time nullable required
The date and time at which this Purchase Order was submitted for approval.
submitted_for_approval_bystring nullable
The name of the Contact associated with the User who
submitted this Purchase Order for approval.
rejected_atstring date-time nullable required
The date and time at which this Purchase Order was rejected.
approved_atstring date-time nullable required
The date and time at which this Purchase Order was approved.
approved_bystring nullable
The name of the Contact associated with the User who
approved this Purchase Order.
purchased_atstring date-time nullable required
The date and time at which this Purchase Order was purchased.
purchased_bystring nullable
The name of the Contact associated with the User who
purchased this Purchase Order.
received_partial_atstring date-time nullable required
The date and time at which this Purchase Order was partially received.
received_partial_bystring nullable
The name of the Contact associated with the User who
received this Purchase Order.
received_full_atstring date-time nullable required
The date and time at which this Purchase Order was fully received.
received_full_bystring nullable
The name of the Contact associated with the User who
received this Purchase Order.
closed_atstring date-time nullable required
The date and time at which this Purchase Order was closed.
closed_bystring nullable
The name of the Contact associated with the User who
closed this Purchase Order.
custom_fieldsCustomFields nullable required
*Full details on working with Custom Fields here.
part_location_idinteger nullable required
The ID of the Part Location associated with this Purchase Order. Optional
in the draft state.
vendor_idinteger nullable required
The ID of the Vendor associated with this Purchase
Order.
part_location_namestring nullable
The name of the Part Location associated with this Purchase Order.
vendor_namestring nullable
The name of the Vendor associated with this Purchase Order.
documents_countinteger nullable required
The number of documents attached to this record.
comments_countinteger nullable required
The number of Comments on this Purchase Order.
shippingnumber float nullable
The shipping cost of this purchase.
discountnumber float nullable
The discount amount applied to this purchase.
discount_typestring nullable
The discount type applied to this purchase.
discount_percentagenumber float nullable
The discount percentage applied to this purchase.
tax_1number float nullable
The primary tax amount on this purchase
tax_1_typestring nullable
The primary tax type on this purchase
tax_2number float nullable
The secondary tax amount on this purchase.
Note that this secondary tax must be configured in your
Account Settings.
subtotalnumber float nullable
The subtotal of this purchase.
total_amountnumber float nullable
The total amount of this Purchase Order, including all line items,
discounts, taxes, and shipping.