List Inventory Journal Entries

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

Returns a list of Inventory Journal Entries 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.
adjustment_type object
includestringrequired
user_id object
eqstringrequired
part_id object
eqstringrequired
part_location_detail_id object
eqstringrequired
transfer_part_location_id object
eqstringrequired
inventory_adjustment_reason_id object
eqstringrequired
purchase_order_line_item_id object
eqstringrequired
work_order_id object
eqstringrequired
vendor_id object
eqstringrequired
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
adjustment_type object
includestringrequired
MOD2
user_id object
eqstringrequired
MOD3
part_id object
eqstringrequired
MOD4
part_location_detail_id object
eqstringrequired
MOD5
transfer_part_location_id object
eqstringrequired
MOD6
inventory_adjustment_reason_id object
eqstringrequired
MOD7
purchase_order_line_item_id object
eqstringrequired
MOD8
work_order_id object
eqstringrequired
MOD9
vendor_id object
eqstringrequired
MOD10
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD11
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 Inventory Journal Entry[]
Array [
idinteger
account_idintegerrequired
user_idintegerrequired
The ID of the User associated with the entry.
part_idintegerrequired
The ID of the Part associated with the entry.
part_location_detail_idintegerrequired
The ID of the details of this Part at a specific Part Location. Not the same as part_location_id.
part_location objectrequired
Information about the associated Part Location.
namestring
idinteger
previous_quantitystringrequired
The previous quantity of the Part before any adjustments.
current_quantitystringrequired
The current quantity of the Part after adjustments.
adjustment_quantitystringrequired
The quantity adjustment made to the Part's count.
work_order_part_line_item_idintegernullablerequired
The ID of the Work Order Part Line Item associated with the entry. Only applicable if the entry is associated with a Work Order.
inventory_adjustment_reason_idintegernullablerequired
The ID of the Inventory Adjustment Reason associated with the entry.
inventory_adjustment_reason objectnullablerequired
namestring
The Inventory Adjustment Reason name associated with the entry.
comments_countintegerrequired
How many Comments this entry has.
adjustment_typestringrequired
The type of adjustment that triggered the entry.
Possible values: [initial, manual, work_order, purchase_order, bulk_update, transfer]
transfer_part_location_idintegernullablerequired
The ID of the Part Location that the Part was transferred to. Only applicable if the entry is associated with a transfer.
purchase_order_line_item_idintegernullablerequired
The ID of the ``Purchase Order Line Itemassociated with the entry. Only applicable if the entry is associated with aPurchase Order`.
work_order_idintegernullablerequired
The ID of the Work Order associated with the entry. Only applicable if the entry is associated with a Work Order.
vendor_idintegernullablerequired
The ID of the Vendor associated with the entry. Only applicable if the entry is associated with a Purchase Order.
user objectrequired
Information about the User that created the entry.
emailstring
part Partrequired
A Part
idinteger
descriptionstringnullable
A description of this Part.
manufacturer_part_numberstringnullable
The part number from this Part's manufacturer.
measurement_unit_idintegernullable
The id of the MeasurementUnit associated with this Part.
numberstring
The part number being used for this Part within Fleetio.
part_category_idintegernullable
The id of the PartCategory associated with this Part.
part_manufacturer_idintegernullable
The id of the PartManufacturer associated with this Part.
upcstringnullable
The Universal Product Code for this Part.
average_unit_cost_centsintegernullable
The average unit cost in cents for this Part. FIFO/LIFO accounts only.
unit_cost_centsintegernullable
The unit cost in cents for this Part.
archived_atdate-timenullable
The date and time at which this Part was archived.
Example: 2023-03-14T13:46:27-06:00
created_atdate-time
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
Example: 2023-03-14T13:46:27-06:00
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "adjustment_type": {
        "include": "string"
      }
    },
    {
      "user_id": {
        "eq": "string"
      }
    },
    {
      "part_id": {
        "eq": "string"
      }
    },
    {
      "part_location_detail_id": {
        "eq": "string"
      }
    },
    {
      "transfer_part_location_id": {
        "eq": "string"
      }
    },
    {
      "inventory_adjustment_reason_id": {
        "eq": "string"
      }
    },
    {
      "purchase_order_line_item_id": {
        "eq": "string"
      }
    },
    {
      "work_order_id": {
        "eq": "string"
      }
    },
    {
      "vendor_id": {
        "eq": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "updated_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "account_id": 0,
      "user_id": 0,
      "part_id": 0,
      "part_location_detail_id": 0,
      "part_location": {
        "name": "string",
        "id": 0
      },
      "previous_quantity": "string",
      "current_quantity": "string",
      "adjustment_quantity": "string",
      "work_order_part_line_item_id": 0,
      "inventory_adjustment_reason_id": 0,
      "inventory_adjustment_reason": {
        "name": "string"
      },
      "comments_count": 0,
      "adjustment_type": "initial",
      "transfer_part_location_id": 0,
      "purchase_order_line_item_id": 0,
      "work_order_id": 0,
      "vendor_id": 0,
      "user": {
        "email": "string"
      },
      "part": {
        "id": 0,
        "description": "string",
        "manufacturer_part_number": "string",
        "measurement_unit_id": 0,
        "number": "string",
        "part_category_id": 0,
        "part_manufacturer_id": 0,
        "upc": "string",
        "average_unit_cost_cents": 0,
        "unit_cost_cents": 0,
        "archived_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"
      }
    }
  ]
}

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/inventory_journal_entries' \
-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

adjustment_typeinclude

user_ideq

part_ideq

part_location_detail_ideq

transfer_part_location_ideq

inventory_adjustment_reason_ideq

purchase_order_line_item_ideq

work_order_ideq

vendor_ideq

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!