Skip to main content

EZ Office Inventory Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to an EZ Office Inventory location.
ez_office_inventory_api.png

EZ Office Inventory

Create an EZ Office Inventory Destination​

  1. Click the + icon on the Nexset that will be sent to the EZ Office Inventory destination, and select the Send to Destination option from the menu.

  2. Select the EZ Office Inventory connector from the list of available destination connectors. Then, select the credential that will be used to connect to the EZOfficeInventory organization, and click Next; or, create a new EZ Office Inventory credential for use in this flow.

  3. In Nexla, EZ Office Inventory destinations can be created using pre-built endpoint templates, which expedite destination setup for common EZOfficeInventory write operations. Each template is designed specifically for the corresponding EZOfficeInventory endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    EZ Office Inventory destinations can also be configured manually, allowing you to send data to EZOfficeInventory endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common EZOfficeInventory endpoints. Each template is designed specifically for the corresponding EZOfficeInventory endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create a New Fixed Asset

    Creates a new fixed asset record in EZOfficeInventory. Use this endpoint to provision new assets in bulk from an external system—for example, when onboarding new equipment from a procurement feed or ERP system.

    • Map the fields in your Nexset to the EZOfficeInventory asset fields. At minimum, the asset name is required. Additional recommended fields include group, location, purchase date, and any relevant custom attributes.
    • Data is sent as a JSON body in a POST request to the EZOfficeInventory assets endpoint. Each record in the Nexset results in one new asset being created.

    After assets are created via the API, they will appear in your EZOfficeInventory account and can be managed through the standard web interface. Refer to the EZOfficeInventory API documentation for the full list of supported asset fields and their formats.

    Create a New Inventory Item

    Creates a new inventory item (volatile asset / consumable) in EZOfficeInventory. Use this endpoint to add new consumable items to your inventory in bulk, such as when receiving new stock from a supplier system.

    • Map the fields in your Nexset to the EZOfficeInventory inventory item fields. The item name and quantity are required. Additional fields such as location, description, and custom attributes are recommended for complete records.
    • Data is sent as a JSON body in a POST request to the EZOfficeInventory inventory endpoint. Each record in the Nexset results in one new inventory item being created.

    Create a New Stock Asset

    Creates a new stock asset (serialized consumable) in EZOfficeInventory. Use this endpoint when adding new serialized consumable items that require individual tracking by serial number.

    • Map the fields in your Nexset to the required stock asset fields. Stock assets require a name and quantity at minimum. Serial numbers and location information are recommended.
    • Data is sent as a JSON body in a POST request to the EZOfficeInventory stock assets endpoint.

    Update an Existing Fixed Asset

    Updates an existing fixed asset's fields in EZOfficeInventory, including name, group, location, custom fields, and associated documents. Use this endpoint to synchronize asset metadata changes from an authoritative external system into EZOfficeInventory.

    • Enter the asset number of the asset to update in the Asset Num field. This is the unique identifier assigned to the asset in EZOfficeInventory (visible in the asset detail view). The asset number is required and determines which asset record will be modified.

      • To dynamically pass asset numbers from your Nexset data, use a Nexla transformation to map the asset number field from your source data to the Asset Num parameter.
    • Map the fields you want to update from your Nexset to the corresponding EZOfficeInventory asset fields. Only the fields included in the payload will be updated; all other fields will retain their existing values.

    The asset number is distinct from the asset ID. In EZOfficeInventory, the asset number is the user-visible identifier (e.g., "ASSET-001"), while the asset ID is an internal database identifier. Use the asset number for API update operations.

    Update an Existing Inventory Item

    Updates an existing inventory item's fields in EZOfficeInventory. Use this endpoint to synchronize inventory metadata changes from an external system, such as updating descriptions, locations, or custom attribute values.

    • Enter the inventory item ID in the Id field. This is the unique internal identifier for the inventory item in EZOfficeInventory. The ID is required to identify which inventory record will be updated.
    • Map the fields you want to update from your Nexset to the corresponding EZOfficeInventory inventory item fields. Only fields included in the payload will be modified.

    Check Out an Asset

    Checks out an asset to a member or location in EZOfficeInventory. Use this endpoint to automate asset assignment workflows—for example, automatically checking out equipment to newly onboarded employees based on data from an HR system.

    • Enter the asset number of the asset to check out in the Asset Num field. This value identifies the specific asset that will be checked out.

    • In the request body, specify who or where the asset is being checked out to. The payload should include one of the following:

      • Member: Provide the member's user ID to check the asset out to a specific person.
      • Location: Provide a location ID to assign the asset to a physical location without a specific member.

    EZOfficeInventory enforces checkout rules configured in your account settings, such as requiring a due date or limiting the number of items a member can have checked out simultaneously. Ensure your checkout payload complies with your organization's configured rules.

    Check In an Asset

    Checks in a previously checked-out asset, optionally recording the return location and any relevant comments. Use this endpoint to automate asset return workflows triggered by events in other systems.

    • Enter the asset number of the asset to check in in the Asset Num field. This identifies the specific asset to be returned.
    • Optionally include a location ID and comments in the request body to record where the asset was returned and any relevant notes about its condition.

    Create a New Member

    Creates a new member (user) account in EZOfficeInventory. Use this endpoint to automatically provision EZOfficeInventory accounts for new employees based on data from an HR or identity management system.

    • Map the required fields from your Nexset: first name, last name, and email address are required to create a new member. Role and any custom fields can also be included.
    • Data is sent as a JSON body in a POST request to the EZOfficeInventory members endpoint. Each record results in one new member account being created.

    New members created via the API will receive a welcome email from EZOfficeInventory with instructions for setting their password, unless your account has configured a custom onboarding workflow.

    Update a Member's Profile

    Updates an existing member's profile information in EZOfficeInventory, including name, email address, role, and custom fields. Use this endpoint to keep member records in sync with an authoritative identity source such as an HR system or Active Directory.

    • Enter the user ID of the member to update in the User Id field. This is the unique internal identifier for the member in EZOfficeInventory and is required to identify which profile will be modified.
    • Map the fields you want to update from your Nexset to the corresponding EZOfficeInventory member profile fields. Only fields included in the payload will be modified.

    Create a New Purchase Order

    Creates a new purchase order in EZOfficeInventory. Use this endpoint to programmatically generate purchase orders from procurement data in another system, or to automate order creation when inventory falls below defined thresholds.

    • Map the required purchase order fields from your Nexset, including vendor information, line items, and expected delivery date.
    • Data is sent as a JSON body in a POST request to the EZOfficeInventory purchase orders endpoint.

    Create a New Location

    Creates a new location in the EZOfficeInventory system. Use this endpoint to bulk-provision location records—for example, when setting up EZOfficeInventory for a new site or synchronizing location data from a facilities management system.

    • Enter your EZOfficeInventory subdomain in the Subdomain field (e.g., mycompany from mycompany.ezofficeinventory.com).
    • Map the location name and any optional fields (such as parent location or description) from your Nexset to the corresponding EZOfficeInventory location fields.

    Create a Reservation

    Creates a reservation for an asset in EZOfficeInventory. Use this endpoint to automate asset reservations from an external scheduling or booking system, ensuring assets are reserved for upcoming needs.

    • Enter your EZOfficeInventory subdomain in the Subdomain field.

    • Map the required reservation fields from your Nexset to the request body, including:

      • Asset identifier: The asset or inventory item to be reserved.
      • Member: The user for whom the reservation is being made.
      • Start and end dates: The reservation period.

    Retire an Asset

    Retires an asset in EZOfficeInventory, recording an end-of-life lifecycle action. Retiring removes the asset from active use while preserving its historical records. Use this endpoint to automate the retirement of assets based on data from a financial or asset management system.

    • Enter the asset number of the asset to retire in the Asset Number field. This identifies the specific asset that will be retired.
    • Enter your EZOfficeInventory subdomain in the Subdomain field.
    • Include a salvage value in the request body. A salvage value is required by EZOfficeInventory for all asset retirement actions and is used for depreciation and financial reporting purposes.

    Retiring an asset is a permanent lifecycle action in EZOfficeInventory. Retired assets are moved out of the active asset pool and cannot be checked out, but their historical records—including all transactions and history—are preserved for reporting and audit purposes.

    Delete (Retire) a Fixed Asset

    Deletes (retires) a fixed asset from EZOfficeInventory by asset number. Use this endpoint to remove assets that are no longer needed in your EZOfficeInventory account as part of an automated decommissioning workflow.

    • Enter the asset number of the asset to delete in the Asset Num field. This is the unique identifier for the asset in EZOfficeInventory.

    :::warning Important Deleting an asset is irreversible. Ensure that the correct asset number is provided before executing this operation. Consider using the Retire an Asset endpoint instead if you want to preserve historical records while removing the asset from active use. :::

    Delete an Inventory Item

    Deletes an inventory item by its ID from EZOfficeInventory. Use this endpoint as part of an automated cleanup or decommissioning workflow to remove obsolete inventory records.

    • Enter the inventory item ID in the Inventory ID field. This is the unique internal identifier for the inventory item in EZOfficeInventory.

    :::warning Important Deleting an inventory item is irreversible. Verify the correct inventory ID before executing this operation. :::

    Update GPS Coordinates for an Asset

    Updates the GPS coordinates (latitude, longitude, and GPS asset ID) for a trackable asset in EZOfficeInventory. Use this endpoint to push location data from GPS tracking devices or telematics systems into EZOfficeInventory for real-time asset location visibility.

    • Enter the asset number of the asset whose GPS coordinates will be updated in the Asset Number field.
    • Enter your EZOfficeInventory subdomain in the Subdomain field.

    • Include the following fields in the request body, mapped from your Nexset:

      • gps_asset_id: The unique identifier for the asset in the GPS tracking system.
      • latitude: The current latitude of the asset.
      • longitude: The current longitude of the asset.

    GPS coordinate tracking requires that the GPS tracking feature is enabled in your EZOfficeInventory account. Additional details are available in the EZOfficeInventory GPS Location Tracking API guide.

