### Start Work Order Source: https://www.ezofficeinventory.com/developers Marks a work order as 'in progress', effectively starting the work order. ```APIDOC ## PATCH /tasks//mark_in_progress.api ### Description Marks a work order as 'in progress', effectively starting the work order. ### Method PATCH ### Endpoint https://.ezofficeinventory.com/tasks//mark_in_progress.api ### Path Parameters - **Work_Order#** (integer) - Required - The ID of the work order to start. ### Response #### Success Response (200) - **message** (string) - A confirmation message indicating the work order has started. #### Response Example ```json { "message": "Work order marked as in progress." } ``` ``` -------------------------------- ### Start a Project Source: https://www.ezofficeinventory.com/developers Updates the project status to in-progress. ```curl curl -H "token:" -X PATCH \ https://.ezofficeinventory.com/projects//mark_in_progress.api ``` -------------------------------- ### Schedule Service Source: https://www.ezofficeinventory.com/developers Schedule a service for an asset. This includes start and end dates/times, description, and service type. Optionally, the item can be made unavailable from the start date. ```bash curl -H "token:" -X POST \ -d "service[make_item_unavailable]=true" \ -d "service[end_date]=" \ -d "service_end_time=" \ -d "service[start_date]=" \ -d "service_start_time=" \ -d "service_type_name=" \ -d "service[description]=" \ http://.ezofficeinventory.com/assets//services.api?service_type=scheduled_service ``` -------------------------------- ### GET /checklists Source: https://www.ezofficeinventory.com/developers Retrieves a list of all checklists. ```APIDOC ## GET /checklists ### Description Retrieves all checklists with pagination. ### Method GET ### Endpoint https://.ezofficeinventory.com/checklists/page= ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number (default 1). ``` -------------------------------- ### GET /stock_assets.api Source: https://www.ezofficeinventory.com/developers Retrieves all asset stock. ```APIDOC ## GET /stock_assets.api ### Description Retrieves a paginated list of all asset stock. ### Method GET ### Endpoint https://.ezofficeinventory.com/stock_assets.api ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number (default 1) - **include_custom_fields** (boolean) - Optional ``` -------------------------------- ### Background Job Error Response Example Source: https://www.ezofficeinventory.com/developers This JSON structure shows an example of an error response when a background job fails during processing. ```json { "background_job": { "id": "b42a3950-22ff-440b-a994-42c0d3efd1e1", "status": "Failed", "data": { "error": "An unexpected error occurred while processing the report." } } } ``` -------------------------------- ### Retrieve Reservation Requests Starting Today Source: https://www.ezofficeinventory.com/developers Retrieves all reservation requests that start today across all assets, inventory, stock assets, and baskets. Supports pagination. ```APIDOC ## GET /checkout_requests/filter.api ### Description Retrieves all reservation requests starting today. Supports pagination. ### Method GET ### Endpoint https://.ezofficeinventory.com/checkout_requests/filter.api ### Query Parameters - **all** (boolean) - Required - Set to true to retrieve all requests. - **start_date** (string) - Required - The start date for filtering (mm/dd/yyyy). - **page** (integer) - Optional - The page number to retrieve. Defaults to 1. Each page contains up to 25 requests. ``` -------------------------------- ### GET /inventory.api Source: https://www.ezofficeinventory.com/developers Retrieves a list of all inventory items. ```APIDOC ## GET /inventory.api ### Description Retrieves all inventories. Supports pagination and optional inclusion of custom fields and document details. ### Method GET ### Endpoint https://.ezofficeinventory.com/inventory.api ### Query Parameters - **page** (integer) - Optional - Page number (default 1) - **include_custom_fields** (boolean) - Optional - Include item custom fields - **show_document_urls** (boolean) - Optional - Include document links - **show_image_urls** (boolean) - Optional - Include image links - **show_document_details** (boolean) - Optional - Include document details ``` -------------------------------- ### Background Job Response Example (Multiple Attachments) Source: https://www.ezofficeinventory.com/developers This JSON structure illustrates a successful response for a background job that has completed and includes multiple attachments. ```json { "background_job": { "id": "b8ef86c8-eabe-4459-a2ce-884fe3f5b0e7", "status": "Completed", "attachments": [ { "order": 1, "mime-type": "text/csv", "download_url": "https://s3.amazonaws.com/download/custom_report_part_1.csv", "download_url_expires_at": "2025-02-04T01:51:59Z" }, { "order": 2, "mime-type": "text/csv", "download_url": "https:/s3.amazonaws.com/download/custom_report_part_2.csv", "download_url_expires_at": "2025-02-04T01:51:59Z" }, { "order": 3, "mime-type": "text/csv", "download_url": "https://s3.amazonaws.com/download/custom_report_part_3.csv", "download_url_expires_at": "2025-02-04T01:51:59Z" }, { "order": 4, "mime-type": "text/csv", "download_url": "https://s3.amazonaws.com/download/custom_report_part_4.csv", "download_url_expires_at": "2025-02-04T01:51:59Z" } ] } } ``` -------------------------------- ### Start Work Order Source: https://www.ezofficeinventory.com/developers Update the status of a work order to in-progress. ```curl curl -H "token:" -X PATCH \ https://.ezofficeinventory.com/tasks//mark_in_progress.api? ``` -------------------------------- ### GET /projects/{PROJECT#}.api Source: https://www.ezofficeinventory.com/developers Retrieves details of a specific project or its linked modules. ```APIDOC ## GET /projects/{PROJECT#}.api ### Description Fetches project details or details of linked modules like items, carts, checkouts, or reservations. ### Method GET ### Endpoint https://{SUBDOMAIN}.ezofficeinventory.com/projects/{PROJECT#}.api ### Query Parameters - **module_name** (string) - Optional - Module to fetch (items, carts, checkouts, reservations, locations) - **item_type** (string) - Optional - Required for items/checkouts/reservations (asset, stock_assets, inventory) - **page** (integer) - Optional - Page number for pagination ``` -------------------------------- ### Background Job Response Example (Single Attachment) Source: https://www.ezofficeinventory.com/developers This JSON structure represents a successful response for a background job that has completed and contains a single attachment. ```json { "background_job": { "id": "59eff6ae-b983-4a80-a829-88e1c3d8a422", "status": "Completed", "attachments": [ { "order": 1, "mime-type": "text/csv", "download_url": "https://s3.amazonaws.com/download/custom_report_2025-02-04_014937.csv", "download_url_expires_at": "2025-02-04T02:50:54Z" } ] } } ``` -------------------------------- ### Retrieve Subgroup Details Source: https://www.ezofficeinventory.com/developers Use this command to get specific details about a subgroup. Replace placeholders with your actual token, subdomain, group ID, and subgroup ID. ```bash curl -H "token:" -X GET \ http://.ezofficeinventory.com/groups//sub_groups/.api ``` -------------------------------- ### Retry-After Header Example Source: https://www.ezofficeinventory.com/developers The 429 response always includes a Retry-After header that lets you know how many seconds to wait before retrying. ```text Retry-After: 3600 ``` -------------------------------- ### Retrieve Inventory Quantity by Location Source: https://www.ezofficeinventory.com/developers Get the stock quantity of a specific asset at a particular location. You must provide the `asset_id` and `location_id`. Replace placeholders with your actual token, subdomain, asset ID, and location ID. ```bash curl -H "token:" -X GET \ -d "asset_id=" \ -d "location_id=" \ https://.ezofficeinventory.com/locations/get_quantity_by_location.api ``` -------------------------------- ### Create Package Source: https://www.ezofficeinventory.com/developers Create a new package by specifying its name and associated assets. An optional description can also be provided. ```bash curl -H "token:" -X POST \ -d "package[name]=" -d "package[description]=" \ -d "asset_ids= " \ http://.ezofficeinventory.com/packages.api ``` -------------------------------- ### Retrieve Reservation Requests Starting Today Source: https://www.ezofficeinventory.com/developers Retrieves all reservation requests for assets, inventory, and baskets starting on a specific date. ```curl curl -H "token:" -X GET \ https://.ezofficeinventory.com/checkout_requests/filter.api? \ all=true&start_date=mm/dd/yyyy&page= ``` -------------------------------- ### POST /projects.api Source: https://www.ezofficeinventory.com/developers Creates a new project with specified details and settings. ```APIDOC ## POST /projects.api ### Description Creates a new project. The project name is a mandatory field. ### Method POST ### Endpoint https://.ezofficeinventory.com/projects.api ### Parameters #### Request Body - **project[name]** (string) - Required - Name of the project - **project[identifier]** (string) - Optional - Project identifier - **project[description]** (string) - Optional - Project description - **project[expected_start_date]** (string) - Optional - Start date (mm/dd/yyyy) - **project[expected_end_date]** (string) - Optional - End date (mm/dd/yyyy) - **project[project_setting_attributes]** (object) - Optional - Settings for items, checkouts, reservations, purchase orders, tasks, baskets, and locations - **user_ids** (string) - Optional - Comma separated user IDs - **contract_id** (string) - Optional - Comma separated contract IDs ``` -------------------------------- ### Create a Project Source: https://www.ezofficeinventory.com/developers The project name is a mandatory field. Additional optional parameters include identifiers, descriptions, dates, and settings. ```curl curl -H "token:" -X POST \ -d "project[name]=" \ -d "project[identifier]=" \ -d "project[description]=" \ -d "project[expected_start_date]=mm/dd/yyyy" \ -d "project[expected_end_date]=mm/dd/yyyy" \ -d "project[project_setting_attributes][items_enabled]=" \ -d "project[project_setting_attributes][checkouts_enabled]=" \ -d "project[project_setting_attributes][reservations_enabled]=" \ -d "project[project_setting_attributes][purchase_orders_enabled]=" \ -d "project[project_setting_attributes][tasks_enabled]=" \ -d "project[project_setting_attributes][baskets_enabled]=" \ -d "project[project_setting_attributes][locations_enabled]=" \ -d "user_ids=," \ -d "contract_id=," \ https://.ezofficeinventory.com/projects.api ``` -------------------------------- ### Create Vendor Source: https://www.ezofficeinventory.com/developers Add a new vendor to the system. The vendor name is mandatory. You can also provide description, website, address, contact details, and custom attributes. ```bash curl -H "token:" -X POST \ -d "vendor[name]=" \ -d "vendor[description]=" \ -d "vendor[website]=" \ -d "vendor[address]=
" \ -d "vendor[contact_person_name]=" \ -d "vendor[email]=" \ -d "vendor[phone_number]=" \ -d "vendor[fax]=" \ -d "vendor[custom_attributes][CUSTOM_ATTRIBUTE_NAME]=" \ https://.ezofficeinventory.com/vendors.api ``` -------------------------------- ### Create a Bundle Source: https://www.ezofficeinventory.com/developers Create a new bundle by specifying the name and associated assets. Asset stock requires quantity, while inventory assets require both quantity and price. ```curl curl -H "token:" -X POST \ -d "bundle[name]=" \ -d "bundle[location_id]=" -d "bundle[identification_number]=" \ -d "bundle[description]=" \ -d "asset_ids=" \ -d "asset_attributes[][quantity]=" \ -d "asset_attributes[][price]=" \ "https://.ezofficeinventory.com/bundles.api" ``` ```curl curl -H "token:" -X POST \ -d "bundle[name]=" \ -d "bundle[location_id]=" -d "bundle[identification_number]=" \ -d "bundle[description]=" \ -d "asset_ids=1,2,3,4,5,6" \ -d "asset_attributes[3][quantity]=2" \ -d "asset_attributes[4][quantity]=2" \ -d "asset_attributes[5][quantity]=2" \ -d "asset_attributes[5][price]=10" \ -d "asset_attributes[6][quantity]=2" \ -d "asset_attributes[6][price]=30" \ "https://.ezofficeinventory.com/bundles.api?" ``` -------------------------------- ### GET /teams.api Source: https://www.ezofficeinventory.com/developers Retrieve all teams. ```APIDOC ## GET /teams.api ### Description Retrieve all teams. ### Method GET ### Endpoint https://.ezofficeinventory.com/teams.api ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number to access (default 1). ``` -------------------------------- ### GET /baskets.api Source: https://www.ezofficeinventory.com/developers Retrieves a list of all carts. ```APIDOC ## GET /baskets.api ### Description Retrieves all carts associated with the account. ### Method GET ### Endpoint https://.ezofficeinventory.com/baskets.api ``` -------------------------------- ### POST /packages.api Source: https://www.ezofficeinventory.com/developers Creates a new package of assets. ```APIDOC ## POST /packages.api ### Description Creates a new package. ### Method POST ### Endpoint http://.ezofficeinventory.com/packages.api ### Parameters #### Request Body - **package[name]** (string) - Required - Name of the package. - **asset_ids** (string) - Required - Space separated list of Asset IDs. - **package[description]** (string) - Optional - Description of the package. ``` -------------------------------- ### Retrieve User Listings Source: https://www.ezofficeinventory.com/developers Retrieves all user listings with optional pagination. ```bash curl -H "token:" -X GET \ https://.ezofficeinventory.com/user_listings.api?page= ``` -------------------------------- ### Create a Bundle Source: https://www.ezofficeinventory.com/developers Creates a new bundle with specified assets and attributes. Mandatory fields include bundle[name] and assets. For Asset Stock, asset_attributes[Asset#][quantity] is mandatory. For Inventory Asset, asset_attributes[Asset#][price] and asset_attributes[Asset#][quantity] are mandatory. Optional fields include bundle[identification_number], bundle[description], and bundle[location_id]. ```APIDOC ## POST /bundles.api ### Description Creates a new bundle with specified assets and attributes. ### Method POST ### Endpoint https://.ezofficeinventory.com/bundles.api ### Parameters #### Request Body - **bundle[name]** (string) - Required - The name of the bundle. - **asset_ids** (string) - Required - Comma-separated list of asset IDs to include in the bundle. - **bundle[location_id]** (string) - Optional - The ID of the location for the bundle. - **bundle[identification_number]** (string) - Optional - The identification number for the bundle. - **bundle[description]** (string) - Optional - A description for the bundle. - **asset_attributes[Asset#][quantity]** (integer) - Required for Asset Stock - The quantity of the asset in the bundle. - **asset_attributes[Asset#][price]** (float) - Required for Inventory Asset - The price of the asset in the bundle. ### Request Example ```json { "bundle[name]": "", "bundle[location_id]": "", "bundle[identification_number]": "", "bundle[description]": "", "asset_ids": "1,2,3,4,5,6", "asset_attributes[3][quantity]": "2", "asset_attributes[4][quantity]": "2", "asset_attributes[5][quantity]": "2", "asset_attributes[5][price]": "10", "asset_attributes[6][quantity]": "2", "asset_attributes[6][price]": "30" } ``` ### Response #### Success Response (200) - **id** (integer) - The ID of the created bundle. - **name** (string) - The name of the bundle. - **created_at** (string) - The timestamp when the bundle was created. #### Response Example ```json { "id": 1, "name": "Example Bundle", "created_at": "2023-10-27T10:00:00Z" } ``` ``` -------------------------------- ### GET /custom_roles.api Source: https://www.ezofficeinventory.com/developers Retrieve all system roles. ```APIDOC ## GET /custom_roles.api ### Description Retrieve all roles defined in the system. ### Method GET ### Endpoint https://.ezofficeinventory.com/custom_roles.api ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number to access (default 1). ``` -------------------------------- ### GET /members.api Source: https://www.ezofficeinventory.com/developers Retrieve a list of all members. ```APIDOC ## GET /members.api ### Description Retrieve all members of the company. Each page returns 25 members. ### Method GET ### Endpoint https://.ezofficeinventory.com/members.api ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number to access (default 1). - **include_custom_fields** (boolean) - Optional - Include item custom fields in the result. ``` -------------------------------- ### Retrieve All Bundles Source: https://www.ezofficeinventory.com/developers Fetches a list of all bundles. Pagination is supported using the `page` parameter, with each page containing 25 bundles. ```bash curl -H "token:" -X GET \ https://.ezofficeinventory.com/bundles.api?page= ``` -------------------------------- ### Retrieve Purchase Order Details Source: https://www.ezofficeinventory.com/developers Use this command to fetch the details of a specific purchase order. ```bash curl -H "token:" -X GET \ https://.ezofficeinventory.com/purchase_orders/.api ``` -------------------------------- ### GET /search.api Source: https://www.ezofficeinventory.com/developers Searches for inventory items. ```APIDOC ## GET /search.api ### Description Searches for inventory items by name, item number, or identification number. ### Method GET ### Endpoint https://.ezofficeinventory.com/search.api ### Parameters #### Query Parameters - **search** (string) - Required - The name, item number (#), or identification number (@) of the inventory. - **facet** (string) - Optional - The facet type (e.g., VolatileAsset). - **include_custom_fields** (boolean) - Optional - Whether to include custom fields. - **show_document_urls** (boolean) - Optional - Whether to show document URLs. - **show_image_urls** (boolean) - Optional - Whether to show image URLs. - **show_document_details** (boolean) - Optional - Whether to show document details. - **page** (number) - Optional - Page number (default is 1). ``` -------------------------------- ### Create Asset Stock Source: https://www.ezofficeinventory.com/developers Create a new asset stock entry. Mandatory fields include `stock_asset[name]` and `stock_asset[group_id]`. Optional fields like `stock_asset[location_id]`, `stock_asset[manufacturer]`, `stock_asset[image_url]`, `stock_asset[document_urls][]`, and `stock_asset[identifier]` can also be provided. Custom fields can be added using `cust_attr[custom field name]`. ```bash curl -H "token:" -X POST \ -d "stock_asset[name]=" \ -d "stock_asset[group_id]=" \ -d "stock_asset[location_id]=" \ -d "stock_asset[manufacturer]=" \ -d "stock_asset[image_url]=" \ -d "stock_asset[document_urls][]=" \ -d "stock_asset[document_urls][]=" \ -d "stock_asset[identifier]=" \ https://.ezofficeinventory.com/stock_assets.api ``` -------------------------------- ### Retrieve Assets in Service (General) Source: https://www.ezofficeinventory.com/developers Fetches all assets currently in service. The `show_document_urls` parameter is optional and can be set to `true` to include document links. Pagination is supported via the `page` parameter. ```bash curl -H "token:" -X GET \ -d "show_document_urls=true" \ "https://.ezofficeinventory.com/assets/filter.api?for_service=true&status=assets_being_serviced&page=" ``` -------------------------------- ### GET /background_jobs.api Source: https://www.ezofficeinventory.com/developers Retrieves a list of all background jobs. ```APIDOC ## GET /background_jobs.api ### Description Retrieves a list of all background jobs and their current statuses. ### Method GET ### Endpoint https://.ezofficeinventory.com/background_jobs.api ### Response #### Success Response (200) - **background_jobs** (array) - List of job objects. - **meta** (object) - Metadata including total pages. ``` -------------------------------- ### GET /tasks.api Source: https://www.ezofficeinventory.com/developers Retrieves filtered work orders. ```APIDOC ## GET /tasks.api ### Description Retrieves work orders based on a filter. ### Method GET ### Endpoint https://.ezofficeinventory.com/tasks.api ### Parameters #### Query Parameters - **filter** (string) - Required - Filter value (complete, in_progress, review_pending, open). - **page** (integer) - Optional - Page number (default 1). ``` -------------------------------- ### Retrieve All Inventories Source: https://www.ezofficeinventory.com/developers Fetches all inventory items. Use include_custom_fields, show_document_urls, show_image_urls, and show_document_details to include additional information in the response. Pagination is supported via the page parameter. ```bash curl -H "token:" -X GET \ -d "include_custom_fields=true" \ -d "show_document_urls=true" \ -d "show_image_urls=true" \ -d "show_document_details=true" \ https://.ezofficeinventory.com/inventory.api?page= ``` -------------------------------- ### Create New Sale Source: https://www.ezofficeinventory.com/developers Use this endpoint to record a new sale for an inventory item. Specify quantity, price, comments, location, and custom attributes. ```bash curl -H "token:" -X POST \ -d "line_item[quantity]=" \ -d "line_item[price]=" \ -d "line_item[comments]=" \ -d "line_item[location_id]=" \ -d "remove_stock_values[c_attr_vals][]=" \ -d "order_type=New Sale" \ https://.ezofficeinventory.com/inventory//order.api ``` -------------------------------- ### GET /reports/list_custom_reports.api Source: https://www.ezofficeinventory.com/developers Retrieves a list of all saved custom reports. ```APIDOC ## GET /reports/list_custom_reports.api ### Description Retrieves a list of all saved custom reports available in the system. ### Method GET ### Endpoint https://.ezofficeinventory.com/reports/list_custom_reports.api ### Response #### Success Response (200) - **reports** (array) - List of report objects containing id, name, and description. #### Response Example { "reports": [ { "id": 4312, "name": "Items Report", "description": "List of All Items in the System" } ] } ``` -------------------------------- ### GET /bundles.api Source: https://www.ezofficeinventory.com/developers Retrieves a list of bundles or filtered bundles. ```APIDOC ## GET /bundles.api ### Description Retrieves a paginated list of bundles. Can be filtered by status, location, or availability duration. ### Method GET ### Endpoint https://.ezofficeinventory.com/bundles.api ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number (default 1, 25 bundles per page) - **filter** (string) - Optional - Filter value (active, retired, location, available_during) - **location** (string) - Optional - Location filter - **start_date** (string) - Optional - Start date for available_during filter - **end_date** (string) - Optional - End date for available_during filter ``` -------------------------------- ### Receive Purchase Order Items Source: https://www.ezofficeinventory.com/developers Use this endpoint to receive a purchase order with all its items. Payment details can be specified. ```bash curl -H "token:" -X PATCH \ -F "payment_details[amount]=" \ https://.ezofficeinventory.com/purchase_orders//receive_items.api ``` -------------------------------- ### PUT /assets//services/.api?finish_service=true Source: https://www.ezofficeinventory.com/developers Completes an existing asset service. ```APIDOC ## PUT /assets//services/.api?finish_service=true ### Description Marks a service as complete and updates service details. ### Method PUT ### Endpoint http://.ezofficeinventory.com/assets//services/.api?finish_service=true ### Parameters #### Request Body - **service[cost]** (decimal) - Required - Cost of the service - **service[end_date]** (string) - Required - Expected completion date - **service_end_time** (string) - Required - Expected completion time - **inventory_ids** (string) - Required - Comma-separated list of inventory IDs - **linked_inventory_items[Asset#][quantity]** (integer) - Required - Quantity of linked inventory - **linked_inventory_items[Asset#][location_id]** (integer) - Required - Location ID for linked inventory ``` -------------------------------- ### GET /inventory/filter.api Source: https://www.ezofficeinventory.com/developers Applies a custom filter to inventory items. ```APIDOC ## GET /inventory/filter.api ### Description Applies a custom filter to inventory based on a provided filter ID. ### Method GET ### Endpoint https://.ezofficeinventory.com/inventory/filter.api ### Parameters #### Query Parameters - **assets_type** (string) - Required - The type of assets - **status** (string) - Required - Formatted as custom_filter_ - **filter_param_val** (string) - Required - The custom_filter_id - **page** (integer) - Optional - Page number (default 1) ``` -------------------------------- ### Retrieve All Labels Source: https://www.ezofficeinventory.com/developers Fetch label templates, including Template ID, Description, and Type. You can filter by `template_type` to retrieve specific kinds of labels. ```bash curl -H "token:" -X GET \ -d "template_type=" \https://.ezofficeinventory.com/print_label_templates.api ``` -------------------------------- ### GET /baskets/.api Source: https://www.ezofficeinventory.com/developers Retrieves details for a specific cart. ```APIDOC ## GET /baskets/.api ### Description Fetches the details of a specific cart by its ID. ### Method GET ### Endpoint https://.ezofficeinventory.com/baskets/.api ### Parameters #### Path Parameters - **BASKET_ID#** (string) - Required - The ID of the basket. ``` -------------------------------- ### GET /bundles/.api Source: https://www.ezofficeinventory.com/developers Retrieves details for a specific bundle. ```APIDOC ## GET /bundles/.api ### Description Retrieves detailed information for a specific bundle by its ID. ### Method GET ### Endpoint https://.ezofficeinventory.com/bundles/.api ``` -------------------------------- ### Retrieve All Assets Source: https://www.ezofficeinventory.com/developers Use this endpoint to fetch all assets. Include optional parameters like `include_custom_fields`, `show_document_urls`, `show_image_urls`, and `show_document_details` to enrich the response. Specify `page` to paginate results, with each page containing up to 25 assets. ```curl curl -H "token:" -X GET \ -d "include_custom_fields=true" \ -d "show_document_urls=true" \ -d "show_image_urls=true" \ -d "show_document_details=true" \ https://.ezofficeinventory.com/assets.api?page= ``` -------------------------------- ### Create Purchase Order Source: https://www.ezofficeinventory.com/developers Creates a new purchase order associated with a vendor. ```bash curl -H "token:" -X POST \ -d "vendor_id=" \ https://.ezofficeinventory.com/purchase_orders.api ``` -------------------------------- ### GET /members/.api Source: https://www.ezofficeinventory.com/developers Retrieve details of a specific member. ```APIDOC ## GET /members/.api ### Description Retrieve details of a specific user by ID. ### Method GET ### Endpoint https://.ezofficeinventory.com/members/.api ### Parameters #### Path Parameters - **USER_ID** (string) - Required - The ID of the member. #### Query Parameters - **include_custom_fields** (boolean) - Optional - Include item custom fields in the result. ``` -------------------------------- ### POST /inventory.api Source: https://www.ezofficeinventory.com/developers Creates a new inventory item. ```APIDOC ## POST /inventory.api ### Description Creates a new inventory item. Mandatory fields include volatile_asset[name] and volatile_asset[group_id]. ### Method POST ### Endpoint https://.ezofficeinventory.com/inventory.api ### Request Body - **volatile_asset[name]** (string) - Required - Name of the asset - **volatile_asset[group_id]** (integer) - Required - ID of the group - **volatile_asset[location_id]** (integer) - Optional - ID of the location - **volatile_asset[manufacturer]** (string) - Optional - Manufacturer name - **volatile_asset[image_url]** (string) - Optional - URL for the asset image - **volatile_asset[document_urls][]** (array) - Optional - Up to 5 document URLs - **volatile_asset[identifier]** (string) - Optional - Identification number ``` -------------------------------- ### GET /locations/get_quantity_by_location.api Source: https://www.ezofficeinventory.com/developers Retrieves the stock quantity of an asset at a specific location. ```APIDOC ## GET /locations/get_quantity_by_location.api ### Description Retrieves stock quantity for a specific asset at a specific location. ### Method GET ### Endpoint https://.ezofficeinventory.com/locations/get_quantity_by_location.api ### Parameters #### Query Parameters - **asset_id** (string) - Required - The Item# - **location_id** (string) - Required - The Location# ``` -------------------------------- ### Retrieve Depreciation Methods Source: https://www.ezofficeinventory.com/developers Retrieves a list of all configured depreciation methods. ```bash curl -H "token:" -X GET \ https://.ezofficeinventory.com/depreciation_methods.api ``` -------------------------------- ### GET /inventory/filter.api Source: https://www.ezofficeinventory.com/developers Filters inventory assets based on status and other parameters. ```APIDOC ## GET /inventory/filter.api ### Description Retrieves a filtered list of assets based on status and optional parameters. ### Method GET ### Endpoint https://.ezofficeinventory.com/inventory/filter.api ### Parameters #### Query Parameters - **status** (string) - Required - Filter option (e.g., group, items_in_order, location, low_stock, quantity_range, update_time). - **filter_param_val** (string) - Optional - Value associated with the filter. - **sub_group_param_val** (string) - Optional - Subgroup ID when filtering by group. - **page** (number) - Optional - Page number (default is 1). ``` -------------------------------- ### GET /inventory//history.api Source: https://www.ezofficeinventory.com/developers Retrieves the history of a specific asset. ```APIDOC ## GET /inventory//history.api ### Description Retrieves the history of a specific asset, paginated by 5 entries per page. ### Method GET ### Endpoint https://.ezofficeinventory.com/inventory//history.api ### Parameters #### Path Parameters - **ASSET#** (string) - Required - The unique identifier of the asset. #### Query Parameters - **page** (number) - Optional - Page number (default is 1). ``` -------------------------------- ### Retrieve All Purchase Orders Source: https://www.ezofficeinventory.com/developers This command retrieves a list of all purchase orders. ```bash curl -H "token:" -X GET \ https://.ezofficeinventory.com/purchase_orders.api ``` -------------------------------- ### GET /assets/:id/reserved_dates.api Source: https://www.ezofficeinventory.com/developers Retrieve the reserved dates for a specific Asset Stock. ```APIDOC ## GET /assets//reserved_dates.api ### Description Retrieves the list of reserved dates for a specific asset stock item. ### Method GET ### Endpoint https://.ezofficeinventory.com/assets//reserved_dates.api ### Parameters #### Path Parameters - **Asset Stock#** (string) - Required - The unique identifier for the asset stock ``` -------------------------------- ### Retrieve All Carts Source: https://www.ezofficeinventory.com/developers Lists all available carts. ```bash curl -H "token:" -X GET \ https://.ezofficeinventory.com/baskets.api ``` -------------------------------- ### GET /locations/get_quantity_by_location.api Source: https://www.ezofficeinventory.com/developers Retrieve the quantity of a specific stock asset at a given location. ```APIDOC ## GET /locations/get_quantity_by_location.api ### Description Retrieves the stock quantity of an asset at a specific location. ### Method GET ### Endpoint https://.ezofficeinventory.com/locations/get_quantity_by_location.api ### Query Parameters - **asset_id** (string) - Required - The Item# of the asset - **location_id** (string) - Required - The Location# of the location ``` -------------------------------- ### GET /custom_filters.api Source: https://www.ezofficeinventory.com/developers Retrieves IDs of all custom filters for a specific asset type. ```APIDOC ## GET /custom_filters.api ### Description Retrieves IDs of all custom filters for a given asset type. ### Method GET ### Endpoint https://.ezofficeinventory.com/custom_filters.api ### Parameters #### Query Parameters - **assets_type** (string) - Required - The type of assets (e.g., volatile_assets) ``` -------------------------------- ### GET /inventory/.api Source: https://www.ezofficeinventory.com/developers Retrieves details for a specific inventory item. ```APIDOC ## GET /inventory/.api ### Description Retrieves details of a specific inventory item by its Asset#. ### Method GET ### Endpoint https://.ezofficeinventory.com/inventory/.api ### Parameters #### Path Parameters - **ASSET#** (string) - Required - The unique identifier of the asset ### Query Parameters - **show_document_urls** (boolean) - Optional - Include document links - **show_image_urls** (boolean) - Optional - Include image links - **show_document_details** (boolean) - Optional - Include document details - **include_custom_fields** (boolean) - Optional - Include item custom fields ``` -------------------------------- ### Create Location Source: https://www.ezofficeinventory.com/developers Creates a new location with specified details. Name is mandatory. ```APIDOC ## POST /locations.api ### Description Creates a new location. ### Method POST ### Endpoint https://.ezofficeinventory.com/locations.api ### Parameters #### Request Body - **location[name]** (string) - Required - The name of the location. - **location[city]** (string) - Optional - The city of the location. - **location[state]** (string) - Optional - The state of the location. - **location[zipcode]** (string) - Optional - The zipcode of the location. - **location[street1]** (string) - Optional - The first line of the street address. - **location[street2]** (string) - Optional - The second line of the street address. - **location[status]** (string) - Optional - The status of the location (e.g., active). - **location[description]** (string) - Optional - A description for the location. ``` -------------------------------- ### GET /assets/filter.api Source: https://www.ezofficeinventory.com/developers Retrieves details of assets currently in service based on various filters. ```APIDOC ## GET /assets/filter.api ### Description Retrieves a paginated list of assets currently being serviced. Supports filtering by document URLs, service type, or service state. ### Method GET ### Endpoint https://.ezofficeinventory.com/assets/filter.api ### Parameters #### Query Parameters - **for_service** (boolean) - Required - Must be true - **status** (string) - Required - Must be 'assets_being_serviced' - **page** (integer) - Optional - Page number (default 1, 25 assets per page) - **show_document_urls** (boolean) - Optional - Include document links - **service_type** (string) - Optional - Filter by service type name - **service_state** (string) - Optional - Filter by service state ``` -------------------------------- ### Retrieve Custom Fields Source: https://www.ezofficeinventory.com/developers Retrieves all custom fields defined in the system. ```bash curl -H "token:" -X GET \ https://.ezofficeinventory.com/assets/custom_attributes.api ``` -------------------------------- ### GET /stock_assets/filter.api Source: https://www.ezofficeinventory.com/developers Retrieve stock assets based on various status filters and parameters. ```APIDOC ## GET /stock_assets/filter.api ### Description Filters stock assets based on status and optional parameters. Supports standard filters, subgroups, and custom filters. ### Method GET ### Endpoint https://.ezofficeinventory.com/stock_assets/filter.api ### Query Parameters - **status** (string) - Required - Filter option (e.g., location, possessions_of, low_stock, group, custom_filter_) - **filter_param_val** (string) - Optional - Value associated with the status filter - **sub_group_param_val** (string) - Optional - Subgroup ID when status is 'group' - **assets_type** (string) - Optional - Required for custom filters (set to 'stock_assets') - **page** (integer) - Optional - Page number (default 1) ``` -------------------------------- ### Send Asset Verification Request Source: https://www.ezofficeinventory.com/developers Initiate a verification request for a specific asset by providing the asset number. This is a POST request. ```bash curl -H "token:" -X POST \ https://.ezofficeinventory.com/assets//verification_requests.api ``` -------------------------------- ### Retrieve Current Checkouts Source: https://www.ezofficeinventory.com/developers Gets the current checkout status for specific line items. ```curl curl -H "token:" -X GET \ -d "current_checkout_status=" \ -d "user_id=" \ https://.ezofficeinventory.com/stock_assets//get_current_checkouts.api ``` -------------------------------- ### Retrieve Specific Bundle Details Source: https://www.ezofficeinventory.com/developers Retrieves detailed information for a specific bundle by providing its ID in the URL. ```bash curl -H "token:" -X GET \ https://.ezofficeinventory.com/bundles/.api ``` -------------------------------- ### Retrieve Retire Reasons Source: https://www.ezofficeinventory.com/developers Retrieves all reasons defined for retiring assets. ```bash curl -H "token:" -X GET \ https://.ezofficeinventory.com/retire_reasons.api ``` -------------------------------- ### GET /stock_assets/.api Source: https://www.ezofficeinventory.com/developers Retrieves details of a specific asset stock item. ```APIDOC ## GET /stock_assets/.api ### Description Retrieves details for a specific asset stock item. ### Method GET ### Endpoint https://.ezofficeinventory.com/stock_assets/.api ### Parameters #### Path Parameters - **AssetStock#** (string) - Required - The ID of the asset stock ``` -------------------------------- ### Retrieve Inventory Details Source: https://www.ezofficeinventory.com/developers Fetches details for a specific inventory item using its Asset#. Optional parameters include show_document_urls, show_image_urls, show_document_details, and include_custom_fields. ```bash curl -H "token:" -X GET \ -d "show_document_urls=true" \ -d "show_image_urls=true" \ -d "show_document_details=true" \ -d "include_custom_fields=true" \ https://.ezofficeinventory.com/inventory/.api ``` -------------------------------- ### GET /inventory//location_based_thresholds.api Source: https://www.ezofficeinventory.com/developers Retrieves location-specific threshold details for an inventory item. ```APIDOC ## GET /inventory//location_based_thresholds.api ### Description Retrieves location-specific threshold details for the inventory item. ### Method GET ### Endpoint https://.ezofficeinventory.com/inventory//location_based_thresholds.api ### Parameters #### Path Parameters - **Inventory#** (string) - Required - The ID of the inventory item ``` -------------------------------- ### GET /assets//reserved_dates.api Source: https://www.ezofficeinventory.com/developers Retrieves the reserved dates for a specific inventory item. ```APIDOC ## GET /assets//reserved_dates.api ### Description Retrieves reserved dates for the specified inventory item. ### Method GET ### Endpoint https://.ezofficeinventory.com/assets//reserved_dates.api ### Parameters #### Path Parameters - **Inventory#** (string) - Required - The ID of the inventory item ``` -------------------------------- ### Retrieve All Asset Stock Source: https://www.ezofficeinventory.com/developers Fetch all asset stock entries. The `page` parameter can be used to paginate results (25 assets per page). Optional parameters like `include_custom_fields`, `show_document_urls`, `show_image_urls`, and `show_document_details` can be included to enrich the response. ```bash curl -H "token:" -X GET \ -d "include_custom_fields=true" \ -d "show_document_urls=true" \ -d "show_image_urls=true" \ -d "show_document_details=true" \ https://.ezofficeinventory.com/stock_assets.api?page= ``` -------------------------------- ### GET /search.api Source: https://www.ezofficeinventory.com/developers Search for asset stock details by name, Item Number, or Identification Number. ```APIDOC ## GET /search.api ### Description Search for asset stock details. Supports searching by name, Item Number (#), or Identification Number (@). ### Method GET ### Endpoint https://.ezofficeinventory.com/search.api ### Query Parameters - **search** (string) - Required - The name of the asset stock, or #ItemNumber, or @IdentificationNumber - **facet** (string) - Optional - Set to 'StockAsset' - **include_custom_fields** (boolean) - Optional - Include item custom fields in result - **show_document_urls** (boolean) - Optional - Include document URLs - **show_image_urls** (boolean) - Optional - Include image URLs - **show_document_details** (boolean) - Optional - Include document details - **page** (integer) - Optional - Page number (default 1) ``` -------------------------------- ### Create Location Source: https://www.ezofficeinventory.com/developers Creates a new location. The 'name' field is mandatory. ```curl curl -H "token:" -X POST \ -d "location[name]=" \ -d "location[city]=" \ -d "location[status]=" \ https://.ezofficeinventory.com/locations.api ```