List Purchase Orders

GET 
https://secure.fleetio.com/api/v1/purchase_orders

Returns a list of Purchase Orders belonging to your account.

Request

Responses

200

OK

Response Headers

X-PaginationLimit

The per page limit. Currently set to 100 but subject to change at any time.

X-Pagination-Current-Page

The current page. Defaults to 1.

X-Pagination-Total-Pages

The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

X-Pagination-Total-Count

The total number of records in the result set (across all pages).

application/json

Schema

Schema

Array [
idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
numberPurchaseOrderNumber (integer)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.
Example: 1207
descriptionstringnullablerequired
Open text field for Purchase Order description.
label_liststring[]required
A list of tags associated with this record.
Possible values: <= 255 characters
statePurchaseOrderState (string)nullablerequired
See the Purchase Order Lifecycle Guide for more information about Purchase Order states and how to transition between them.
Possible values: [draft, submitted_for_approval, rejected, approved, purchased, received_partial, received_full, closed]
created_bystringnullable
The name of the Contact associated with the User who created this Purchase Order.
rejected_bystringnullable
The full name of the Contact that rejected the Purchase Order, if applicable.
submitted_for_approval_atdate-timenullablerequired
The date and time at which this Purchase Order was submitted for approval.
Example: 2023-03-14T13:46:27-06:00
submitted_for_approval_bystringnullable
The name of the Contact associated with the User who submitted this Purchase Order for approval.
rejected_atdate-timenullablerequired
The date and time at which this Purchase Order was rejected.
Example: 2023-03-14T13:46:27-06:00
approved_atdate-timenullablerequired
The date and time at which this Purchase Order was approved.
Example: 2023-03-14T13:46:27-06:00
approved_bystringnullable
The name of the Contact associated with the User who approved this Purchase Order.
purchased_atdate-timenullablerequired
The date and time at which this Purchase Order was purchased.
Example: 2023-03-14T13:46:27-06:00
purchased_bystringnullable
The name of the Contact associated with the User who purchased this Purchase Order.
received_partial_atdate-timenullablerequired
The date and time at which this Purchase Order was partially received.
Example: 2023-03-14T13:46:27-06:00
received_partial_bystringnullable
The name of the Contact associated with the User who received this Purchase Order.
received_full_atdate-timenullablerequired
The date and time at which this Purchase Order was fully received.
Example: 2023-03-14T13:46:27-06:00
received_full_bystringnullable
The name of the Contact associated with the User who received this Purchase Order.
closed_atdate-timenullablerequired
The date and time at which this Purchase Order was closed.
Example: 2023-03-14T13:46:27-06:00
closed_bystringnullable
The name of the Contact associated with the User who closed this Purchase Order.
custom_fieldsobjectnullablerequired
*Full details on working with Custom Fields here.
part_location_idintegernullablerequired
The ID of the Part Location associated with this Purchase Order. Optional in the draft state.
Possible values: >= 1
vendor_idintegernullablerequired
The ID of the Vendor associated with this Purchase Order.
Possible values: >= 1
part_location_namestringnullable
The name of the Part Location associated with this Purchase Order.
vendor_namestringnullable
The name of the Vendor associated with this Purchase Order.
purchase_order_line_items object[]required
Array [
idinteger
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
part_idintegerrequired
The Fleetio ID of the Part being purchased.
Possible values: >= 1
quantitystringnullablerequired
The quantity of this Part to be purchased.
Example: 1.23
total_quantity_receivedstringnullablerequired
The quantity of this Part which was received.
Example: 1.23
part_numberstringnullable
The number for the Part being purchased.
unit_costfloatnullablerequired
The cost of this Part (per unit).
Example: 1.23
subtotalfloatnullable
The pre-tax subtotal amount.
Example: 1.23
]
documents_countintegernullablerequired
The number of documents attached to this Purchase Order.
comments_countintegernullablerequired
The number of Comments on this Purchase Order.
shippingfloatnullable
The shipping cost of this purchase.
discountfloatnullable
The discount amount applied to this purchase.
discount_typestringnullable
The discount type applied to this purchase.
discount_percentagefloatnullable
The discount percentage applied to this purchase.
tax_1floatnullable
The primary tax amount on this purchase
tax_1_typestringnullable
The primary tax type on this purchase
tax_2floatnullable
The secondary tax amount on this purchase. Note that this secondary tax must be configured in your Account Settings.
subtotalfloatnullable
The subtotal of this purchase.
total_amountfloatnullable
The total amount of this Purchase Order, including all line items, discounts, taxes, and shipping.
]

Example (auto)

[
  {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "number": 1207,
    "description": "string",
    "label_list": [
      "High Priority"
    ],
    "state": "draft",
    "created_by": "string",
    "rejected_by": "string",
    "submitted_for_approval_at": "2023-03-14T13:46:27-06:00",
    "submitted_for_approval_by": "string",
    "rejected_at": "2023-03-14T13:46:27-06:00",
    "approved_at": "2023-03-14T13:46:27-06:00",
    "approved_by": "string",
    "purchased_at": "2023-03-14T13:46:27-06:00",
    "purchased_by": "string",
    "received_partial_at": "2023-03-14T13:46:27-06:00",
    "received_partial_by": "string",
    "received_full_at": "2023-03-14T13:46:27-06:00",
    "received_full_by": "string",
    "closed_at": "2023-03-14T13:46:27-06:00",
    "closed_by": "string",
    "custom_fields": {},
    "part_location_id": 0,
    "vendor_id": 0,
    "part_location_name": "string",
    "vendor_name": "string",
    "purchase_order_line_items": [
      {
        "id": 0,
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "part_id": 0,
        "quantity": "1.23",
        "total_quantity_received": "1.23",
        "part_number": "string",
        "unit_cost": 1.23,
        "subtotal": 1.23
      }
    ],
    "documents_count": 0,
    "comments_count": 0,
    "shipping": 0,
    "discount": 0,
    "discount_type": "string",
    "discount_percentage": 0,
    "tax_1": 0,
    "tax_1_type": "string",
    "tax_2": 0,
    "subtotal": 0,
    "total_amount": 0
  }
]

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

ResponseClear

Click the Send API Request button above and see the response here!