List Purchase Orders
Returns a list of Purchase Orders belonging to your account.
- 200
- 401
- 500
OK
Response Headers
X-PaginationLimit string
The per page limit. Currently set to 100 but subject to change at any time.
X-Pagination-Current-Page string
The current page. Defaults to 1.
X-Pagination-Total-Pages string
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 string
The total number of records in the result set (across all pages).
- application/json
- Schema
- Example (from schema)
Schema
array
- 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 int32
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.
- 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 thedraft
state. - 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 integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
subtotal object
The pre-tax subtotal amount.
anyOf- MOD1
- MOD2
number floatstringsubtotal_cents object
The pre-tax subtotal amount in cents.
anyOf- MOD1
- MOD2
integerstringpurchase_order_id integerPossible values:
>= 1
part_location_detail_id NullableIdPossible values:
>= 1
quantity object
The quantity of this
Part
to be purchased.anyOf- MOD1
- MOD2
stringnumber floattotal_quantity_received object
The quantity of this
Part
which was received.anyOf- MOD1
- MOD2
stringnumber floatpart_number stringThe number for the
Part
being purchased.unit_cost object
The cost of this
Part
(per unit).anyOf- MOD1
- MOD2
stringnumber float- 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.
anyOf- MOD1
- MOD2
number floatstring- discount_type DiscountType
Possible values: [
fixed
,percentage
]Default value:
percentage
The discount type applied to this purchase.
discount_percentage float
The discount percentage applied to this purchase.
anyOf- MOD1
- MOD2
number floatstringtax_1 float
The primary tax amount on this purchase
anyOf- MOD1
- MOD2
number floatstring- tax_1_type string
Possible values: [
fixed
,percentage
]Default value:
percentage
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.
anyOf- MOD1
- MOD2
number floatstringsubtotal float
The subtotal of this purchase.
anyOf- MOD1
- MOD2
number floatstring- total_amount float
The total amount of this Purchase Order, including all line items, discounts, taxes, and shipping.
discount_cents object
The discount amount in cents.
anyOf- MOD1
- MOD2
integerstringsubtotal_cents object
The pre-tax subtotal amount in cents.
anyOf- MOD1
- MOD2
integerstringtax_1_percentage object
The primary tax percentage amount. This field should be present when
tax_1_type
is set topercentage
.anyOf- MOD1
- MOD2
number floatstring- tax_1_cents integer
The primary tax amount in cents.
- tax_2_type string
Possible values: [
fixed
,percentage
]Default value:
percentage
The type of tax to apply to this record.
tax_2_percentage object
The secondary tax percentage amount. This field should be present when
tax_2_type
is set topercentage
. Note that this secondary tax must be configured in your Account Settings.anyOf- MOD1
- MOD2
number floatstringtax_2_cents object
The secondary tax amount in cents.
oneOf- MOD1
- MOD2
stringintegerThe secondary tax amount in cents.
[
{
"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",
"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",
"subtotal": 1.23,
"subtotal_cents": 1.23,
"purchase_order_id": 0,
"part_location_detail_id": 0,
"part_id": 0,
"quantity": "1.23",
"total_quantity_received": "1.23",
"part_number": "string",
"unit_cost": "1.23"
}
],
"documents_count": 0,
"comments_count": 0,
"shipping": 0,
"discount": 1.23,
"discount_type": "percentage",
"discount_percentage": 1.23,
"tax_1": 1.23,
"tax_1_type": "percentage",
"tax_2": 1.23,
"subtotal": 1.23,
"total_amount": 0,
"discount_cents": 1.23,
"subtotal_cents": 1.23,
"tax_1_percentage": 1.23,
"tax_1_cents": 123,
"tax_2_type": "percentage",
"tax_2_percentage": 1.23,
"tax_2_cents": "123"
}
]
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}