List Purchase Orders

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

Returns a list of Purchase Orders belonging to your account.

Request

Query Parameters

start_cursor string

The start cursor for Keyset pagination.

per_page integer
Possible values: >= 2 and <= 100
The number of records per page to return.
Default value: 50
filter object
The fields, operations, and values to filter the records by.
number object
eqstringrequired
part_location_id object
eqstringrequired
rejected_by_id object
eqstringrequired
submitted_for_approval_by_id object
eqstringrequired
purchased_by_id object
eqstringrequired
created_by_id object
eqstringrequired
approved_by_id object
eqstringrequired
vendor_id object
eqstringrequired
state object
includestringrequired
labels object
includestringrequired
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
sort object

The fields and direction to sort the results by.

idSortAscDescDefaultDesc (string)

Possible values: [asc, desc]

Default value: desc

created_atSortAscDesc (string)

Possible values: [asc, desc]

updated_atSortAscDesc (string)

Possible values: [asc, desc]

Responses

200

OK

application/json

Schema

Schema

start_cursorstringnullable
The current start cursor of the records returned.
next_cursorstringnullable
The next cursor to retrieve the next page of records.
per_pageinteger
The maxumum number of records returned.
estimated_remaining_countinteger
The number of remaining records including the returned records, up to a maximum of 500.
filtered_by object[]
The filters applied to the returned record set.
Array [
anyOf
MOD1
number object
eqstringrequired
MOD2
part_location_id object
eqstringrequired
MOD3
rejected_by_id object
eqstringrequired
MOD4
submitted_for_approval_by_id object
eqstringrequired
MOD5
purchased_by_id object
eqstringrequired
MOD6
created_by_id object
eqstringrequired
MOD7
approved_by_id object
eqstringrequired
MOD8
vendor_id object
eqstringrequired
MOD9
state object
includestringrequired
MOD10
labels object
includestringrequired
MOD11
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD12
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
]
sorted_by object[]
The sorts applied to the returned record set.
Array [
anyOf
MOD1
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD2
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idintegerrequired
numberintegerrequired
The Purchase Order Number.
descriptionstringnullablerequired
Open text field for Purchase Order description.
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]
documents_countintegerrequired
comments_countintegerrequired
watchers_countintegerrequired
discount_typestringnullablerequired
The discount type applied to this purchase.
tax_1_typestringnullablerequired
The primary tax type on this purchase
tax_2_typestringnullablerequired
The secondary tax type on this purchase
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
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
purchased_atdate-timenullablerequired
The date and time at which this Purchase Order was purchased.
Example: 2023-03-14T13:46:27-06:00
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_full_atdate-timenullablerequired
The date and time at which this Purchase Order was fully received.
Example: 2023-03-14T13:46:27-06:00
closed_atdate-timenullablerequired
The date and time at which this Purchase Order was closed.
Example: 2023-03-14T13:46:27-06:00
created_atdate-timenullablerequired
The date and time at which this Purchase Order was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-timenullablerequired
The date and time at which this Purchase Order was last updated.
Example: 2023-03-14T13:46:27-06:00
discount_centsintegernullablerequired
The amount fo the discount on this Purchase Order in cents.
tax_1_centsintegernullablerequired
The amount of the primary tax on this Purchase Order in cents.
tax_1_percentagestringnullablerequired
The percentage for the primary tax.
tax_2_centsintegernullablerequired
The amount of the secondary tax on this Purchase Order in cents.
tax_2_percentagestringnullablerequired
The percentage for the secondary tax.
subtotal_centsintegernullablerequired
The subtotal for this Purchase Order in cents.
shipping_centsintegernullablerequired
The shipping amount for this Purchase Order in cents.
total_amount_centsintegernullablerequired
The total amount for this Purchase Order in cents.
vendor_idintegernullablerequired
The ID of the Vendor for this Purchase Order.
approved_by_idintegernullablerequired
The ID of the User who has approved this Purchase Order.
created_by_idintegernullablerequired
The ID of the User who created this Purchase Order.
closed_by_idintegernullablerequired
The ID of the User who has closed this Purchase Order.
purchased_by_idintegernullablerequired
The ID of the User who has purchased this Purchase Order.
rejected_by_idintegernullablerequired
The ID of the User who has rejected this Purchase Order.
received_partial_by_idintegernullablerequired
The ID of the User who has partially received this Purchase Order.
received_full_by_idintegernullablerequired
The ID of the User who has received this Purchase Order in full.
submitted_for_approval_by_idintegernullablerequired
The ID of the User who has submitted this Purchase Order for approval.
purchase_order_status_idintegernullablerequired
The ID of the PurchaseOrderStatus associated with this Purchase Order.
part_location_idintegernullablerequired
The ID of the PartLocation associated with this Purchase Order.
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
labels object[]required
Array [
idId (integer)
Possible values: >= 1
namestring
]
vendor objectnullablerequired
A Vendor
namestringrequired
The name of the Vendor.
phonestringnullablerequired
The phone number of the Vendor.
citystringnullablerequired
The city of the Vendor.
regionstringnullablerequired
The region, state, province, or territory of the Vendor.
postal_codestringnullablerequired
The postal code or ZIP code of the Vendor.
countrystringnullablerequired
The country of the Vendor.
external_idstringnullablerequired
The external identifier of the Vendor.
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "number": {
        "eq": "string"
      }
    },
    {
      "part_location_id": {
        "eq": "string"
      }
    },
    {
      "rejected_by_id": {
        "eq": "string"
      }
    },
    {
      "submitted_for_approval_by_id": {
        "eq": "string"
      }
    },
    {
      "purchased_by_id": {
        "eq": "string"
      }
    },
    {
      "created_by_id": {
        "eq": "string"
      }
    },
    {
      "approved_by_id": {
        "eq": "string"
      }
    },
    {
      "vendor_id": {
        "eq": "string"
      }
    },
    {
      "state": {
        "include": "string"
      }
    },
    {
      "labels": {
        "include": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "updated_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "number": 0,
      "description": "string",
      "state": "draft",
      "documents_count": 0,
      "comments_count": 0,
      "watchers_count": 0,
      "discount_type": "string",
      "tax_1_type": "string",
      "tax_2_type": "string",
      "submitted_for_approval_at": "2023-03-14T13:46:27-06:00",
      "rejected_at": "2023-03-14T13:46:27-06:00",
      "approved_at": "2023-03-14T13:46:27-06:00",
      "purchased_at": "2023-03-14T13:46:27-06:00",
      "received_partial_at": "2023-03-14T13:46:27-06:00",
      "received_full_at": "2023-03-14T13:46:27-06:00",
      "closed_at": "2023-03-14T13:46:27-06:00",
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "discount_cents": 0,
      "tax_1_cents": 0,
      "tax_1_percentage": "string",
      "tax_2_cents": 0,
      "tax_2_percentage": "string",
      "subtotal_cents": 0,
      "shipping_cents": 0,
      "total_amount_cents": 0,
      "vendor_id": 0,
      "approved_by_id": 0,
      "created_by_id": 0,
      "closed_by_id": 0,
      "purchased_by_id": 0,
      "rejected_by_id": 0,
      "received_partial_by_id": 0,
      "received_full_by_id": 0,
      "submitted_for_approval_by_id": 0,
      "purchase_order_status_id": 0,
      "part_location_id": 0,
      "custom_fields": {},
      "labels": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "vendor": {
        "name": "string",
        "phone": "string",
        "city": "string",
        "region": "string",
        "postal_code": "string",
        "country": "string",
        "external_id": "string"
      }
    }
  ]
}

400

The format or parameters of the request was invalid

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

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

curl -L 'https://secure.fleetio.com/api/v1/purchase_orders' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

start_cursor — query

per_page — query

filter — query

numbereq

part_location_ideq

rejected_by_ideq

submitted_for_approval_by_ideq

purchased_by_ideq

created_by_ideq

approved_by_ideq

vendor_ideq

stateinclude

labelsinclude

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

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