Configure Manually​

EZ Office Inventory destinations can be manually configured to send data to any valid EZOfficeInventory API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the EZOfficeInventory API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the EZOfficeInventory API from the Method pulldown menu. Common methods for EZOfficeInventory write operations include:

    • POST: For creating new records (assets, members, inventory items, purchase orders, reservations)
    • PUT: For updating existing records (full replacement of fields)
    • PATCH: For partial updates to existing records (e.g., updating GPS coordinates)
    • DELETE: For removing records

Data Format​

  1. Select the format in which the Nexset data will be sent to the EZOfficeInventory API from the Content Format pulldown menu. EZOfficeInventory expects data in JSON format for all write operations. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the EZOfficeInventory API endpoint to which you want to send the Nexset data in the URL field. EZOfficeInventory API endpoints follow this pattern: https://your-subdomain.ezofficeinventory.com/resource.api

    For update or delete operations that target a specific record, include the record identifier in the URL path. For example, to update asset number ASSET-001, the URL would be: https://your-subdomain.ezofficeinventory.com/assets/ASSET-001.api

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the token authentication header here—it is automatically included by Nexla based on your EZ Office Inventory credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this EZ Office Inventory destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the EZOfficeInventory API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the EZOfficeInventory API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the EZOfficeInventory API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the EZOfficeInventory API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured EZOfficeInventory endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to EZOfficeInventory until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.