This object is used to access the Account lookup table.
\nAn AssetBusiness represents the relationship between a particular Business within your CMMS and the associated Assets with this Business. It contains information about the Business Role Type, such as Customer/Client, Manufacturer, Owner, Service Provider, or Supplier. See the Asset object for more details and the Business object for more information. You can have multiple Assets associated with one Business. You can have multiple Businesses associated in your CMMS.
\nThis call allows you to classify parts as Class A, B, or C. To learn more about parts classification, refer to our Help Center.
\nAn AssetConsumingReference represents the relationship between a particular Bill Of Materials (BOM) Group within your CMMS and the associated Asset(s) with this CMMS. It contains information about the associated BOM (Control and Part). One example scenario: Bill Of Materials (BOM) Group is setup under Supplies. Once setup, an Asset can use this BOM by tieing one or more Assets to the BOM. This will setup an Asset to consume or take in your BOM and Parts. Alternatively, an Asset can be created first and then assigned a BOM Group (under Parts/BOM). See the Asset object for more details and information. You can have multiple AssetConsumingReference associated in your CMMS.
\nThis object represents an event that has occurred on an asset. The type of events that can occur are stored in the AssetEventType object and are defined by each tenant.
\nThis object is used to represent the different types of events that can occur to an asset. The event types are defined by each tenant.
\nAn AssetOfflineTracker represents the state of an Asset, if the Asset is set to offline. One example scenario: The User sets an Asset to online or offline. By doing so, the state is changed and persisted through this AssetOfflineTracker object. It contains information about the Date when switched to offline and a Reason as to why the state was changed to offline. Note: If an Asset is set to offline, any referenced made to the Asset (example: Bill Of Materials (BOM) Group, WorkOrder, ScheduledMaintenance) will still continue to work. See the Asset, ReasonToSetAssetOnline, and ReasonToSetAssetOffline objects for more details and information.
\nAn AssetUser represents the relationship between a particular User within your CMMS and the associated Assets with this User. It contains information about the Date Added, and the Asset User Type, such as Manager, Technician, Operator, and Consumer. See the Asset object for more details and the User object for more information. You can have multiple Assets associated with one User. You can have multiple AssetUsers associated in your CMMS.
\nThis call allows you to access a list of the Bill of Materials (BOM) Groups in your Fiix CMMS.
\nThis call allows you to specify the parts and quantities associate with your Bill of Materials (BOM) groups.
\nThis object is used to representing billing terms. The billing terms are defined by each tenant.
\nA Business represents a particular Business within your CMMS. It contains information about the address of the Business, and the Business Classification, such as Agriculture, Aerospace/Airline, Automotive, Biotechnology, Chemical Processing, Computer, Data Centers, Defense, Education, Electronics, Energy and Utilities, Manufacturing, Software, Technology, and Telecommunications. See the BusinessClassification object for more details. You can have multiple Assets associated with one Business. See the AssetBusiness object for more information. You can have multiple Businesses associated in your CMMS.
\nA BusinessClassification represents the relationship between a Business and its Classification. It contains the Business Classification list, such as Agriculture, Aerospace/Airline, Automotive, Biotechnology, Chemical Processing, Computer, Data Centers, Defense, Education, Electronics, Energy and Utilities, Manufacturing, Software, Technology, and Telecommunications. See the Business object for more details.
\nThis object is used for defining the vendor groups.
\nThe Business Role object allows you to make associations between Businesses and their Business Groups.
\nA CalendarEvent represents a certain Maintenance object such as a Work Order that is assigned to a User on a specific Date for a ScheduleTrigger or ScheduledMaintenance. The CalendarEvent is associated with your CMMS. It contains information about the timestamp Date for the CalendarEvent and the associated ScheduleTrigger. An Example Scenario: You have an Asset in the CMMS. The Asset is of type Facility. The Facility has a Work Order attached to it. The Work Order has certain Labor Tasks for certain users attached to it. For a certain Date, a CalendarEvent can be created for this Work Order where a ScheduleTrigger and ScheduledMaintenance can be assigned to a User. See the WorkOrder object for more details. You can have multiple CalendarEvents associated in your CMMS.
\nThis object is used to access the Charge Department lookup table.
\nThis object is used to represent possible countries for the locations.
\nThis object is used to represent a cycle count, its life cycle and resulting values and variances.
\nA File represents a file system object, such as pictures for Assets (facilities, equipment, tools), Supplies (Parts, Businesses), Regions, and Users. It contains information about the size of the File and the name of the File. The File object is associated with your CMMS. The File object is associated with FileContents. See FileContents object for more details. You can have multiple Files associated in your CMMS.
\nA FileContents represents a more in depth look into a specific file system object, such as pictures for Assets (facilities, equipment, tools), Supplies (Parts, Businesses), Regions, and Users. It contains information about the MimeType of the File. The FileContents object is associated with a File object. See the File object for more details.
\nThis object is used to represent the different types of maintenance that work orders can be filed under. Base possible values are \"Preventive\", \"Damage\", \"Corrective\", \"Safety\", \"Upgrade\", \"Electrical\", \"Project\", \"Inspection\", \"Meter Reading\", \"Other\", but those values can be modified for each tenant.
This object is used to store meter readings for some of the managed assets.
\nThis call allows you to access the Miscellaneous Costs associated with a Work Order.
\nThis call allows you to access a list of the Miscellaneous Cost categories configured for your Fiix CMMS (in Settings > CMMS Settings > Lookup Tables).
\nThis object represents one or several assets being moved from their original location to a new location or to a temporary destination. The temporary destination can be a location or site, a user, a business or even a work order. A Move object should be created with the \"Draft\" status and MoveAsset objects should then be associated with it. The status of the Move object should then be changed to \"Requested\" in order to trigger notification sending to the site's move managers (see MoveSiteManager). The site's move managers or an administrator will then be able to confirm the move by updating its status to \"Confirmed\", which will trigger the move to be effectively performed. If a move manager or an administrator changes the status of a move to \"Requested\", the status will be changed automatically to \"Confirmed\" and the move will be performed straight away.
This object represents a return move to put an asset back to its original location after it was put away as part of a Move. A return move should always be created with a \"Draft\" status and MoveBackAsset objects should then be attached to it. The status of the MoveBack object should then be changed to \"Requested\" in order to trigger notification sending to the site's move managers (see MoveSiteManager). The site's move managers or an administrator will then be able to confirm the move by updating its status to \"Confirmed\", which will trigger the move to be effectively performed. If a move manager or an administrator changes the status of a move to \"Requested\", the status will be changed automatically to \"Confirmed\" and the move will be performed straight away.
This object represents a return move to put an asset back to its original location after it was put away as part of a Move. A return move should always be created with a \"Draft\" status and MoveBackAsset objects should then be attached to it. The status of the MoveBack object should then be changed to \"Requested\" in order to trigger notification sending to the site's move managers (see MoveSiteManager). The site's move managers or an administrator will then be able to confirm the move by updating its status to \"Confirmed\", which will trigger the move to be effectively performed. If a move manager or an administrator changes the status of a move to \"Requested\", the status will be changed automatically to \"Confirmed\" and the move will be performed straight away.
This object is used to include assets in a return move. A MoveBack object should always be created with the status \"Draft\" and then MoveBackAsset objects should be created for each asset that is part of the return move. Once all the assets are attached to the return move, its status can be changed to \"Requested\".
This object is used to define users that can confirm an incoming move into a site. Those users can also move assets into the site without the move needing to be confirmed. CMMS administrators are automatically granted those rights on all sites and don't need to be added in this table.
\nThis object is used to represent the different statuses of a move. Possible values are \"Draft\", \"Requested\" or \"Confirmed\". Values cannot be added to that table.
This object represents the different levels of priority for a work order, a task or a scheduled maintenance. Base possible values are \"Highest\", \"High\", \"Medium\", \"Low\" or \"Lowest\", but those values can be modified for each tenant.
This object is used to represent a project. A project is used to group scheduled maintenances and work orders together.
\nWhen creating a purchase order, a Purchase Order object is created in the CMMS.
\nThis object is used to represent the Additional Costs associated with a Purchase Order.
\nThis object is used to represent the Additional Costs associated with a Purchase Order.
\nThis object is used to expose the activity log for a PurchaseOrder
\nThis object represents the possible statuses that a purchase order can have. The possible values are Draft, Waiting For Approval, Approved, On order, Order Fulfilled, Order Not Fulfilled or Cancelled.
\nThis object is used to access the action in the nested problem cause action module.
\nThis object is used to access the cause in the nested problem cause action module.
\nThis object is used to access the problem in the nested problem cause action module.
\nThis object is used to represent the Request for Quote (RFQ).
\nThis object is used to represent the various line items associated with an RFQ.
\nThis object is used to represent the status that can be associated with an RFQ.
\nA ReasonToSetAssetOffline represents the scenarios from which Assets may be decided to be changed offline. It contains information about a brief explanation of the Asset offline state, such as Broken, In storage, Idle, Retired, and Under repair. See the AssetOfflineTracker for more information.
\nA ReasonToSetAssetOnline represents the scenarios from which Assets may be decided to be changed online. It contains information about a brief explanation of the Asset online state, such as In production and On standby. See the AssetOfflineTracker for more information.
\nUpon receiving a purchase order, a Receipt object is created in the CMMS.
\nUpon reception of a purchase order, a Receipt object is created. This object represents the lines of the receipt.
\nA ReceiptStatus represents a status from which Receipts may become. Base possible values are \"Draft\", \"Received\", and \"Cancelled\", but these values can be modified for each tenant. A Receipt is tied to a Purchase Order. See the Receipt object for more details.
This object is a flattened representation of the \"User reporting to user\" hierarchy. For any descendant/ancestor relationship, there will be an entry in this table. This is a computed table, so it is read-only.
\nA ScheduleTrigger represents a trigger that is created on a ScheduledMaintenance for scheduling a WorkOrder. A WorkOrder can be scheduled for a ScheduledMaintenance when any of the ScheduleTriggers fire or when all of the ScheduleTriggers are fired depending on the configuration specified on ScheduledMaintenance.
\nA ScheduledMaintenance represents a Maintenance job that is to be done and executed by the assigned user. It contains information about the ScheduledMaintenance Maintenance Type, Date created, Priority level, Site it resides in, Asset(s) involved, and assigned User. See the MaintenanceType, ScheduledMaintenanceUser, ScheduledMaintenancePart, and ScheduledMaintenanceAsset objects for more details and information. You can have multiple ScheduledMaintenance associated in your CMMS.
\nThis object is used to link a scheduled maintenance with the assets the maintenance should be performed on.
\nA ScheduledMaintenancePart represents the relationship between a particular ScheduledMaintenance within your CMMS and the associated Parts in the CMMS. It contains information about the Part and Asset that is tied to this ScheduledMaintenance. See the ScheduledMaintenance, Part, and Asset objects for more details and information.
\nA ScheduledMaintenanceUser represents the relationship between a particular ScheduledMaintenance within your CMMS and the associated User in the CMMS. It contains information about the Notification options available to notify the User. See the User and the ScheduledMaintenance objects for more details and information.
\nFor a multi-sites tenant, this object is used to link a user to a site.
\nFor multi-sites tenants, this object does the link between site users and groups. For more details about site users, please refer to the SiteUser section.
\nThe CMMS can be used to keep track of the current stock of supplies. This object represents the current stock for a given asset.
\nThis object is used to represent the stock items included in a CycleCount.
\nThis object has the values corresponding to the various types of stock transactions that are used with a Stock.
\nThe TaskGroup provides a list of all the Task Groups that exist within the CMMS.
\nThis object represents a user that can access and use the CMMS or a user group. Note: Only inactive users can be added through the API (with intUserStatusID set to 0). The user has to be activated using the CMMS.
\nThe Warranty object represents the warranty data found on asset records, under the 'Warranties' tab. Warranties are associated with Businesses within the CMMS. See Business object for more details.
\nThis object is used for linking a work order to an asset.
\nThis object is used to specify the relation between and WorkOrder and the Businesses.
\nThis object is used to describe the parts that will be needed in order to complete a work order. For each part, it is possible to specify which one of the assets the work order is being performed on will require it. A part refers to a Stock object.
\nThis object represents the different possible status for work orders. Base possible values are \"Requested\", \"Assigned\", \"Open\", \"Work In Progress\", \"On Hold\", \"Closed, Completed\" and \"Closed, Incomplete\", but these values an be modified for each tenant.
This object represents a status transition on a Work Order. The object contains the ID of the user that made the transition, the timestamp of the occurrence, the ID of the Work Order in question and the IDs of the previous status and currently set status.
\nA work order consists of a set of tasks that must be executed by some assigned users on a set of assets. This object represents those tasks.
\nThis object is used to specify the users who should be notified upon progression of the work order.
\ngetActivityLogsThis method returns a paged response of the ActivityLogs that were recorded between the dates provided, that are associated with a Scheduled Maintenance, or both. Please note that pageNumber and pageSize are mandatory fields.
getAssetParentsThis call provides the ability to quickly resolve the asset hierarchy structure within the CMMS, allowing you to trace the parent asset for a given child asset.
getDaysOfMonthThis method retrieves the upcoming events for a given month. It will return an object called daysOfMonth. For each day of the month (starts at 1), it will give a string showing the type of events that are scheduled for this day. The letters 'w', 's', and 'p' are used as acronyms for work order, scheduled maintenance, and project, respectively. Example: A day for which a scheduled maintenance and a project event are planned will have the string \"sp\".
getEventsThis method retrieves the details about upcoming events for a given day. It returns an object called events which is a list of calendar events. Please refer to CalendarEvent for more details.
getCustomTableDataThis returns the information about the fields defined in a custom table and the values stored in the different fields. It needs either the custom table's id or the name as the input.
getWorkOrderCustomFieldsMetaDataThis returns the information about all the custom fields defined on the WorkOrder object.
This action requires no parameters getAssetBaseCustomFieldsMetaDataThis returns the information about the custom fields defined on an Asset object which are applicable to all categories.
This action requires no parameters getAssetCategoryCustomFieldsMetaDataThis returns the information about the custom fields defined on an Asset object which belongs to a specific category specified in the input.
initiateThis method is used to begin a Data Export. This will create a downloadable zip archive of customer data within the system. Status can be polled from the retrieve action below. In normal case, this would return the id that can be used to retrieve the data export from the specified URL (which is time limited). Note that this is only available to the customers on the Enterprise tier.
listThis method will return data exports for the tenant, both in-flight and completed.
retrieveThis method will return a specific Data Export, specified by the id.
createFollowOnWorkOrderOnWorkOrderTaskAllows you to configure follow-on work orders and user notifications based on inspection results in a Work Order Task. Please note that workOrderTaskId, workOrderStatusId and priorityId are mandatory inputs.
createFollowOnWorkOrderOnScheduledTaskAllows you to configure follow-on work orders and user notifications based on the inspection results of a task in Scheduled Maintenance. Please note that scheduledTaskId, workOrderStatusId and priorityId are mandatory inputs.
createFollowOnWorkOrderOnTaskGroupTaskAllows you to configure follow-on work orders and user notifications based on the inspection results of a task in a task group. Please note that taskId, workOrderStatusId and priorityId are mandatory inputs.
updateFollowOnWorkOrderOnWorkOrderTaskAllows you to update the follow-on work orders and user notifications based on inspection results in a Work Order Task. Please note that workOrderTaskId is a mandatory input.
updateFollowOnWorkOrderOnScheduledTaskAllows you to update the follow-on work orders and user notifications based on the inspection results of a task in Scheduled Maintenance. Please note that scheduledTaskId is a mandatory input.
updateFollowOnWorkOrderOnTaskGroupTaskAllows you to update the follow-on work orders and user notifications based on the inspection results of a task in a task group. Please note that taskId is a mandatory input.
deleteFollowOnWorkOrderConfigurationAllows you to delete the configuration for follow-on work orders and notifications based on inspection results for tasks in Work Orders, Scheduled Maintenance, or Task Groups. Please note that deleteFollowOnWorkOrderOnPass is mandatory, along with one of the following inputs: workOrderTaskId, scheduledTaskId, or taskId.
This method provides the ability to delete an existing Schedule Trigger. Please note that scheduleTriggerId is a mandatory input.
This method provides the ability to add Schedule Trigger to a Scheduled Maintenance using the Meter Reading Conditional Type. Please note that all 4 inputs (scheduledMaintenanceId, assetId, meterReadingValue and meterReadingUnitId) are mandatory.
This method allows you to add a time-based schedule trigger with an hourly frequency to Scheduled Maintenance. Please note that scheduledMaintenanceId is a mandatory input.
This method is used with existing receipts. It adds the received stocks (in listed receipts) to inventory and changes the Receipt status.
\nThis allows you to attach valid Task Groups to Work Orders, and creates Work Order Tasks for that Task Group within the Work Order. Note that any Files attached to a Task Group or Task within a Task Group will instead be attached to the Work Order, rather than the individual tasks.
\nThis method returns the paged response of the WorkOrderLogs between the dates provided. Please note that pageNumber and pageSize are mandatory fields.