Skip to main content

Retrieve Purchase Order

Retrieve the details of an existing Purchase Order.

Path Parameters

  • number string required

    Possible values: Value must match regular expression ^[0-9]+$

    The Purchase Order Number

Responses

OK

Schema

  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

    The date and time at which this record was most recently updated.

  • number integer

    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.

  • description string

    Open text field for Purchase Order description.

  • label_list string[]

    Possible values: <= 255 characters

    A list of tags associated with this record.

  • state string

    Possible values: [draft, submitted_for_approval, rejected, approved, purchased, received_partial, received_full, closed]

    See the Purchase Order Lifecycle Guide for more information about Purchase Order states and how to transition between them.

  • created_by string

    The name of the Contact associated with the User who created this Purchase Order.

  • rejected_by string

    The full name of the Contact that rejected the Purchase Order, if applicable.

  • submitted_for_approval_at date-time

    The date and time at which this Purchase Order was submitted for approval.

  • submitted_for_approval_by string

    The name of the Contact associated with the User who submitted this Purchase Order for approval.

  • rejected_at date-time

    The date and time at which this Purchase Order was rejected.

  • approved_at date-time

    The date and time at which this Purchase Order was approved.

  • approved_by string

    The name of the Contact associated with the User who approved this Purchase Order.

  • purchased_at date-time

    The date and time at which this Purchase Order was purchased.

  • purchased_by string

    The name of the Contact associated with the User who purchased this Purchase Order.

  • received_partial_at date-time

    The date and time at which this Purchase Order was partially received.

  • received_partial_by string

    The name of the Contact associated with the User who received this Purchase Order.

  • received_full_at date-time

    The date and time at which this Purchase Order was fully received.

  • received_full_by string

    The name of the Contact associated with the User who received this Purchase Order.

  • closed_at date-time

    The date and time at which this Purchase Order was closed.

  • closed_by string

    The name of the Contact associated with the User who closed this Purchase Order.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • part_location_id integer

    Possible values: >= 1

    The ID of the Part Location associated with this Purchase Order. Optional in the draft state.

  • vendor_id integer

    Possible values: >= 1

    The ID of the Vendor associated with this Purchase Order.

  • part_location_name string

    The name of the Part Location associated with this Purchase Order.

  • vendor_name string

    The name of the Vendor associated with this Purchase Order.

  • purchase_order_line_items object[]
  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

    The date and time at which this record was most recently updated.

  • part_id integer

    Possible values: >= 1

    The Fleetio ID of the Part being purchased.

  • quantity string

    The quantity of this Part to be purchased.

  • total_quantity_received string

    The quantity of this Part which was received.

  • part_number string

    The number for the Part being purchased.

  • unit_cost float

    The cost of this Part (per unit).

  • subtotal float

    The pre-tax subtotal amount.

  • documents_count integer

    The number of documents attached to this Purchase Order.

  • comments_count integer

    The number of Comments on this Purchase Order.

  • shipping float

    The shipping cost of this purchase.

  • discount float

    The discount amount applied to this purchase.

  • discount_type string

    The discount type applied to this purchase.

  • discount_percentage float

    The discount percentage applied to this purchase.

  • tax_1 float

    The primary tax amount on this purchase

  • tax_1_type string

    The primary tax type on this purchase

  • tax_2 float

    The secondary tax amount on this purchase. Note that this secondary tax must be configured in your Account Settings.

  • subtotal float

    The subtotal of this purchase.

  • total_amount float

    The total amount of this Purchase Order, including all line items, discounts, taxes, and shipping.

Loading...