API
Document Schemas ChangeLogOct 30
Sign Up
Get Started Free
Sign In
Log in to your account

Schemas

AddAisleRequest Object

Request model for adding aisle. Applicable only when multi-quantiy feature is enabled

Field Type Required Nullable Description
name string Yes No Name of the aisle (Aisle name cannot exceed 100 characters.).
AddAssetRequest Object

Request model for adding an asset. Contains core item details, category/location assignment, purchase and depreciation information, and optional custom fields.

Field Type Required Nullable Description
assetTagId string Yes No Unique tag identifier assigned to the asset (e.g., barcode or QR code label). Cannot exceed 50 characters.
description string Yes No Detailed description of the asset including its purpose, specifications, or notes. Cannot exceed 1000 characters.
brand string No Yes Brand or manufacturer name of the asset (e.g., Dell, HP, Samsung). Cannot exceed 50 characters.
model string No Yes Model name or number of the asset as specified by the manufacturer. Cannot exceed 50 characters.
serialNo string No Yes Unique serial number assigned by the manufacturer for asset identification and warranty tracking. Cannot exceed 50 characters.
purchaseDate date No Yes The date the asset was purchased. Format: yyyy-MM-dd.
purchaseFrom string No Yes Name of the vendor or supplier from whom the asset was purchased. Cannot exceed 100 characters.
cost currency No Yes Original purchase price of the asset at the time of acquisition.
siteRefId int32 No Yes Foreign key referencing the site or facility where the asset is located.
locationRefId int32 No Yes Foreign key referencing the physical location where the asset is stored or deployed.
categoryRefId int32 No Yes Foreign key referencing the asset's primary category (e.g., IT Equipment, Furniture, Vehicles).
subCategoryRefId int32 No Yes Foreign key referencing the sub-category for more granular asset classification.
departmentRefId int32 No Yes Foreign key referencing the department responsible for or assigned to this asset.
depreciationMethod DepreciationMethod (Enum) No Yes Type of Depreciation Method. Allowed values: StraightLine, DecliningBalance, DecliningBalance150Percent, SumoftheYearsDigits, DoubleDecliningBalance.
dateAcquired date No Yes The date the asset was formally acquired or put into service. Format: yyyy-MM-dd.
isDepreciable boolean No No Indicates whether this asset is subject to depreciation calculations.
initialCost currency No Yes The original value of the asset at the start of its depreciable life.
salvageValue currency No Yes The estimated residual or scrap value of the asset at the end of its useful life.
assetLife int32 No Yes The expected useful lifespan of the asset, in months.
customFieldRequest [CustomFieldRequest(Object)] No Yes Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.
AddAuditRequest Object

Request model for adding an asset audit.

Field Type Required Nullable Description
auditNameRefId int32 Yes No Foreign key referencing the audit name to audit the asset against. Must not be locked.
siteRefId int32 Yes No Foreign key referencing the site where the audit took place.
locationRefId int32 Yes No Foreign key referencing the location where the audit took place. Must belong to siteRefId.
notes string No Yes Text area for notes. (cannot exceed 1000 characters.)
auditDate date-time Yes No Date and time when the asset was audited. Format: yyyy-MM-ddTHH:mm:ss.
updateAssetLocation boolean Yes No When true, updates the asset's own site/location to match siteRefId/locationRefId and logs a history entry for the change.
recordGps boolean Yes No Indicates whether GPS coordinates were captured for this audit.
latitude double No Yes Latitude coordinate where the audit was performed. Required when recordGps is true.
longitude double No Yes Longitude coordinate where the audit was performed. Required when recordGps is true.
AddBinRequest Object

Request model for adding bin. Applicable only when multi-quantiy feature is enabled

Field Type Required Nullable Description
aisleRefId int32 No Yes Optional foreign key referencing the aisle. Set null to create an unallocated. Required only when the inventory location hierarchy is configured as Aisle > Shelf > Bins.
shelfRefId int32 No Yes Optional foreign key referencing the shelf. Set null to create an unallocated bin (not assigned to any shelf). Required only when the inventory location hierarchy is configured as Shelf > Bins.
name string Yes No Name of the bin (Bin Name cannot exceed 100 characters.).
AddBrokenEventRequest Object

Request model for adding a broken event to an asset.

Field Type Required Nullable Description
date1 date-time Yes No Date the asset was found broken. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for broken in Setup Events.
notes string No Yes Broken notes. (cannot exceed 1000 characters.)
AddCategoryRequest Object

Request model for adding a new category.

Field Type Required Nullable Description
name string Yes No Name of the category (cannot exceed 50 characters.).
AddCheckinEventRequest Object

Request model for adding a check-in event to an asset.

Field Type Required Nullable Description
date1 date-time Yes No Check-in (return) date. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for check-in in Setup Events (the same setting as check-out time).
siteRefId int32 No Yes Foreign key referencing the site the asset is returned to. Required when the asset is checked out to a site/location; ignored when it is checked out to a person.
locationRefId int32 No Yes Foreign key referencing the location the asset is returned to. Used when the asset is checked out to a site/location; must belong to siteRefId.
newSiteRefId int32 No Yes Optional new site for the asset when it is checked in from a person.
newLocationRefId int32 No Yes Optional new location for the asset when it is checked in from a person. Takes precedence over newSiteRefId.
newDepartmentRefId int32 No Yes Optional new department for the asset. Applied only when departments are enabled.
notes string No Yes Check-in notes. (cannot exceed 1000 characters.)
sendEmail boolean No No When true and the asset is checked in from a person, sends the check-in notification email to the email address of the person the asset is checked out to. No email is sent if that person has no email address.
AddCheckoutEventRequest Object

Request model for adding a check-out event to an asset.

Field Type Required Nullable Description
checkoutTo AssignTo (Enum) Yes No Who or where the asset is checked out to. Allowed values: Person, SiteLocation.
date1 date-time No Yes Check-out date. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when check-out time is enabled in Setup Events.
date2 date-time No Yes Due date. Leave empty for no due date. Same format as date1.
personRefId int32 No Yes Foreign key referencing the person the asset is checked out to. Required when checkoutTo is Person.
siteRefId int32 No Yes Foreign key referencing the site the asset is checked out to. Required when checkoutTo is SiteLocation.
locationRefId int32 No Yes Foreign key referencing the location the asset is checked out to. Used when checkoutTo is SiteLocation; must belong to siteRefId.
notes string No Yes Check-out notes. (cannot exceed 1000 characters.)
newSiteRefId int32 No Yes Optional new site for the asset itself when checking out to a person.
newLocationRefId int32 No Yes Optional new location for the asset itself when checking out to a person. Takes precedence over newSiteRefId.
newDepartmentRefId int32 No Yes Optional new department for the asset. Applied only when departments are enabled.
sendEmail boolean No No When true and checkoutTo is Person, sends the check-out notification email to the email address of the person identified by personRefId. No email is sent if that person has no email address.
overrideReservation boolean No No What to do when the asset (or, with check-out linking, a linked asset) is reserved by someone else for the check-out dates. False (default): the check-out is not saved and a 409 lists the reservations. True: checks out anyway and leaves the reservations in place.
AddContractRequest Object

Request model for creating a new contract or license.

Field Type Required Nullable Description
contractTitle string Yes No Title or name of the contract or license. (cannot exceed 50 characters.)
description string No Yes Additional details or notes about the contract or license. (cannot exceed 1000 characters.)
hyperlink uri No Yes Website URL or hyperlink associated with the contract or license. (cannot exceed 150 characters.)
contractNo string No Yes Contract or license number assigned by the vendor or provider. (cannot exceed 50 characters.)
vendor string No Yes Name of the vendor associated with the contract. (cannot exceed 50 characters.)
contactPerson string No Yes Name of the primary contact person for the contract or license. (cannot exceed 50 characters.)
phone tel No Yes Phone number of the contract or license contact person. (cannot exceed 20 characters.)
cost currency No Yes Cost of the contract or license.
startDate date Yes No Start date of the contract or license (yyyy-MM-dd).
endDate date No Yes End date or expiration date of the contract or license (yyyy-MM-dd). Required unless NoEndDate is true (returns 422 if missing). When NoEndDate is true, send null; any stored end date is cleared.
licenseCount int32 No Yes Number of licenses covered by the contract.
noEndDate boolean No No Indicates whether the contract has no expiration date.
softwareContract boolean No No Indicates whether the contract is for software.
customFieldRequest [CustomFieldRequest(Object)] No Yes Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.
AddCustomerRequest Object

Request model for adding a new customer.

Field Type Required Nullable Description
name string Yes No Customer Name (cannot exceed 100 characters.)
company string No Yes Company name of the customer. (cannot exceed 100 characters.)
address1 string No Yes Address1 of the customer. (cannot exceed 250 characters.)
address2 string No Yes Address2 of the customer. (cannot exceed 250 characters.)
city string No Yes City of the customer (cannot exceed 50 characters.)
state string No Yes State of the customer. (cannot exceed 50 characters.)
zip string No Yes Zip of the customer. (cannot exceed 50 characters.)
countryRefId int32 No Yes Foreign key referencing the country.
phone string No Yes Phone number of the customer. (cannot exceed 50 characters.)
cell string No Yes Cell number of the customer. (cannot exceed 50 characters.)
email email No Yes Email of the customer. (cannot exceed 50 characters.)
notes string No Yes Notes or Comment (cannot exceed 1000 characters.)
customFieldRequest [CustomFieldRequest(Object)] No Yes Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.)
AddDepartmentRequest Object

Request model for adding a new department.

Field Type Required Nullable Description
name string Yes No Name of the department (cannot exceed 50 characters.).
AddDisposeEventRequest Object

Request model for adding a dispose event to an asset.

Field Type Required Nullable Description
date1 date-time Yes No Date the asset was disposed. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for dispose in Setup Events.
textField string No Yes Who or what the asset was disposed to (free text, e.g. a recycling vendor). (cannot exceed 100 characters.)
notes string No Yes Dispose notes. (cannot exceed 1000 characters.)
AddDonateEventRequest Object

Request model for adding a donate event to an asset.

Field Type Required Nullable Description
date1 date-time Yes No Date the asset was donated. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for donate in Setup Events.
textField string No Yes Who the asset was donated to (free text, e.g. a charity). (cannot exceed 100 characters.)
currency double Yes No Value of the donation. Use 0 when there is no value.
boolean boolean Yes No Whether the donation is tax deductible.
notes string No Yes Donate notes. (cannot exceed 1000 characters.)
AddFoundEventRequest Object

Request model for adding a found event to a lost asset. Same fields as an update; found has no notification email.

Field Type Required Nullable Description
date1 date-time Yes No Date the asset was found. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for found in Setup Events.
notes string No Yes Found notes. (cannot exceed 1000 characters.)
AddFundRequest Object

Request model for creating a new fund.

Field Type Required Nullable Description
name string Yes No Name of the fund. Must be unique.(cannot exceed 50 characters.)
description string No Yes Description of the fund.(cannot exceed 1000 characters.)
amount currency No Yes Total allocated amount.
startDate date No Yes Fund start date (yyyy-MM-dd).
endDate date No Yes Fund end date (yyyy-MM-dd).
notes multiline No Yes Additional notes.(cannot exceed 1000 characters.)
active boolean Yes No Whether this fund is active (default: true).
AddInsuranceRequest Object

Request model for creating a new insurance.

Field Type Required Nullable Description
insuranceCo string No Yes Name of the insurance company or provider.(cannot exceed 100 characters.)
description string Yes No Additional details or notes about the insurance policy.(cannot exceed 100 characters.)
person string No Yes Name of the primary contact person for the insurance policy.(cannot exceed 50 characters.)
phone tel No Yes Contact phone number for the insurance provider or representative.(cannot exceed 20 characters.)
email email No Yes Contact email address for the insurance provider or representative.(cannot exceed 50 characters.)
policy string No Yes Policy number assigned by the insurance provider.(cannot exceed 50 characters.)
coverage string No Yes Coverage details provided by the insurance policy.(cannot exceed 50 characters.)
limits string No Yes Coverage limits or maximum claim amount defined by the policy.(cannot exceed 50 characters.)
deductible currency No Yes Deductible amount that must be paid before insurance coverage applies.
premium currency No Yes Premium amount paid for the insurance policy.
startDate date Yes No Policy start date (yyyy-MM-dd).
endDate date Yes No Policy end or expiration date (yyyy-MM-dd).
active boolean Yes No Whether this insurance is active (default: true).
AddInventoryItemRequest Object

Request model for adding a new inventory item. Contains core item details, stock information, pricing, alerts, opening date, and optional custom fields.

Field Type Required Nullable Description
inventoryTagId string Yes No Unique tag or code assigned to the inventory item for tracking. (cannot exceed 50 characters.)
description string Yes No Detailed description of the inventory item. (cannot exceed 1000 characters.)
categoryRefId int32 No Yes Readable name of the main category (resolved from CategoryRefId).
subCategoryRefId int32 No Yes Readable name of the main subcategory (resolved from SubCategoryRefId).
notes multiline No Yes Notes. (Notes cannot exceed 1000 characters.)
sku string No Yes Stock Keeping Unit – unique identifier used for managing stock. (SKU cannot exceed 100 characters.)
brand string No Yes Brand name of the item. (cannot exceed 50 characters.)
model string No Yes Model name/number of the item. (cannot exceed 50 characters.)
vendor string No Yes Supplier or vendor associated with the item. (cannot exceed 50 characters.)
url uri No Yes Reference URL (e.g., vendor page, product page, or documentation). (cannot exceed 100 characters.)
size string No Yes Size or dimensions of the item. (cannot exceed 50 characters.)
color string No Yes Color of the item. (cannot exceed 50 characters.)
style string No Yes Style or variant of the item (if applicable). (cannot exceed 50 characters.)
unit string Yes No Unit of measurement (e.g., piece, box, kg, liter). (cannot exceed 50 characters.)
minQty double No Yes Minimum quantity threshold for stock. (used for re-order alerts).
maxQty double No Yes Maximum quantity limit for stock. (used for inventory control).
hasMaxQtyAlert boolean No No Enable Maximum quantity alert.
hasMinQtyAlert boolean No No Enable Minimum quantity alert.
minQtyAlert double No Yes Minimum quantity alert.
maxQtyAlert double No Yes Maximum quantity alert.
openingDate date No Yes Opening date in yyyy-MM-dd format. Applicable only when the Multi-Quantity feature is disabled.
unitCost currency No Yes Unit Cost. Applicable only when the Multi-Quantity feature is disabled.
totalCost currency No Yes Total Cost. Applicable only when the Multi-Quantity feature is disabled.
refNo string No Yes Reference No. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
aisle string No Yes Aisle, Warehouse, Site. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
shelf string No Yes Shelf, Rack, Cabinet. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
bin string No Yes Bins, Bay, Drawer. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
eventNotes multiline No Yes Event Notes. (cannot exceed 1000 characters.) Applicable only when the Multi-Quantity feature is disabled.
customFieldRequest [CustomFieldRequest(Object)] No Yes Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.
quantity double No Yes Opening quantity. Applicable only when stock location tracking (Multi-Quantity) is disabled. When it is enabled, leave this empty, create the item, then post an Opening transaction with locations; sending a quantity returns 422.
AddLeaseEventRequest Object

Request model for adding a lease event to an asset.

Field Type Required Nullable Description
customerRefId int32 Yes No Foreign key referencing the customer the asset is leased to.
date1 date-time Yes No Date the lease begins. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for lease in Setup Events.
date2 date-time No Yes Date the lease expires. Leave empty for no end date. Same format as date1.
notes string No Yes Lease notes. (cannot exceed 1000 characters.)
sendEmail boolean No No When true, sends the lease notification email to the email address of the customer identified by customerRefId. No email is sent if that customer has no email address.
overrideReservation boolean No No What to do when the asset (or, with lease linking, a linked asset) is reserved by someone else for the lease dates. False (default): the lease is not saved and a 409 lists the reservations. True: leases anyway and leaves the reservations in place.
AddLeaseReturnEventRequest Object

Request model for adding a lease return event to a leased asset.

Field Type Required Nullable Description
date1 date-time Yes No Date the leased asset was returned. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for lease return in Setup Events.
notes string No Yes Lease return notes. (cannot exceed 1000 characters.)
sendEmail boolean No No When true, sends the lease return notification email to the email address of the customer the asset is leased to. No email is sent if that customer has no email address.
AddLocationRequest Object

Request model for adding a new location.

Field Type Required Nullable Description
name string Yes No Name of the location (cannot exceed 100 characters).
siteRefId int32 Yes No Foreign key referencing the parent site (positive integer only).
description string No Yes Description (cannot exceed 1000 characters).
AddLostEventRequest Object

Request model for adding a lost event to an asset. Same fields as an update; lost has no notification email.

Field Type Required Nullable Description
date1 date-time Yes No Date the asset was lost. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for lost in Setup Events.
notes string No Yes Lost notes. (cannot exceed 1000 characters.)
AddPersonRequest Object

Request model for adding a new Person.

Field Type Required Nullable Description
name string Yes No Person Name (cannot exceed 100 characters.)
title string No Yes Title of the person. (cannot exceed 100 characters.)
phone string No Yes Phone number of the person. (cannot exceed 20 characters.)
email email No Yes Email of the person. (cannot exceed 50 characters.)
notes string No Yes Notes or Comment (cannot exceed 1000 characters.)
empId string No Yes EmpId of the person. (cannot exceed 50 characters.)
siteRefId int32 No Yes Foreign key referencing the site.
locationRefId int32 No Yes Foreign key referencing the location.
departmentRefId int32 No Yes Foreign key referencing the department.
customFieldRequest [CustomFieldRequest(Object)] No Yes Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.
AddRepairEventRequest Object

Request model for adding a repair event to an asset.

Field Type Required Nullable Description
date1 date-time Yes No Date the repair is scheduled. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for repair in Setup Events.
textField string No Yes Who the repair is assigned to (free text, e.g. a technician or vendor). (cannot exceed 100 characters.)
date2 date-time No Yes Date the repair was completed. Setting it ends the repair: the asset goes back to its previous check-out or lease, or to Available. Same format as date1.
currency double No Yes Cost of the repair.
notes string No Yes Repair notes. (cannot exceed 1000 characters.)
AddReserveRequest Object

Request model for reserving an asset.

Field Type Required Nullable Description
reserveTo AssignTo (Enum) Yes No Who or where the asset is reserved for. Allowed values: Person, SiteLocation, Customer.
personRefId int32 No Yes Foreign key referencing the person the asset is reserved for. Required when reserveTo is Person.
customerRefId int32 No Yes Foreign key referencing the customer the asset is reserved for. Required when reserveTo is Customer.
siteRefId int32 No Yes Foreign key referencing the site the asset is reserved for. Required when reserveTo is SiteLocation.
locationRefId int32 No Yes Foreign key referencing the location the asset is reserved for. Optional with reserveTo SiteLocation; must belong to siteRefId.
date1 date-time Yes No Reservation start. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for reservations in Setup Events.
date2 date-time Yes No Reservation end; must not be before date1. Same format as date1. Without time, the reservation runs to the end of this day.
notes string No Yes Reservation notes. (cannot exceed 1000 characters.)
sendEmail boolean No No When true and reserveTo is Person or Customer, sends the reservation confirmation email to that person's or customer's email address and turns on the reminder emails below. No email is sent if they have no email address.
firstReminderEnabled boolean No No Send reminder email #1. Applies only when sendEmail is true.
firstReminderLeadTimeDays int32 No No Days before the reservation starts to send reminder email #1 (1-99, default 2).
secondReminderEnabled boolean No No Send reminder email #2. Applies only when sendEmail is true.
secondReminderLeadTimeDays int32 No No Days before the reservation starts to send reminder email #2 (1-99, default 1).
AddSellEventRequest Object

Request model for adding a sell event to an asset.

Field Type Required Nullable Description
date1 date-time Yes No Date the asset was sold. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for sell in Setup Events.
textField string No Yes Who the asset was sold to (free text). (cannot exceed 100 characters.)
currency double No Yes Amount the asset was sold for.
notes string No Yes Sell notes. (cannot exceed 1000 characters.)
AddShelfRequest Object

Request model for adding shelf. Applicable only when multi-quantiy feature is enabled

Field Type Required Nullable Description
aisleRefId int32 No Yes Optional foreign key referencing the aisle. Set null to create an unallocated shelf (not assigned to any aisle). Required only when the inventory location hierarchy is configured as Aisle > Shelf > Bins.
name string Yes No Name of the shelf (Shelf name cannot exceed 100 characters.).
AddSiteRequest Object

Request model for adding a new site.

Field Type Required Nullable Description
name string Yes No Name of the site (cannot exceed 50 characters).
address1 string No Yes Address line 1 (cannot exceed 500 characters).
address2 string No Yes Address line 2 / Apt. / Suite (cannot exceed 500 characters).
city string No Yes City (cannot exceed 50 characters).
state string No Yes State / Province (cannot exceed 50 characters).
zip string No Yes Postal / Zip code (cannot exceed 50 characters).
countryRefId int32 No Yes Foreign key referencing the country (positive integer only).
description string No Yes Description (cannot exceed 1000 characters).
AddSubCategoryRequest Object

Request model for adding a new subcategory.

Field Type Required Nullable Description
categoryRefId int32 Yes No Unique identifier (primary key) for the category (positive integer only).
name string Yes No Name of the subcategory (cannot exceed 100 characters.).
AddTransactionRequest Object

Request model for adding a new inventory transaction to an existing inventory item. Supports five transaction types: Opening, AddStock, RemoveStock, Adjustment, and Movement (Movement requires stock location tracking). For accounts with stock-location tracking enabled, stock can be distributed across multiple storage locations using the Locations array (AddStock, RemoveStock, Adjustment) or the FromLocations and ToLocations arrays (Movement). Only one of PersonRefId, CustomerRefId, or PersonName may be provided per request.

Field Type Required Nullable Description
eventType InventoryEvent (Enum) Yes No Type of inventory event. Allowed values: Opening, AddStock, RemoveStock, Adjustment, Movement.
quantity double Yes No Total quantity involved in the transaction. When locations are provided, this value must equal the sum of all location quantities. For Movement, this must equal the sum of all fromLocations quantities and the sum of all toLocations quantities.
isAddToStock boolean No No For Adjustment transactions, specifies whether to add or remove from stock. True = add to stock, False = remove from stock. Ignored for AddStock, RemoveStock, and Movement.
eventDate date Yes No Date of the transaction in yyyy-MM-dd format.
personRefId int32 No Yes Reference ID of the employee/person associated with the transaction. Applicable only for Remove Stock transactions. Only one of personRefId, customerRefId, or personName may be provided — supplying more than one returns a 422 Validation error.
customerRefId int32 No Yes Reference ID of the customer associated with the transaction. Applicable only for Remove Stock transactions. Only one of personRefId, customerRefId, or personName may be provided — supplying more than one returns a 422 Validation error.
personName string No Yes Free-text name of the person or customer (max 50 characters). Applicable only for Remove Stock transactions. Only one of personRefId, customerRefId, or personName may be provided — supplying more than one returns a 422 Validation error.
unitCost currency No Yes Unit cost of the item at the time of the transaction. Applicable only for Add Stock and Opening Stock transactions.
totalCost currency No Yes Total cost of the transaction (quantity × unitCost). Applicable only for Add Stock and Opening Stock transactions.
refNo string No Yes Reference number associated with the transaction.(cannot exceed 50 characters.) Applicable only for Add Stock and Opening Stock transactions.
notes string No Yes Additional notes or comments related to the transaction. (cannot exceed 1000 characters.)
aisle string No Yes Aisle name for the storage location. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
shelf string No Yes Shelf name within the aisle. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
bin string No Yes Bin Name within the shelf. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
locations [StockSummary(Object)] No Yes Array of location entries for Opening, AddStock, RemoveStock, and Adjustment transactions. Each entry contains a quantity and location reference IDs (AisleRefId, ShelfRefId, BinRefId). Required when stock location tracking (Multi-Quantity) and locations are enabled for the account; ignored otherwise. When required, the sum of all entry quantities must equal the top-level quantity field. Not used for Movement transactions.
fromLocations [StockSummary(Object)] No Yes Array of source location entries for Movement transactions. Each entry specifies the quantity and location reference IDs (AisleRefId, ShelfRefId, BinRefId) of the location stock is moving from. Movement is only available when stock location tracking (Multi-Quantity) and locations are enabled; otherwise it returns 422. The sum of all entry quantities must equal the top-level quantity field. Required when eventType is Movement.
toLocations [StockSummary(Object)] No Yes Array of destination location entries for Movement transactions. Each entry specifies the quantity and location reference IDs (AisleRefId, ShelfRefId, BinRefId) of the location stock is moving to. Movement is only available when stock location tracking (Multi-Quantity) and locations are enabled; otherwise it returns 422. The sum of all entry quantities must equal the top-level quantity field. Required when eventType is Movement.
Aisle Object

Represents a storage aisle within an inventory location hierarchy. An aisle contains one or more shelves, which further contain bins. Applicable only when multi-quantiy feature is enabled.

Field Type Description
refId int32 Unique identifier (primary key) for the Aisle (positive integer only).
name string Aisle Name (Aisle name cannot exceed 100 characters.)
shelves [Shelf(Object)] A collection of shelves associated with this aisles.May be empty if none are defined.
AisleListRequest Object

Request model for fetching a list of aisles. Applicable only when multi-quantiy feature is enabled

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter aisles by name (Search keyword cannot exceed 100 characters.).
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith".
orderBy DataField (Enum) No No - The field to order results by aisle name. Default: "Name" Allowed values: "Name".
sortOrder SortOrder (Enum) No No - The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc".
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100.
ApiError Object

Represents a standardized error response returned by the API. It contains the field that caused the error and a descriptive message.

Field Type Description
field string The field or parameter name associated with the error. If the error is not tied to a specific field, this may be null or empty.
message string A descriptive message explaining the error.
APIResponse Object

Represents a standard API response wrapper with metadata, message, and optional data payload of type .

Field Type Description
success boolean Indicates whether the request was processed successfully (true) or not (false).
statusCode int32 HTTP status code of the response (e.g., 200 = OK, 400 = Bad Request).
message string Human-readable message describing the result of the request.
totalRecords int32 Total number of records that match the request criteria before pagination is applied. Null for responses that are not paginated.
data The actual payload of the response. Contains the requested data if successful.
errors [ApiError(Object)] A collection of validation or processing errors that occurred during the request. Populated only when Success is false.
requestId string A unique identifier for the request. Useful for tracing and debugging.
result Result(Enum) Enumerates possible outcomes or statuses of an operation, such as Success, Success, or ErrorOccoured.
Asset Object

Represents a tracked asset within the asset management system, including asset details, categorization, location, purchase information, and depreciation data.

Field Type Description
refId int32 Unique identifier (primary key) for the asset.
assetTagId string Unique tag identifier assigned to the asset (e.g., barcode or QR code label).
description string Detailed description of the asset including its purpose, specifications, or notes.
defaultImageRefGuid string Unique GUID referencing the primary image record for the asset.
brand string Brand or manufacturer name of the asset (e.g., Dell, HP, Samsung).
model string Model name or number of the asset as specified by the manufacturer.
serialNo string Unique serial number assigned by the manufacturer for asset identification and warranty tracking.
purchaseDate date The date the asset was purchased. Format: yyyy-MM-dd.
purchaseFrom string Name of the vendor or supplier from whom the asset was purchased.
cost double Original purchase price of the asset at the time of acquisition.
dateAdded date-time Datetime (UTC) when the asset record was added to the system.
siteRefId int32 Foreign key referencing the site or facility where the asset is located.
siteName string Readable name of the site (resolved from SiteRefId).
locationRefId int32 Foreign key referencing the physical location where the asset is stored or deployed.
locationName string Readable name of the location (resolved from LocationRefId).
categoryRefId int32 Foreign key referencing the asset's primary category (e.g., IT Equipment, Furniture, Vehicles).
categoryName string Readable name of the category (resolved from CategoryRefId).
subCategoryRefId int32 Foreign key referencing the sub-category for more granular asset classification.
subCategoryName string Readable name of the sub-category (resolved from SubCategoryRefId).
departmentRefId int32 Foreign key referencing the department responsible for or assigned to this asset.
departmentName string Readable name of the department (resolved from DepartmentRefId).
depreciationMethod DepreciationMethod (Enum) Name of the the depreciation method applied to this asset (e.g., Straight-Line, Declining Balance).
addedByRefGuid string Unique GUID referencing the user who created this asset.
eventRefId int32 Foreign key referencing the current events tracking record associated with this asset. Only populated when fetchEvent=true is passed; null otherwise.
event Event (Object) Represents a tracked current event associated with an asset throughout its lifecycle. Event can include checkout, checkin, lease, lease return or any custom event against an asset.
dateAcquired date The date the asset was formally acquired or put into service. Format: yyyy-MM-dd.
isDepreciable boolean Indicates whether this asset is subject to depreciation calculations.
initialCost double The original value of the asset at the start of its depreciable life.
salvageValue double The estimated residual or scrap value of the asset at the end of its useful life.
assetLife int32 The expected useful lifespan of the asset in months or years (as configured).
status Status (Enum) Current status label of the asset (e.g., "Available", "Checked Out", "Broken"). For custom events this is the custom event name. Only populated when fetchEvent=true is passed; null otherwise.
currentCost double The current book value of the asset after accumulated depreciation.
linked boolean Indicate that this asset and its linking assets should be audited/check-out/checked-in, etc., as a group.
linkType LinkType (Enum) Whether this asset is the parent or a child in a linked parent/child relationship. Null when the asset isn't linked. Independent of Linked (transact as a whole).
customEventRefId int32 Foreign key referencing the custom event definition for this event. Null for standard events.
reservation AssetReservation (Object) Current reservation for this asset. Null when no active or upcoming reservation exists.
customFieldValues [CustomFieldValue(Object)] A collection of custom field values associated with this asset. May be null if no custom fields are defined.
AssetAudit Object

Represents an audit record associated with an asset.

Field Type Description
refId int32 Unique identifier (primary key) of the audit.
assetRefId int32 Unique identifier (primary key) of the asset.
auditName AuditName (Object) Represents an audit associated with an asset.
auditedByRefGuId string Unique GUID of the User who audited the asset.
auditDate date-time Date and time when the asset was audited.
siteRefId int32 Foreign key referencing the site where the asset was audited.
siteName string Readable name of the site (resolved from SiteRefId).
locationRefId int32 Foreign key referencing the physical location where the asset is stored or deployed.
locationName string Readable name of the location (resolved from LocationRefId).
notes string Text area for notes.
latitude double Latitude coordinate where the audit was performed. Null when GPS wasn't recorded.
longitude double Longitude coordinate where the audit was performed. Null when GPS wasn't recorded.
AssetHistory Object

Represents a single audit-trail entry recorded against an asset.

Field Type Required Nullable Default Description
historyRefId int32 Yes No - Unique identifier (primary key) for the history entry.
historyOn date-time Yes No - Datetime (UTC) when the history event occurred.
event string No Yes - Type of event that occurred (e.g., Created, Updated, Deleted).
historyDetails [HistoryDetail(Object)] No Yes - Collection of field-level changes recorded for this history event.
addedByRefGuid string Yes No - GUID reference of the user who performed the action.
eventTrackingRefId int32 No Yes - Foreign key referencing the events tracking record this history entry is linked to. Null when the entry isn't tied to an event (e.g., checkout, check-in, lease).
reserveAssetRefId int32 No Yes - Foreign key referencing the reservation this history entry is linked to. Null when the entry isn't tied to a reservation.
warrantyRefId int32 No Yes - Foreign key referencing the warranty this history entry is linked to. Null when the entry isn't tied to a warranty.
maintenanceRefId int32 No Yes - Foreign key referencing the maintenance record this history entry is linked to. Null when the entry isn't tied to a maintenance record.
AssetHistoryListRequest Object

Request model for fetching asset history details.

Field Type Required Nullable Default Description
sortOrder SortOrder (Enum) No No - The sorting direction for the result set. Default: "Desc" Allowed values: Asc, Desc.
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed range: 1-100.
fromDate date No Yes - The start date for filtering asset history records. Returns records on or after this date. Format: "yyyy-MM-dd". Example: 2025-04-01.
toDate date No Yes - The end date for filtering asset history records. Returns records on or before this date. Format: "yyyy-MM-dd". Example: 2025-04-30.
AssetListRequest Object

Request model for filtering, sorting, and paginating asset records.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter assets by defined asset search fields. Maximum length: 100 characters.
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith.
searchFields [DataFields(Enum)] No Yes - Asset fields that searchKeyword is matched against. Always provide at least one field (or searchCustomFields) when using searchKeyword; if neither is provided, searchKeyword is not applied. Allowed values: AssetTagId, Description, Brand, Model, SerialNo, PurchaseFrom.
searchCustomFields [integer] No No - Defines which asset custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES.
categoryRefId int32 No Yes - Unique identifier (primary key) of the category to filter by. Pass 0 to filter unassigned categories.
subCategoryRefId int32 No Yes - Unique identifier (primary key) of the subcategory to filter by. If provided, categoryRefId must also be specified. Pass 0 to filter unassigned subcategories.
siteRefId int32 No Yes - Unique identifier (primary key) of the site to filter by. Pass 0 to filter unassigned sites.
locationRefId int32 No Yes - Unique identifier (primary key) of the location to filter by. If provided, siteRefId must also be specified. Pass 0 to filter unassigned locations.
departmentRefId int32 No Yes - Unique identifier (primary key) of the department to filter by. Pass 0 to filter unassigned departments.
personRefId int32 No No - Unique identifier (primary key) of the assigned person to filter by.
customerRefId int32 No No - Unique identifier (primary key) of the assigned customer to filter by.
eventTypes [EventType(Enum)] No Yes - Filters assets by the specified event types. Selecting "Custom" includes all user-defined custom events.
orderBy DataField (Enum) No No - The field to order results by. Allowed values: AssetTagId, Description, Brand, Model, SerialNo, PurchaseDate, PurchaseFrom, InitialCost, DateCreated, CreatedBy, CategoryName, SubCategoryName, SiteName, LocationName, DepartmentName, isDepreciable, SalvageValue, AssetLife, DepreciationMethodName, DateAcquired, Status, IsLinked, Relation, CurrentCost, PersonName, Notes, Cost, Reservation, EventDate1, EventDate2, LeaseTo.
sortOrder SortOrder (Enum) No No - The sorting direction for the result set. Default: "Asc" Allowed values: Asc, Desc.
startDate date No No - The start date for filtering asset records. Format: "yyyy-MM-dd" Example: 2025-04-01.
endDate date No No - The end date for filtering asset records. Format: "yyyy-MM-dd" Example: 2025-04-30.
dateRangeBy DataField (Enum) No No - Defines which date field the filtering should apply to. Ignored if dateRangeByCustomField is provided. Default: "DateCreated" Allowed values: DateCreated, PurchaseDate, DateAcquired.
dateRangeByCustomField int32 No Yes - Defines which custom date field the filter should apply to. Provide the Custom Field ID to enable the dateRangeByCustomField filter, which takes precedence over dateRangeBy when set. Requires startDate and endDate to also be provided.
fetchCategoryName boolean No No False Whether to include category name in the result. Default: "false".
fetchSubCategoryName boolean No No False Whether to include subcategory name in the result. Default: "false".
fetchSiteName boolean No No False Whether to include site name in the result. Default: "false".
fetchLocationName boolean No No False Whether to include location name in the result. Default: "false".
fetchDepartmentName boolean No No False Whether to include department name in the result. Default: "false".
fetchEvent boolean No No False Whether to include the current event associated with each asset in the response. Default: false. Also controls whether Status, EventRefId, and Event are populated on each returned asset — all three are null when this is false, regardless of the asset's actual state.
fetchReservation boolean No No False Whether to include the current reservation associated with each asset in the response. Default: false.
fetchCustomFields boolean No No False Whether to include custom fields in the result. Default: "false".
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed range: 1-100.
AssetMaintenance Object

Represents a maintenance record associated with an asset.

Field Type Description
refId int32 Unique identifier (primary key) of the maintenance.
assetRefId int32 Unique identifier (primary key) of the asset.
title string Title of the maintenance.
details string Details of the maintenance.
dueDate date Date when maintenance is due.
maintenanceBy string Person doing maintenance.
status MaintenanceStatus (Enum) System field to show current status of the maintenance.
cost double Total cost spent on this maintenance.
dateCompleted date Date when maintenance is completed.
repeating boolean Indicates whether this maintenance repeats on a recurring schedule.
frequency Frequency (Enum) How often the maintenance recurs: Daily, Weekly, Monthly, or Yearly. Only applies when repeating is true; null when repeating is false.
recurEvery int32 The recurrence interval, whose meaning depends on frequency: null for Daily (not used); for Weekly this is the number of weeks between occurrences (e.g. 2 = every 2 weeks); for Monthly this is the number of months between occurrences (e.g. 3 = every 3 months); for Yearly this is the month of the year the maintenance recurs in (1 = January ... 12 = December). Also null when repeating is false.
recurOn int32 The day the maintenance recurs on within the interval set by recurEvery, whose meaning depends on frequency: null for Daily (not used); for Weekly this is the day of the week (0 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday); for Monthly this is the day of the month (1-31); for Yearly this is the day of the month within the month set by recurEvery (1-31). Also null when repeating is false.
recurredFromRefId int32 Unique identifier (RefId) of the previous maintenance record this one was automatically generated from, when that previous record was repeating and its status was set to Completed or Cancelled. Null if this record was not created by the recurrence engine.
isNextRecurrenceCreated boolean Indicates whether the next-occurrence maintenance record has already been generated from this one (happens once, when repeating is true and status is set to Completed or Cancelled). Once true, setting status to Completed or Cancelled again will not create another follow-up record, preventing duplicates.
customFieldValues [CustomFieldValue(Object)] A collection of custom field values associated with this maintenance. May be null if no custom fields are defined.
AssetReservation Object

Represents reservation details for an asset.

Field Type Description
refId int32 Unique identifier (primary key) for the reservation.
assetRefId int32 Unique identifier (primary key) for the asset.
startTime date-time Reservation start date and time. Whether the returned value includes a time component is determined by the utc property.
endTime date-time Reservation end date and time. Whether the returned value includes a time component is determined by the utc property.
reserveTo string Display name of the person or entity the asset is reserved for (e.g., person name, customer name, or site/location name).
personEmail string Email address the reservation confirmation is sent to. Only set when the reservation is assigned to a person or customer; null otherwise.
assignTo AssignTo (Enum) Indicates whether the reservation is assigned to a person, a customer, or a site/location.
personRefId int32 Foreign key referencing the person the asset is reserved for.
customerRefId int32 Foreign key referencing the customer the asset is reserved for.
siteRefId int32 Foreign key referencing the site the asset is reserved for.
locationRefId int32 Foreign key referencing the location the asset is reserved for.
notes string Additional notes for the reservation.
addedByRefGuId string Unique GUID of the user who added the reservation.
dateAdded date-time Date and time when the reservation record was added to the system.
emailSent boolean Indicates whether the reservation confirmation email has been sent.
firstReminderEnabled boolean Indicates whether the first reminder is enabled for this reservation.
firstReminderLeadTimeDays int32 How many days before the reservation start time the first reminder is sent. Only applies when firstReminderEnabled is true.
secondReminderEnabled boolean Indicates whether the second reminder is enabled for this reservation.
secondReminderLeadTimeDays int32 How many days before the reservation start time the second reminder is sent. Only applies when secondReminderEnabled is true.
utc boolean Indicates whether startTime and endTime are stored in UTC format.
AssetSetting Object

Represents configuration settings for asset fields, including visibility (enabled/disabled), validation rules (required).

Field Type Default Description
field_AssetTagID_Enabled boolean True Indicates whether Asset Tag ID is enabled.
field_AssetTagID_Required boolean True Indicates whether Asset Tag ID is required.
field_AssetDescription_Enabled boolean True Indicates whether Asset Description is enabled.
field_AssetDescription_Required boolean True Indicates whether Asset Description is required.
field_PurchaseDate_Enabled boolean True Indicates whether Purchase Date is enabled.
field_PurchaseDate_Required boolean False Indicates whether Purchase Date is required.
field_Cost_Enabled boolean True Indicates whether Cost is enabled.
field_Cost_Required boolean False Indicates whether Cost is required.
field_PurchasedFrom_Enabled boolean True Indicates whether Purchased from is enabled.
field_PurchasedFrom_Required boolean False Indicates whether Purchased from is required.
field_Brand_Enabled boolean True Indicates whether Brand is enabled.
field_Brand_Required boolean False Indicates whether Brand is required.
field_Model_Enabled boolean True Indicates whether Model is enabled.
field_Model_Required boolean False Indicates whether Model is required.
field_SerialNo_Enabled boolean True Indicates whether Serial No is enabled.
field_SerialNo_Required boolean False Indicates whether Serial No is required.
AssetWarranty Object

Represents a warranty associated with an asset.

Field Type Description
refId int32 Unique identifier (primary key) of the warranty.
assetRefId int32 Unique identifier (primary key) of the asset.
length int32 Length of the warranty (in months).
expiryDate date Date when warranty expires.
notes string Text area for notes.
addedByRefGuId string Unique GUID of the User who added warranty.
customFieldValues [CustomFieldValue(Object)] A collection of custom field values associated with this warranty. May be null if no custom fields are defined.
AssignTo Enum

Defines the type of entity that a record can be assigned to.

Field Description
Person Assigned to person.
Customer Assigned to Customer.
SiteLocation Assigned to Site/location.
AssociateContractAssetRequest Object

Request model for associating an asset with a contract.

Field Type Required Nullable Default Description
assetRefId [integer] Yes No - Unique identifier (primary key) of the asset to associate with the contract. Maximum 100 items.
AssociateFundAssetRequest Object

Request model for associating an asset with a fund.

Field Type Required Nullable Default Description
assetRefId int32 Yes No - Unique identifier (primary key) of the asset to associate with the fund.
amount double Yes No - Amount to debit from the fund for this asset.
AssociateInsuranceAssetRequest Object

Request model for associating an asset with a insurance.

Field Type Required Nullable Default Description
assetRefId [integer] Yes No - Unique identifier (primary key) of the asset to associate with the insurance. Maximum 100 items.
AuditName Object

Represents an audit associated with an asset.

Field Type Description
refId int32 Unique identifier (primary key) of the audit name.
name string Name of the audit.
locked boolean Indicates whether this audit name is locked. When true, assets cannot be audited against this audit name.
assetCount int32 Number of active assets audited under this audit name.
AuditNameRequest Object

Request model for adding/updating an audit name.

Field Type Required Nullable Default Description
name string Yes No - Name of the audit name to create. Must be unique. Cannot exceed 100 characters.
AuthorizeRequest Object

Contains the tokens required to authorize a user in the system.

Field Type Required Nullable Default Description
apiToken string Yes No - The API token used for authenticating requests. Must be between 32 and 2000 characters.
authToken string Yes No - The Auth token used for authenticating requests. Must be between 32 and 2000 characters.
AuthorizeResponse Object

Response returned after a successful attempt, including access token.

Field Type Description
accessToken string The access token issued for authentication. Used to authorize subsequent API requests.
Bin Object

Represents a bin within a shelf in the inventory storage hierarchy. A bin is the lowest level where inventory items are stored. Applicable only when multi-quantiy feature is enabled

Field Type Description
refId int32 Unique identifier (primary key) for the Bin (positive integer only).
name string Bin Name (Bin Name cannot exceed 100 characters.)
BinListRequest Object

Request model for fetching a list of bins. Applicable only when multi-quantiy feature is enabled

Field Type Required Nullable Default Description
aisleRefId int32 No Yes - Unique identifier (primary key) for the Aisle (positive integer only). Leave this field empty to retrieve unallocated locations. Required only when the inventory location hierarchy is configured as Aisle > Shelf > Bin.
shelfRefId int32 No Yes - Unique identifier (primary key) for the Shelf (positive integer only). Leave this field empty to retrieve unallocated locations. Required only when the inventory location hierarchy is configured as Shelf > Bins.
searchKeyword string No Yes - Search keyword to filter bin by name (Search keyword cannot exceed 100 characters.).
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith".
orderBy DataField (Enum) No No - The field to order results by bin name. Default: "Name" Allowed values: "Name".
sortOrder SortOrder (Enum) No No - The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc".
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100.
BulkAudit Object

Result of a bulk audit, listing which assets were audited and which were skipped.

Field Type Description
auditedCount int32 Number of assets that were audited.
skippedCount int32 Number of assets that were skipped.
skippedAssets [SkippedAsset(Object)] Assets that were skipped, each with the reason it was skipped.
BulkAuditRequest Object

Request model for auditing multiple assets against one audit name in a single request.

Field Type Required Nullable Default Description
auditNameRefId int32 Yes No - Foreign key referencing the audit name to audit the asset against. Must not be locked.
siteRefId int32 Yes No - Foreign key referencing the site where the audit took place.
locationRefId int32 Yes No - Foreign key referencing the location where the audit took place. Must belong to siteRefId.
notes string No Yes - Text area for notes. (cannot exceed 1000 characters.)
auditDate date-time Yes No - Date and time when the asset was audited. Format: yyyy-MM-ddTHH:mm:ss.
updateAssetLocation boolean Yes No - When true, updates the asset's own site/location to match siteRefId/locationRefId and logs a history entry for the change.
recordGps boolean Yes No - Indicates whether GPS coordinates were captured for this audit.
latitude double No Yes - Latitude coordinate where the audit was performed. Required when recordGps is true.
longitude double No Yes - Longitude coordinate where the audit was performed. Required when recordGps is true.
assetRefIds [integer] Yes No - Collection of asset unique identifiers (RefIds) to audit. Maximum 100 items. Assets that are inactive, not found, outside your access, or already audited under auditNameRefId are skipped.
Category Object

Represents a high-level classification for assets and/or inventory items.

Field Type Description
refId int32 Unique identifier (primary key) for the category (positive integer only).
name string Category Name (Category name cannot exceed 50 characters.)
subCategories [SubCategory(Object)] A collection of subcategories associated with this entity. May be empty if none are defined.
CategoryListRequest Object

Request model for fetching a list of categories.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter categories by name (Search keyword cannot exceed 100 characters.).
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith".
orderBy DataField (Enum) No No - The field to order results by category name. Default: "Name" Allowed values: "Name".
sortOrder SortOrder (Enum) No No - The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc".
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100.
Contract Object

Field Type Description
refId int32 Unique identifier (primary key) of the contract or license.
contractTitle string Title or name of the contract or license.
description string Additional details or notes about the contract or license.
hyperlink string Website URL or hyperlink associated with the contract or license.
contractNo string Contract or license number assigned by the vendor or provider.
vendor string Name of the vendor associated with the contract.
contactPerson string Name of the primary contact person for the contract or license.
phone string Phone number of the contract or license contact person.
cost double Cost of the contract or license.
startDate date Start date of the contract or license.
endDate date End date or expiration date of the contract or license. Always null when NoEndDate is true.
licenseCount int32 Number of licenses covered by the contract.
noEndDate boolean Indicates whether the contract has no expiration date.
softwareContract boolean Indicates whether the contract is for software.
active boolean Indicates whether the contract or license is active.
addedByRefGuid string Unique GUID of the user who created the contract record.
customFieldValues [CustomFieldValue(Object)] A collection of custom field values associated with the contracts. May be null if no custom fields are defined.
ContractAssetLinked Object

Represents an asset linked to a contract.

Field Type Description
refId int32 Unique identifier (primary key) of the asset-contract link record.
assetRefId int32 Unique identifier (primary key) for the asset.
contractRefId int32 Unique identifier (primary key) for the contract.
ContractListRequest Object

Query parameters for the Get Contracts list endpoint.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter contracts. Maximum length: 100 characters.
searchType SearchType (Enum) No No - Defines how the search text is matched. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith.
searchFields [DataFields(Enum)] No Yes [ContractNo] Defines which contract fields are searched. Default: "ContractNo" Allowed values: ContractNo, Description, PersonName, Title, Phone, Vendor.
searchCustomFields [integer] No No - Defines which contract custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES.
orderBy DataField (Enum) No No - The field to sort results by. Default: "ContractNo" Allowed values: Title, Description, PersonName, Phone, Hyperlink, ContractNo, ContractCost, Vendor, License, IsSoftware, StartDate, EndDate, CreatedBy.
sortOrder SortOrder (Enum) No No - The sorting direction. Default: "Asc" Allowed values: Asc, Desc.
fetchCustomFields boolean No No False Whether to include custom fields in the result. Default: "false".
startDate date No No - The start date for filtering contract records. Format: "yyyy-MM-dd" Example: 2025-04-01.
endDate date No No - The end date for filtering contract records. Format: "yyyy-MM-dd" Example: 2025-04-30.
dateRangeBy DataField (Enum) No No - Defines which date field the filtering should apply to. Ignored if dateRangeByCustomField is provided. Default: "EndDate" Allowed values: StartDate, EndDate.
dateRangeByCustomField int32 No Yes - Defines which custom date field the filter should apply to. Provide the Custom Field ID to enable the dateRangeByCustomField filter, which takes precedence over dateRangeBy when set. Requires startDate and endDate to also be provided.
offset int32 No No 0 The number of records to skip. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed range: 1-100.
ContractSetting Object

Represents configuration settings for contract fields, including visibility (enabled/disabled), validation rules (required).

Field Type Default Description
field_ContractTitle_Enabled boolean True Indicates whether Title of Contract is enabled.
field_ContractTitle_Required boolean True Indicates whether Title of Contract is required.
field_Description_Enabled boolean True Indicates whether Description of the contract is enabled.
field_Description_Required boolean False Indicates whether Description of the contract is required.
field_Hyperlink_Enabled boolean True Indicates whether HyperLink of Contract is enabled.
field_Hyperlink_Required boolean False Indicates whether HyperLink of Contract is required.
field_ContractNo_Enabled boolean True Indicates whether Contract No. is enabled.
field_ContractNo_Required boolean False Indicates whether Contract No. is required.
field_Cost_Enabled boolean True Indicates whether Cost of Contract is enabled.
field_Cost_Required boolean False Indicates whether Cost of Contract is required.
field_StartDate_Enabled boolean True Indicates whether Start Date of Contract is enabled.
field_StartDate_Required boolean True Indicates whether Start Date of Contract is required.
field_EndDate_Enabled boolean True Indicates whether End Date of Contract is enabled.
field_EndDate_Required boolean True Indicates whether End Date of Contract is required.
field_NoEndDate_Enabled boolean True Indicates whether No End Date is enabled.
field_Vendor_Enabled boolean False Indicates whether Vendor is enabled.
field_ContractPerson_Enabled boolean True Indicates whether Contact Person is enabled.
field_ContractPerson_Required boolean False Indicates whether Contact Person is required.
field_Phone_Enabled boolean True Indicates whether Phone number is enabled.
field_Phone_Required boolean False Indicates whether Phone number is required.
field_NoOfLicenses_Enabled boolean True Indicates whether No. of Licenses is enabled.
field_NoOfLicenses_Required boolean False Indicates whether No. of Licenses is required.
field_IsSoftware_Enabled boolean True Indicates whether Is Contract a Software is enabled.
Country Object

Represents a country available in the system for address and region configuration.

Field Type Description
refId int32 Unique identifier (primary key) for the country.
countryName string Full name of the country (e.g., United States).
Currency Object

Represents a currency available for financial configuration.

Field Type Description
refId int32 Unique identifier (primary key) for the currency.
name string Full name of the currency (e.g., United States Dollar).
code string ISO 4217 currency code (e.g., USD).
uniCode string Unicode symbol for the currency (e.g., $).
Customer Object

Represents a customer details, containing identifying information, contact details, and references to related entities.

Field Type Description
refId int32 Unique identifier (primary key) for the customer (positive integer only).
name string Customer Name (name cannot exceed 100 characters.)
company string Company name of the customer. (company cannot exceed 100 characters.)
address1 string Address1 of the customer. (address1 cannot exceed 250 characters.)
address2 string Address2 of the customer. (address2 cannot exceed 250 characters.)
city string City of the customer (city cannot exceed 50 characters.)
state string State of the customer. (state cannot exceed 50 characters.)
zip string Zip of the customer. (zip cannot exceed 50 characters.)
countryRefId int32 Foreign key referencing the country.
countryName string Readable name of the country (resolved from CountryRefId).
phone string Phone number of the customer. (phone cannot exceed 50 characters.)
cell string Cell number of the customer. (cell cannot exceed 50 characters.)
email string Email of the customer. (email cannot exceed 70 characters.)
addedByRefGuid string Unqiue GUID referencing the user who created or manages this customer.
notes string Notes or Comment (notes cannot exceed 2000 characters.)
customFieldValues [CustomFieldValue(Object)] A collection of custom field values associated with the customer. May be null if no custom fields are defined.
CustomerListRequest Object

Request model for fetching a list of customers.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter customer by name (cannot exceed 100 characters).
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains". Allowed values: "Contains", "Exact", "StartWith", "EndsWith".
searchFields [DataFields(Enum)] No Yes [Name, Email, Phone, Company] Defines which customers fields can be searched. Default: "Name", "Email", "Phone", "Company" Allowed values: Name, Email, Phone, Company.
searchCustomFields [integer] No No - Defines which customer custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES.
orderBy DataField (Enum) No No - The field to order results by. Default: "Name". Allowed values: Name, Company, Address1, Address2, City, State, Zip, Country, Phone, Cell, Notes, Email, CreatedBy.
sortOrder SortOrder (Enum) No No - The sorting direction (Ascending or Descending). Default: "Asc".
fetchCustomFields boolean No No False Whether to include custom fields in the result. Default: false.
offset int32 No No 0 The number of records to skip before returning results. Default: 0.
limit int32 No No 20 The maximum number of records to return. Default: 20. Must be between 1 and 100.
CustomerSetting Object

Represents configuration settings for Customer fields, including visibility (enabled/disabled), validation rules (required), and uniqueness constraints for key identifiers such as Full Name and Email.

Field Type Default Description
field_FullName_Enabled boolean True Indicates whether Full name of the customer is enabled.
field_FullName_Required boolean False Indicates whether Full name of the customer is required.
field_Email_Enabled boolean True Indicates whether Email of the customer is enabled.
field_Email_Required boolean False Indicates whether Email of the customer is required.
field_Company_Enabled boolean True Indicates whether Customer's company name is enabled.
field_Company_Required boolean False Indicates whether Customer's company name is required.
field_Address_Enabled boolean True Indicates whether All address fields of the customer is enabled.
field_Address_Required boolean False Indicates whether All address fields of the customer is required.
field_Phone_Enabled boolean True Indicates whether Phone number of the customer is enabled.
field_Phone_Required boolean False Indicates whether Phone number of the customer is required.
field_MobilePhone_Enabled boolean True Indicates whether Mobile Cell of the customer is enabled.
field_MobilePhone_Required boolean False Indicates whether Mobile Cell of the customer is required.
field_Notes_Enabled boolean True Indicates whether Text area for notes is enabled.
field_Notes_Required boolean False Indicates whether Text area for notes is required.
field_FullName_Unique boolean True Specifies whether Full Name serves as the unique identifier. When false, Email is used as the unique identifier instead.
CustomEventSetting Object

Represents the configuration of a single custom event (e.g. "Retired", "End of Life"), identified by AssetTigerAPI.Models.CustomEventSetting.RefId, including its display name, description, icon/color, and which optional fields (dates, text, currency, boolean, notes, person, customer, site/location, signature) are enabled and/or required for that event.

Field Type Default Description
refId int32 - Unique identifier (primary key) for the custom event.
eventName string - Event Name. For example, 'Retired', 'End of Life', etc.
eventDescription string - Event Description.
eventIcon string - Name of the icon assigned to this custom event, used for display purposes in the UI.
eventIconClass string - Name of the icon class assigned to this custom event, used for display purposes in the UI.
eventColor string - Name of the color assigned to this custom event, used for display purposes in the UI.
eventColorCode string - Name of the color code assigned to this custom event, used for display purposes in the UI.
field_Event_Enabled boolean True Indicates whether Event is enabled.
field_Date1_Enabled boolean False Indicates whether Date 1 is enabled. 'Date 1' typically represents the day when the event takes place. example: Check out date
field_Date1_Required boolean False Indicates whether Date 1 is required.
field_Date1_Time_Enable boolean False Indicates whether Date 1 Time is enabled.
field_Date1_Label string - Date 1 Label.
field_Date2_Enabled boolean False Indicates whether Date 2 is enabled. If you expect the user to return the assets by a specific due date, utilize 'Date 2' for that purpose. example: Due date
field_Date2_Required boolean False Indicates whether Date 2 is required.
field_Date2_Time_Enable boolean False Indicates whether Date 2 Time is enabled.
field_Date2_Label string - Date 2 Label.
field_Text_Enabled boolean False Indicates whether Text field is enabled. The text field can hold text up to 100 characters long.
field_Text_Required boolean False Indicates whether Text field is required.
field_Text_Label string - Text field Label.
field_Currency_Enabled boolean False Indicates whether Currency is enabled. Use the field to enter an amount. The currency symbol will be as defined in the company setup. example: Amount spent
field_Currency_Required boolean False Indicates whether Currency is required.
field_Currency_Label string - Currency Label.
field_Boolean_Enabled boolean False Indicates whether Boolean is enabled. A boolean field will present a radio button to allow the user to select either 'Yes' or 'No'. Please enter your question in the Customize Label section. example: Is the asset functioning properly?
field_Boolean_Label string - Boolean Label.
field_Notes_Enabled boolean False Indicates whether Notes is enabled. A text area for the user to enter notes up to 1000 characters in length.
field_Notes_Required boolean False Indicates whether Notes is required.
field_Notes_Label string - Notes Label.
field_Person_Enabled boolean False Indicates whether List of Persons is enabled. Assets are generally 'checked out' or 'assigned to' individuals. Individuals should be entered in the "Advanced > Persons/Employees" table.
field_Person_Required boolean False Indicates whether List of Persons is required.
field_Customer_Enabled boolean False Indicates whether List of Customer is enabled. Assets are generally 'leased' to customers. Customers should be entered in the "Advanced > Customers" table.
field_Customer_Required boolean False Indicates whether List of Customer is required.
field_SiteLocation_Enabled boolean False Indicates whether List of Sites/Locations is enabled. Assets can also be assigned to "Sites/Locations." For instance, a projector or TV can be assigned to a conference room.
field_SiteLocation_Required boolean False Indicates whether List of Sites/Locations is required.
field_Signature_Enable boolean False Indicates whether Signature pad is enable for the user to sign.
field_Signature_Required boolean False Indicates whether Signature is required.
field_SignatureDisclaimer_Text string - Disclaimer text displayed above the signature pad when field_Signature_Enable is true.
field_IsReturnEvent boolean False Indicates whether Event is Return Event. Event that involve the user returning the asset are categorized as "Return Event." These events require both a primary event and a return event.
primary_CustomRefId int32 - Foreign key referencing the primary custom event this return event is linked to. Populated only when field_IsReturnEvent is true; null otherwise.
CustomField Object

Defines a customizable field that can be attached to entities like assets, inventory items, persons contacts, warranties etc. Includes type, label, and options.

Field Type Description
refId int32 Unique identifier (primary key) for the custom field.
label string Label of the custom field.
fieldType FieldType (Object) Defines the type of a custom field (e.g., Text, Number, Date, Boolean) and whether it supports a predefined list of values.
isRequired boolean Indicates whether this value is required. Returns true if required; otherwise, false.
hasSelectedCategories boolean Indicates whether this custom field is limited to specific categories (true) or applies to all categories (false). Applicable for Asset/Inventory Custom Fields only.
options [string] Collection of available options. Applicable for field types such as DropdownList, RadioButtonList, and CheckBoxList.
customFieldCategories string Comma-separated list of category RefIds this custom field is limited to. Applicable for Asset/Inventory Custom Fields only.
counter int32 The next number that will be auto-generated for this field. Applicable only for the NumericAutoIncrement field type, on Asset/Inventory Custom Fields only.
CustomFieldRequest Object

Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.

Field Type Required Nullable Default Description
customFieldId int32 Yes No - Unique identifier of the custom field.
customFieldValue string Yes No - Value provided for the custom field. Format varies by field type: Text = string; Number/Currency = numeric value; Date = yyyy-MM-dd; DateTime = yyyy-MM-dd HH:mm:ss; Dropdown/Radio = one allowed option; Checkbox List = comma-separated allowed option values (e.g., '1,3,5').
CustomFieldValue Object

Stores the value of a CustomField for a specific entity. Links to the corresponding custom field definition.

Field Type Description
refId int32 Unique identifier (primary key) for the custom field value.
customFieldRefId int32 Foreign key referencing the custom field.
value string value of the custom field.
customField CustomField (Object) Defines a customizable field that can be attached to entities like assets, inventory items, persons contacts, warranties etc. Includes type, label, and options.
DataField Enum

Represents the different data fields.

Field Description
Name Name of the record (e.g., item, asset, category, person, customer, site, or fund).
InventoryTagId Unique tag or code assigned to the inventory item for tracking.
AssetTagId Unique tag or code assigned to the asset for tracking.
Description Detailed description of the record (e.g., item, asset, fund, or document).
Unit Unit of measurement (e.g., piece, box, kg, liter).
Stock Current available stock quantity of the item.
Notes Additional notes or remarks.
SKU Stock Keeping Unit – unique identifier used for managing stock.
Size Size or dimensions of the item.
Color Color of the item.
Style Style or variant of the item (if applicable).
Brand Brand name of the item.
SerialNo Serial No of the asset.
Model Model name/number of the item.
Vendor Supplier or vendor associated with the item.
Url Reference URL (e.g., vendor page, product page, or documentation).
MinQty Minimum quantity threshold for stock (used for re-order alerts).
MaxQty Maximum quantity limit for stock (used for inventory control).
CreatedBy Name of the user who created the record.
DateCreated Datetime (UTC) when the item was added.
CategoryName Readable name of the main category.
SubCategoryName Readable name of the main subcategory.
EmpID Employee Id.
Title Title.
Email Email address.
Phone Phone number.
Company Company name.
Address1 Primary address.
Address2 Secondary address.
City City name.
State State or region.
Zip ZIP or postal code.
Country Country name.
Cell Cell.
PersonName Name of the person associated with the record (e.g., an asset's current event, an insurance policy, or a contract).
FundAmount Total allocated amount for a fund.
StartDate The date when the record or activity starts.
EndDate The date when the record or activity ends.
TotalDebits Total debits linked to a fund.
AssetCount Number of assets linked to a record.
InsuranceCo Name of the insurance company.
Policy Insurance policy number or identifier.
Coverage Type of insurance coverage provided.
Limits Coverage limits or maximum claim amount.
Hyperlink Website URL or hyperlink associated with the contract or license.
ContractNo Contract or license number assigned by the vendor or provider.
ContractCost Cost of the contract or license.
License Number of licenses covered by the contract.
IsSoftware whether the contract is for software.
PurchaseDate Purchase Date.
PurchaseFrom Purchase From.
SiteName Site Name.
LocationName Location Name.
DepartmentName Department Name.
DepreciationMethodName Depreciation Method.
DateAcquired Date Acquired.
isDepreciable Is Depreciable.
InitialCost Initial Cost.
CurrentCost Current Cost.
AssetLife Asset Life.
SalvageValue Salvage Value.
Status Status.
IsLinked Is Linked.
Relation Relation.
ExpiryDate Expiration Date.
Details Maintenance Details.
MaintenanceBy Maintenance By.
DueDate Due Date.
WarrantyLength Warranty Length.
WarrantyNotes Warranty Notes.
DateCompleted Date Completed.
Cost Original purchase price of the asset at the time of acquisition.
Reservation Start time of the asset's next upcoming or current reservation.
EventDate1 Primary event date (e.g., checkout date, lease start, repair start) of the asset's current event.
EventDate2 Secondary event date (e.g., due date, end date, return date) of the asset's current event.
LeaseTo Name of the customer this asset is currently leased to. Populated only when the asset's current event is a lease event with a customer attached.
MaintAssignedTo Person assigned to a maintenance record.
MaintDetail Detail text of a maintenance record.
MaintTitle Title of a maintenance record.
MaintStatus Status of a maintenance record.
Repeating Whether a maintenance record repeats.
RepairCost Repair cost of a maintenance record.
Frequency Recurrence frequency of a maintenance record.
RecurOn1 First recurrence value of a maintenance record.
RecurOn2 Second recurrence value of a maintenance record.
WarrantyCreatedBy User who created a warranty record.
DateFormat Object

Represents a date display format available for user and configuration.

Field Type Description
refId int32 Unique identifier (primary key) for the date format.
name string Display name of the date format (e.g., MM/DD/YYYY).
format string Date format pattern string used for formatting (e.g., MM/dd/yyyy).
example string Example date rendered using this format (e.g., 12/31/2025).
DeleteMaintenanceRequest Object

Request model for deleting a maintenance.

Field Type Required Nullable Default Description
refId int32 Yes No - Unique identifier (primary key) of the maintenance.
assetRefId int32 Yes No - Unique identifier (primary key) of the asset the maintenance belongs to.
DeleteWarrantyRequest Object

Request model for deleting a warranty.

Field Type Required Nullable Default Description
refId int32 Yes No - Unique identifier (primary key) of the warranty.
assetRefId int32 Yes No - Unique identifier (primary key) of the asset the warranty belongs to.
Department Object

Represents a department to organize assets and/or inventory items more granularly.

Field Type Description
refId int32 Unique identifier (primary key) for the department (positive integer only).
name string Department Name (Department name cannot exceed 50 characters.)
DepartmentListRequest Object

Request model for fetching a list of categories.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter departments by name (Search keyword cannot exceed 100 characters.).
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith".
orderBy DataField (Enum) No No - The field to order results by department name. Default: "Name" Allowed values: "Name".
sortOrder SortOrder (Enum) No No - The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc".
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100.
DepreciationMethod Enum

Represents the supported depreciation methods that can be used to calculate asset depreciation over its useful life.

Field Description
StraightLine Straight Line - Allocates the same amount to each period over time. This is the most popular and easiest to use.
DoubleDecliningBalance Double Declining – Allocates twice as much as straight line in the first half of the asset life, and half as much in the second half. Typically used for tax purposes.
DecliningBalance150Percent 150% Declining – works the same as double declining but just at a 1.5x level of straight line. Again typically used for tax purposes.
SumoftheYearsDigits Sum of year’s digits – Allocates the deprecation based on the fractional calculation of the assets useful life. This accelerates deprecation faster than straight line but lesser than double declining. Typically not used but acceptable for US GAAP purposes.
DecliningBalance Declining Balance – Allocates 1x as much as straight line in the first half of the asset life, and full as much in the second half. Typically used for tax purposes.
Document Object

Represents a document linked to an inventory item.

Field Type Description
documentRefGuid string Unique GUID of the document.
fileType string File type (e.g., PDF, DOCX, JPG).
fileName string Original file name of the document.
description string Description or additional notes for the document.
keywords string Keywords associated with the document for search or filtering.
uploadDate date-time Date and time when the document was uploaded.
uploadedByRefGuid string GUID reference of the user who uploaded the document.
DocumentListRequest Object

Defines the request model for fetching documents list data with filtering, pagination, and sorting options.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter documents by defined document search fields. Maximum length: 100 characters.
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith.
searchFields [DataFields(Enum)] No Yes [Name, Description] Defines which document fields can be searched. Default: "Name", "Description" Allowed values include: Name, Description.
orderBy DataField (Enum) No No - The field to order results by. Allowed values: Name, Description.
sortOrder SortOrder (Enum) No No - The sorting direction for the result set. Default: "Asc" Allowed values: Asc, Desc.
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed range: 1-100.
Event Object

Represents a tracked current event associated with an asset throughout its lifecycle. Event can include checkout, checkin, lease, lease return or any custom event against an asset.

Field Type Description
refId int32 Unique identifier (primary key) for the event record.
eventType EventType (Enum) Represents the type of event recorded against an asset in its lifecycle. Standard events map to built-in asset tracking operations. When a user-defined custom event is recorded, EventTypeName is Custom
assetRefId int32 Foreign key referencing the asset this event is associated with.
customEventRefId int32 Foreign key referencing the custom event definition for this event. Null for standard events.
personRefId int32 Foreign key referencing the person involved in this event.
customerRefId int32 Foreign key referencing the customer associated with this event.
siteRefId int32 Foreign key referencing the site where this event occurred.
locationRefId int32 Foreign key referencing the physical location where this event occurred.
addedByRefGuid string Unique GUID referencing the user who created this event.
date1 date-time Primary event date and time. Represents when the event started (e.g., checkout date, lease start, repair start). Whether the returned value includes a time component is determined by the Utc property.
date2 date-time Secondary event date and time. Represents a due date, end date, or return date depending on the event type (e.g., checkout due date, lease end date). Whether the returned value includes a time component is determined by the Utc property.
dateAdded date-time The date and time (UTC) this event record was created in the system.
personName string Display name of the person, customer, or site/location associated with this event.
notes string Additional notes, comments, or observations recorded for this event.
amount double Monetary amount associated with this event. Can represent repair cost, service fee, insurance payout, or transaction value.
signature string Unique identifier (GUID) of the signature associated with this event.
deductible boolean Indicates whether the amount associated with this event is tax-deductible.
booleanField boolean Boolean value associated with a custom event. This field is only populated for custom events; otherwise, it is null.
textField string Text value associated with a custom event. This field is only populated for custom events; otherwise, it is null.
currencyField double Currency value associated with a custom event. This field is only populated for custom events; otherwise, it is null.
utc boolean Indicates whether Date1 and Date2 are stored in UTC format.
EventListRequest Object

Defines the request model for fetching event list data with pagination options.

Field Type Required Nullable Default Description
orderBy DataField (Enum) No No - The field to order results by. Default: "DateCreated". Allowed values: DateCreated, StartDate, EndDate.
sortOrder SortOrder (Enum) No No - The sorting direction (Ascending or Descending). Default: "Asc".
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed range: 1-100.
EventType Enum

Represents the type of event recorded against an asset in its lifecycle. Standard events map to built-in asset tracking operations. When a user-defined custom event is recorded, EventTypeName is `Custom`.

Field Description
Available Asset was available.
Checkout Asset was checked out to a person or location.
CheckIn Asset was checked back in and returned to available status.
Lease Asset was placed under a lease agreement.
LeaseReturn Asset was returned after a lease agreement ended.
Lost Asset was reported lost or missing.
Found Asset was found after being reported lost.
Repair Asset was sent for repair or maintenance.
Broken Asset was marked as broken or damaged.
Dispose Asset was disposed of (retired or scrapped).
Donate Asset was donated.
Sell Asset was sold.
Custom A user-defined custom event was applied.
FieldType Object

Defines the type of a custom field (e.g., Text, Number, Date, Boolean) and whether it supports a predefined list of values.

Field Type Description
refId int32 Unique identifier (primary key) for the field type .
name string Field type name.
hasList boolean Indicates whether this field type presents a list of predefined options to choose from, such as Dropdown List, Radio Button List, or Checkbox List.
fieldName FieldTypeName (Enum) Field Name
FieldTypeName Enum

Enumerates all possible field types for CustomFields, such as TEXT, NUMERIC, DATE, CURRENCY, etc.

Field Description
TEXT Single line text field
NUMERIC Numeric field
NUMERICAUTOINCREMENT Auto increment numeric field
CURRENCY Currency field
DATE Date only field
DATEANDTIME Date and time field
DROPDOWNLIST Dropdown list field
MEMO Multi-line memo field
EMAIL Email address field
URL URL field
SCANNER Scanner input field
RADIOBUTTONLIST Radio button list
CHECKBOXLIST Checkbox list
GPSCOORDINATES GPS coordinates field
Frequency Enum

Represents how often a repeating maintenance recurs.

Field Description
Daily Recurs every day.
Weekly Recurs every N week(s), on a specific day of the week.
Monthly Recurs every N month(s), on a specific date.
Yearly Recurs every year, on a specific month and date.
Fund Object

Represents a fund record.

Field Type Description
refId int32 Unique identifier (primary key) for the fund.
name string Name of the fund.
description string Description of the fund.
amount double Total allocated amount for this fund.
availableAmount double Amount not yet allocated to assets.
totalDebits double Total amount debited to active assets.
totalAssets int32 Number of active assets linked to this fund.
startDate date Fund start date (yyyy-MM-dd).
endDate date Fund end date (yyyy-MM-dd).
notes string Additional notes about the fund.
active boolean Whether this fund is active.
addedByRefGuid string Unqiue GUID referencing the user who created or manages this fund.
FundAssetLinked Object

Represents an asset linked to a fund.

Field Type Description
refId int32 Unique identifier (primary key) of the asset-fund link record.
assetRefId int32 Unique identifier (primary key) for the asset.
fundRefId int32 Unique identifier (primary key) for the fund.
debitedFromFund double Amount debited from this fund for the asset.
FundListRequest Object

Query parameters for the Get Funds list endpoint.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter funds. Maximum length: 100 characters.
searchType SearchType (Enum) No No - Defines how the search text is matched. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith.
searchFields [DataFields(Enum)] No Yes [Name] Defines which fund fields are searched. Default: "Name" Allowed values: Name, Description, Notes.
orderBy DataField (Enum) No No - The field to sort results by. Default: "EndDate" Allowed values: Name, Description, FundAmount, StartDate, EndDate.
sortOrder SortOrder (Enum) No No - The sorting direction. Default: "Asc" Allowed values: Asc, Desc.
startDate date No No - The start date for filtering fund records. Format: "yyyy-MM-dd" Example: 2025-04-01.
endDate date No No - The end date for filtering fund records. Format: "yyyy-MM-dd" Example: 2025-04-30.
dateRangeBy DataField (Enum) No No - Defines which date field the filter applies to. Default: "EndDate" Allowed values: StartDate, EndDate.
offset int32 No No 0 The number of records to skip. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed range: 1-100.
History Object

Represents a single audit-trail entry recorded against an asset or inventory item.

Field Type Description
historyRefId int32 Unique identifier (primary key) for the history entry.
historyOn date-time Datetime (UTC) when the history event occurred.
event string Type of event that occurred (e.g., Created, Updated, Deleted).
historyDetails [HistoryDetail(Object)] Collection of field-level changes recorded for this history event.
addedByRefGuid string GUID reference of the user who performed the action.
HistoryDetail Object

Represents an history details associated with an asset and inventory item history.

Field Type Description
historyDetailsRefId int32 Unique identifier (primary key) for the history details.
field string Name of the field on which the event was performed.
changeFrom string Previous value of the field before the change.
changeTo string New value of the field after the change.
Image Object

Represents a image linked to an inventory item.

Field Type Description
imageRefGuid string Unique GUID of the image.
url string Public URL where the image is stored or accessible.
thumbnail_64 string Public URL of the 64-pixel thumbnail version of the image.
thumbnail_128 string Public URL of the 128-pixel thumbnail version of the image.
thumbnail_256 string Public URL of the 256-pixel thumbnail version of the image.
fileName string Name of the uploaded image file.
type string Specifies the category or source type of the image (for example, "Your Uploads", "Stock Images", or other upload types).
uploadDate date-time Date and time when the image was uploaded.
uploadedByRefGuid string GUID reference of the user who uploaded the image.
description string Short description or label associated with the image.
keywords string Keywords associated with the image for search or filtering.
isStockImage boolean Indicates whether the image is a stock image.
ImageListRequest Object

Defines the request model for fetching images list data with filtering, pagination, and sorting options.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter images by defined image search fields. Maximum length: 100 characters.
imageType ImageType (Enum) No No - Specifies the image assignment filter to apply. Default: "ShowAll" Allowed values: ShowAll, Assigned, UnAssigned.
isStock boolean No No False fetch stock images. Default: "False"
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed range: 1-100.
ImageType Enum

Specifies the image assignment status used to filter images.

Field Description
Assigned Represents images that are assigned to a record.
UnAssigned Represents images that are not assigned to any record.
ShowAll Represents all images regardless of assignment status.
Insurance Object

Represents a insurance record.

Field Type Description
refId int32 Unique identifier (primary key) for the insurance.
insuranceCo string Name of the insurance company or provider.
description string Additional details or notes about the insurance policy.
person string Name of the primary contact person for the insurance policy.
phone string Contact phone number for the insurance provider or representative.
email string Contact email address for the insurance provider or representative.
policy string Policy number assigned by the insurance provider.
coverage string Coverage details provided by the insurance policy.
limits string Coverage limits or maximum claim amount defined by the policy.
deductible double Deductible amount that must be paid before insurance coverage applies.
premium double Premium amount paid for the insurance policy.
startDate date Policy start date.
endDate date Policy end or expiration date.
active boolean Indicates whether the insurance policy is currently active.
addedByRefGuid string Unqiue GUID referencing the user who created or manages this insurance.
InsuranceAssetLinked Object

Response model containing the insurances linked to an asset.

Field Type Description
refId int32 Unique identifier (primary key) of the asset-insurances link record.
assetRefId int32 Unique identifier (primary key) for the asset.
insuranceRefId int32 Unique identifier (primary key) for the insurance.
InsuranceListRequest Object

Query parameters for the Get Insurances list endpoint.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter insurances. Maximum length: 100 characters.
searchType SearchType (Enum) No No - Defines how the search text is matched. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith.
searchFields [DataFields(Enum)] No Yes [InsuranceCo] Defines which insurance fields are searched. Default: "InsuranceCo" Allowed values: InsuranceCo, Description, PersonName, Policy, Phone, Coverage, Email, Limits.
orderBy DataField (Enum) No No - The field to sort results by. Default: "InsuranceCo" Allowed values: InsuranceCo, Description, PersonName, Phone, Email, Policy, Coverage, Limits, StartDate, EndDate.
sortOrder SortOrder (Enum) No No - The sorting direction. Default: "Asc" Allowed values: Asc, Desc.
startDate date No No - The start date for filtering insurance records. Format: "yyyy-MM-dd" Example: 2025-04-01.
endDate date No No - The end date for filtering insurance records. Format: "yyyy-MM-dd" Example: 2025-04-30.
dateRangeBy DataField (Enum) No No - Defines which date field the filter applies to. Default: "EndDate" Allowed values: StartDate, EndDate.
offset int32 No No 0 The number of records to skip. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed range: 1-100.
InventoryEvent Enum

Defines the types of inventory events that can occur in the system.

Field Description
Opening Initial stock entry when the inventory item is first created.
AddStock Indicates that stock has been added to the inventory (e.g., through purchase or transfer in).
RemoveStock Indicates that stock has been removed from the inventory (e.g., issued, consumed, or transferred out).
Adjustment Represents a manual adjustment made to correct stock discrepancies.
Movement Represents the transfer of stock between inventory storage locations.
InventoryItem Object

Represents a single inventory item in the system, including identification, category, subcategory, stock, and associated custom fields.

Field Type Description
refId int32 Unique identifier (primary key) for the inventory.
inventoryTagId string Unique tag or code assigned to the inventory item for tracking.
description string Detailed description of the inventory item.
addedByRefGuid string Unqiue GUID referencing the user who created or manages this inventory item.
dateAdded date-time Datetime (UTC) when the item was added.
defaultImageRefGuid string Unqiue GUID referencing the primary image record for the inventory item.
defaultImage Image (Object) Represents a image linked to an inventory item.
images [Image(Object)] A collection of all images associated with this item.
documents [Document(Object)] A collection of all documents associated with this item.
categoryRefId int32 Foreign key referencing the main category of the item.
categoryName string Readable name of the main category (resolved from CategoryRefId).
subCategoryRefId int32 Foreign key referencing the main subcategory of the item.
subCategoryName string Readable name of the main subcategory (resolved from SubCategoryRefId).
notes string Additional notes or remarks about the item.
sku string Stock Keeping Unit – unique identifier used for managing stock.
brand string Brand name of the item.
model string Model name/number of the item.
vendor string Supplier or vendor associated with the item.
url string Reference URL (e.g., vendor page, product page, or documentation).
size string Size or dimensions of the item.
color string Color of the item.
style string Style or variant of the item (if applicable).
unit string Unit of measurement (e.g., piece, box, kg, liter).
minQty double Minimum quantity threshold for stock (used for re-order alerts).
maxQty double Maximum quantity limit for stock (used for inventory control).
stock double Current available stock quantity of the item.
customFieldValues [CustomFieldValue(Object)] A collection of custom field values associated with the inventory items. May be null if no custom fields are defined.
InventoryItemHistory Object

Represents a single audit-trail entry recorded against an inventory item.

Field Type Required Nullable Default Description
historyRefId int32 Yes No - Unique identifier (primary key) for the history entry.
historyOn date-time Yes No - Datetime (UTC) when the history event occurred.
event string No Yes - Type of event that occurred (e.g., Created, Updated, Deleted).
historyDetails [HistoryDetail(Object)] No Yes - Collection of field-level changes recorded for this history event.
addedByRefGuid string Yes No - GUID reference of the user who performed the action.
transactionRefId int32 No Yes - Foreign key referencing the inventory transaction this history entry is linked to. Null when the entry isn't tied to a transaction (e.g., item details edited).
InventoryItemHistoryListRequest Object

Request model for fetching inventory item history details.

Field Type Required Nullable Default Description
sortOrder SortOrder (Enum) No No - The sorting direction for the result set. Default: "Desc" Allowed values: Asc, Desc.
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed range: 1-100.
InventoryListRequest Object

Defines the request model for fetching inventory list data with filtering, pagination, and sorting options.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter inventories by defined inventory search fields. Maximum length: 100 characters.
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith.
searchFields [DataFields(Enum)] No Yes [InventoryTagId, Description] Defines which inventory fields can be searched. Default: "InventoryTagId", "Description" Allowed values include: InventoryTagId, Description, Unit, SKU, Brand, Model, Size, Style, Color, Notes, Vendor, Url.
searchCustomFields [integer] No No - Defines which inventory custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES.
categoryRefId int32 No Yes - Unique identifier (primary key) of the category to filter by. Pass 0 to filter unassigned categories.
subCategoryRefId int32 No Yes - Unique identifier (primary key) of the subcategory to filter by. If provided, categoryRefId must also be specified. Pass 0 to filter unassigned subcategories.
stock StockType (Enum) No No - Defines the stock filter for the inventory list. Default: "All" Allowed values: All, Ideal, IdealAndLow, IdealAndOverflow, Low, LowAndOverflow, Overflow.
orderBy DataField (Enum) No No - The field to order results by. Allowed values: InventoryTagId, Description, Unit, Stock, SKU, Brand, Model, Size, Style, Color, Notes, Vendor, Url, MinQty, MaxQty, DateCreated, CreatedBy, CategoryName, SubCategoryName.
sortOrder SortOrder (Enum) No No - The sorting direction for the result set. Default: "Asc" Allowed values: Asc, Desc.
startDate date No No - The start date for filtering inventory records. Format: "yyyy-MM-dd" Example: 2025-04-01.
endDate date No No - The end date for filtering inventory records. Format: "yyyy-MM-dd" Example: 2025-04-30.
dateRangeBy DataField (Enum) No No - Defines which date field the filtering should apply to. Ignored if dateRangeByCustomField is provided. Default: "DateCreated" Allowed values: DateCreated.
dateRangeByCustomField int32 No Yes - Defines which custom date field the filter should apply to. Provide the Custom Field ID to enable the dateRangeByCustomField filter, which takes precedence over dateRangeBy when set. Requires startDate and endDate to also be provided.
fetchCategoryName boolean No No False Whether to include category name in the result. Default: "false".
fetchSubCategoryName boolean No No False Whether to include subcategory name in the result. Default: "false".
fetchCustomFields boolean No No False Whether to include custom fields in the result. Default: "false".
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed range: 1-100.
InventorySetting Object

Represents configuration settings for Inventory module including field visibility, labels, required flags, transaction settings, and auto-tagging rules.

Field Type Default Description
hasInventory boolean False Indicates whether inventory module is enabled.
field_InventoryTagId_Enabled boolean True Indicates whether the Inventory Tag ID field is enabled.
field_InventoryTagId_Label string Inventory Tag ID Display label for Inventory Tag ID field.
field_InventoryTagId_Required boolean True Indicates if Inventory Tag ID is required.
field_Description_Enabled boolean True Indicates whether the Description field is enabled.
field_Description_Label string Description Display label for Description field.
field_Description_Required boolean True Indicates if Description is required.
field_Unit_Enabled boolean True Indicates whether the Unit field is enabled.
field_Unit_Label string Unit Display label for Unit field.
field_Unit_Required boolean True Indicates if Unit is required.
field_Stock_Enabled boolean True Indicates whether the Stock field is enabled.
field_Stock_Label string Stock Display label for Stock field.
field_Stock_Required boolean True Indicates if Stock is required.
field_Notes_Enabled boolean True Indicates whether the Notes field is enabled.
field_Notes_Label string Notes Display label for Notes field.
field_Notes_Required boolean False Indicates if Notes is required.
field_Sku_Enabled boolean False Indicates whether the Sku field is enabled.
field_Sku_Label string SKU Display label for Sku field.
field_Sku_Required boolean False Indicates if Sku is required.
field_Size_Enabled boolean False Indicates whether the Size field is enabled.
field_Size_Label string Size Display label for Size field.
field_Size_Required boolean False Indicates if Size is required.
field_Color_Enabled boolean False Indicates whether the Color field is enabled.
field_Color_Label string Color Display label for Color field.
field_Color_Required boolean False Indicates if Color is required.
field_Style_Enabled boolean False Indicates whether the Style field is enabled.
field_Style_Label string Style Display label for Style field.
field_Style_Required boolean False Indicates if Style is required.
field_Brand_Enabled boolean False Indicates whether the Brand field is enabled.
field_Brand_Label string Brand Display label for Brand field.
field_Brand_Required boolean False Indicates if Brand is required.
field_Model_Enabled boolean False Indicates whether the Model field is enabled.
field_Model_Label string Model Display label for Model field.
field_Model_Required boolean False Indicates if Model is required.
field_Vendor_Enabled boolean False Indicates whether the Vendor field is enabled.
field_Vendor_Label string Vendor Display label for Vendor field.
field_Vendor_Required boolean False Indicates if Vendor is required.
field_VendorWebsite_Enabled boolean False Indicates whether the Vendor Website field is enabled.
field_VendorWebsite_Label string Vendor Website Display label for Vendor Website field.
field_VendorWebsite_Required boolean False Indicates if Vendor Website is required.
field_MinQty_Enabled boolean False Indicates whether the Min. Qty. field is enabled.
field_MinQty_Label string Min. Qty. Display label for Min. Qty. field.
field_MinQty_Required boolean False Indicates if Min. Qty. is required.
field_MaxQty_Enabled boolean False Indicates whether the Max. Qty. field is enabled.
field_MaxQty_Label string Max. Qty. Display label for Max. Qty. field.
field_MaxQty_Required boolean False Indicates if Max. Qty. is required.
field_Transaction_EventDate_Enabled boolean True Indicates whether the Transaction Event Date field is enabled.
field_Transaction_EventDate_Label string Event Date Display label for Transaction Event Date field.
field_Transaction_EventDate_Required boolean True Indicates if Transaction Event Date is required.
field_Transaction_Quantity_Enabled boolean True Indicates whether the Transaction Quantity field is enabled.
field_Transaction_Quantity_Label string Quantity Display label for Transaction Quantity field.
field_Transaction_Quantity_Required boolean True Indicates if Transaction Quantity is required.
field_Transaction_UnitPrice_Enabled boolean False Indicates whether the Transaction Unit Price field is enabled.
field_Transaction_UnitPrice_Label string Unit Price Display label for Transaction Unit Price field.
field_Transaction_UnitPrice_Required boolean False Indicates if Transaction Unit Price is required.
field_Transaction_TotalValue_Enabled boolean False Indicates whether the Transaction Total Value field is enabled.
field_Transaction_TotalValue_Label string Total Value Display label for Transaction Total Value field.
field_Transaction_TotalValue_Required boolean False Indicates if Transaction Total Value is required.
field_Transaction_PoNo_Enabled boolean True Indicates whether the Transaction PO No. field is enabled.
field_Transaction_PoNo_Label string PO No. Display label for Transaction PO No. field.
field_Transaction_PoNo_Required boolean False Indicates if Transaction PO No. is required.
field_Transaction_Notes_Enabled boolean True Indicates whether the Transaction Notes field is enabled.
field_Transaction_Notes_Label string Notes Display label for Transaction Notes field.
field_Transaction_Notes_Required boolean False Indicates if Transaction Notes is required.
person_List_Enabled boolean True Indicates whether the Person/Employee List field is enabled.
customer_List_Enabled boolean False Indicates whether the Customer List field is enabled.
field_TypeName_Enabled boolean False Indicates whether the Type name field is enabled.
signature_Enabled boolean False Indicates whether the Signature Pad is enabled.
field_Event_OpeningBalance_Label string Opening Balance Display label for Opening Balance Event field.
field_Event_AddToStock_Label string Add to Stock Display label for Add to Stock Event field.
field_Event_RemoveFromStock_Label string Remove from Stock Display label for Remove from Stock Event field.
field_Event_StockAdjustment_Label string Stock Adjustment Display label for Stock Adjustment Event field.
field_Location_Enabled boolean False Indicates whether the Inventory Location is enabled.
field_Location_Level LocationLevel (Enum) - Defines location hierarchy level
field_Level_1_Label string Bin Display label for Level 1: Bins. (Bins, Bay, Drawer)
field_Level_1_Required boolean False Indicates if Level 1 is required.
field_Level_2_Label string Shelf Display label for Level 2: Shelf. (Shelf, Rack, Cabinet)
field_Level_2_Required boolean False Indicates if Level 2 is required.
field_Level_3_Label string Aisle Display label for Level 3: Aisle. (Aisle, Warehouse, Site)
field_Level_3_Required boolean False Indicates if Level 3 is required.
autoTagging_Enabled boolean False Indicates whether the Automatic inventory tags is enabled.
nextTagId string - Defines Next generated tag ID.
padding_Enabled boolean False Indicates whether the Padding is enabled.
padding_Digits string 4 Defines Padding Digits.
prefix string - Defines Prefix.
suffix string - Defines Suffix.
nextTagStartingNumber int64 1 Defines Next Inventory Tag Starting Number.
LinkType Enum

Represents the an asset as parent or child.

Field Description
Parent Asset is parent.
Child Asset is child.
Location Object

Represents a locations under a primary sites to organize assets and/or inventory items more granularly.

Field Type Description
refId int32 Unique identifier (primary key) for the location (positive integer only).
name string Location Name (Location name cannot exceed 100 characters.)
siteRefId int32 Foreign key referencing the site.
description string Optional description for the location (cannot exceed 1000 characters).
site Site (Object) Represents a high-level classification for assets and/or inventory items.
LocationLevel Enum

Defines the hierarchical structure of inventory location levels, indicating how locations are organized from top-level to most granular (e.g., Aisle, Shelf, Bins).

Field Description
Level_1 For example Bins
Level_2 For example Shelf > Bins
Level_3 For example Aisle > Shelf > Bins
LocationListRequest Object

Request model for fetching a list of locations.

Field Type Required Nullable Default Description
siteRefId int32 Yes No - Unique identifier (primary key) for the site (positive integer only).
searchKeyword string No Yes - Search keyword to filter locations by name (cannot exceed 100 characters).
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith".
orderBy DataField (Enum) No No - The field to order results by location name. Default: "Name" Allowed values: "Name".
sortOrder SortOrder (Enum) No No - The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc".
fetchSite boolean No No False Whether to include the parent site associated with each location in the result. Default: "false"
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100.
MaintenanceListRequest Object

Request model for filtering, sorting, and paginating maintenance records.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter maintenances by defined search fields. Maximum length: 100 characters.
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith.
searchFields [DataFields(Enum)] No Yes [AssetTagId, Description, Title] Defines which maintenance fields can be searched. Default: "AssetTagId", "Description", "Title". Allowed values include: Title, Details, MaintenanceBy, AssetTagId, Description, PurchaseFrom, Brand, Model, SerialNo.
searchCustomFields [integer] No No - Defines which maintenance custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES.
searchAssetCustomFields [integer] No No - Defines which asset custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES.
categoryRefId int32 No Yes - Unique identifier (primary key) of the category to filter by. Pass 0 to filter unassigned categories.
subCategoryRefId int32 No Yes - Unique identifier (primary key) of the subcategory to filter by. If provided, categoryRefId must also be specified. Pass 0 to filter unassigned subcategories.
siteRefId int32 No Yes - Unique identifier (primary key) of the site to filter by. Pass 0 to filter unassigned sites.
locationRefId int32 No Yes - Unique identifier (primary key) of the location to filter by. If provided, siteRefId must also be specified. Pass 0 to filter unassigned locations.
departmentRefId int32 No Yes - Unique identifier (primary key) of the department to filter by. Pass 0 to filter unassigned departments.
personRefId int32 No No - Unique identifier (primary key) of the assigned person to filter by.
customerRefId int32 No No - Unique identifier (primary key) of the assigned customer to filter by.
eventTypes [EventType(Enum)] No Yes - Filters assets by the specified event types. Selecting "Custom" includes all user-defined custom events.
maintenanceStatus [MaintenanceStatus(Enum)] No Yes - Filters results to only maintenance records with the specified status(es). Allowed values: Scheduled, InProgress, OnHold, Cancelled, Completed. Omit to return records in any status.
orderBy DataField (Enum) No No - The field to order results by. Default: "DueDate". Allowed values: DueDate, DateCompleted, AssetTagId, Description, Brand, Model, SerialNo, PurchaseDate, DateCreated, CreatedBy, MaintAssignedTo, MaintDetail, MaintTitle, MaintStatus, Repeating, RepairCost, Frequency, RecurOn1, RecurOn2, Cost, PurchaseFrom, InitialCost, SiteName, LocationName, CategoryName, SubCategoryName, DepartmentName, isDepreciable, SalvageValue, AssetLife, DepreciationMethodName, DateAcquired, Status, PersonName, LeaseTo, Reservation, EventDate1, EventDate2, Relation, IsLinked, CurrentCost.
sortOrder SortOrder (Enum) No No - The sorting direction for the result set. Default: "Asc" Allowed values: Asc, Desc.
startDate date No No - The start date for filtering maintenance records. Format: "yyyy-MM-dd" Example: 2025-04-01.
endDate date No No - The end date for filtering maintenance records. Format: "yyyy-MM-dd" Example: 2025-04-30.
dateRangeBy DataField (Enum) No No - Defines which date field the filtering should apply to. Ignored if dateRangeByCustomField or dateRangeByAssetCustomField is provided. Default: "DueDate" Allowed values: DueDate, DateCompleted, DateCreated, PurchaseDate, DateAcquired.
dateRangeByCustomField int32 No Yes - Defines which maintenance custom date field the filter should apply to. Provide the maintenance Custom Field ID to enable the dateRangeByCustomField filter, which takes precedence over dateRangeBy when set. Requires startDate and endDate to also be provided.
dateRangeByAssetCustomField int32 No Yes - Defines which asset custom date field the filter should apply to. Provide the asset Custom Field ID to enable this filter, which takes precedence over dateRangeBy and dateRangeByCustomField when set. Requires startDate and endDate to also be provided.
fetchCustomFields boolean No No False Whether to include custom fields in the result. Default: "false".
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed range: 1-100.
MaintenanceRequest Object

Request model for adding or updating an asset maintenance. Contains the associated asset, title, details, due date, assignee, status, cost, completion date, recurrence settings, and optional custom fields.

Field Type Required Nullable Default Description
assetRefId int32 Yes No - Unique identifier (primary key) of the asset to associate with the maintenance.
title string Yes No - Title of the maintenance. (cannot exceed 50 characters.)
details string No Yes - Details of the maintenance. (cannot exceed 1000 characters.)
dueDate date No Yes - Date when maintenance is due. Format: yyyy-MM-dd.
maintenanceBy string No Yes - Person doing maintenance. (cannot exceed 50 characters.)
status MaintenanceStatus (Enum) No Yes - System field to show current status of the maintenance. Allowed values: Scheduled, InProgress, OnHold, Cancelled, Completed.
cost currency No Yes - Total cost spent on this maintenance.
dateCompleted date No Yes - Date when maintenance is completed. Format: yyyy-MM-dd.
repeating boolean No No - Indicates whether this maintenance repeats on a recurring schedule.
frequency Frequency (Enum) No Yes - How often the maintenance recurs. Only applies when repeating is true; null when repeating is false. Allowed values: Daily, Weekly, Monthly, Yearly.
recurEvery int32 No Yes - The recurrence interval, whose meaning depends on frequency: null for Daily (not used); for Weekly this is the number of weeks between occurrences (e.g. 2 = every 2 weeks); for Monthly this is the number of months between occurrences (e.g. 3 = every 3 months); for Yearly this is the month of the year the maintenance recurs in (1 = January ... 12 = December). Also null when repeating is false.
recurOn int32 No Yes - The day the maintenance recurs on within the interval set by recurEvery, whose meaning depends on frequency: null for Daily (not used); for Weekly this is the day of the week (0 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday); for Monthly this is the day of the month (1-31); for Yearly this is the day of the month within the month set by recurEvery (1-31). Also null when repeating is false.
customFieldRequest [CustomFieldRequest(Object)] No Yes - Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.
MaintenanceSetting Object

Represents configuration settings for maintenance fields, including visibility (enabled/disabled) and validation rules (required).

Field Type Default Description
field_Title_Enabled boolean True Indicates whether Title is enabled. Always true — this field cannot be disabled.
field_Title_Required boolean True Indicates whether Title is required. Always true — this field is always required.
field_Details_Enabled boolean False Indicates whether Details is enabled.
field_Details_Required boolean False Indicates whether Details is required.
field_DueDate_Enabled boolean True Indicates whether Due Date is enabled. Always true — this field cannot be disabled.
field_DueDate_Required boolean False Indicates whether Due Date is required.
field_MaintenanceBy_Enabled boolean False Indicates whether Maintenance By is enabled.
field_MaintenanceBy_Required boolean False Indicates whether Maintenance By is required.
field_Status_Enabled boolean True Indicates whether Status is enabled. Always true — this field cannot be disabled.
field_Status_Required boolean False Indicates whether Status is required.
field_Cost_Enabled boolean False Indicates whether Cost is enabled.
field_Cost_Required boolean False Indicates whether Cost is required.
field_DateCompleted_Enabled boolean False Indicates whether Date Completed is enabled.
field_DateCompleted_Required boolean False Indicates whether Date Completed is required.
field_Repeating_Enabled boolean True Indicates whether recurring (repeating) maintenance is enabled. Always true — this field cannot be disabled.
field_Repeating_Required boolean True Indicates whether recurring (repeating) maintenance is required. Always true — this field is always required.
MaintenanceStatus Enum

Represents the status of a maintenance.

Field Description
Scheduled Maintenance has been scheduled but not yet started.
InProgress Maintenance is currently in progress.
OnHold Maintenance has been paused or put on hold.
Cancelled Maintenance was cancelled before completion.
Completed Maintenance has been completed.
MoveSubCategoryRequest Object

Request model for moving a subcategory to another category.

Field Type Required Nullable Default Description
categoryRefId int32 Yes No - Unique identifier (primary key) of the target category to move the subcategory into. Must be a positive integer.
Person Object

Represents a person details, containing identifying information, contact details, and references to related entities such as site, location, and department.

Field Type Description
refId int32 Unique identifier (primary key) for the person (positive integer only).
name string Person Name (person name cannot exceed 100 characters.)
title string Title of the person. (title cannot exceed 100 characters.)
phone string Phone number of the person. (phone cannot exceed 20 characters.)
email string Email of the person. (email cannot exceed 70 characters.)
notes string Notes or Comment (notes cannot exceed 1000 characters.)
empId string EmpId of the person. (notes cannot exceed 50 characters.)
siteRefId int32 Foreign key referencing the site.
siteName string Readable name of the site (resolved from SiteRefId).
locationRefId int32 Foreign key referencing the location.
locationName string Readable name of the location (resolved from LocationRefId).
departmentRefId int32 Foreign key referencing the department.
departmentName string Readable name of the department (resolved from DepartmentRefId).
addedByRefGuid string Unqiue GUID referencing the user who created or manages this person.
customFieldValues [CustomFieldValue(Object)] A collection of custom field values associated with the person. May be null if no custom fields are defined.
PersonListRequest Object

Request model for fetching a list of persons.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter person by name (cannot exceed 100 characters).
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains". Allowed values: "Contains", "Exact", "StartWith", "EndsWith".
searchFields [DataFields(Enum)] No Yes [Name, EmpID, Title, Email, Phone] Defines which person fields can be searched. Default: "Name", "Title", "Email", "Phone", "EmpID" Allowed values: Name, EmpID, Title, Email, Phone.
searchCustomFields [integer] No No - Defines which person custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES.
orderBy DataField (Enum) No No - The field to order results by. Default: "Name". Allowed values: Name, EmpID, Title, Email, Phone, Notes, SiteName, LocationName, DepartmentName, CreatedBy.
sortOrder SortOrder (Enum) No No - The sorting direction (Ascending or Descending). Default: "Asc".
fetchSiteName boolean No No False Whether to include site name in the result. Default: false.
fetchLocationName boolean No No False Whether to include location name in the result. Default: false.
fetchDepartmentName boolean No No False Whether to include department name in the result. Default: false.
fetchCustomFields boolean No No False Whether to include custom fields in the result. Default: false.
offset int32 No No 0 The number of records to skip before returning results. Default: 0.
limit int32 No No 20 The maximum number of records to return. Default: 20. Must be between 1 and 100.
PersonSetting Object

Represents configuration settings for Person fields, including visibility (enabled/disabled), validation rules (required), and uniqueness constraints for key identifiers such as Full Name and Email.

Field Type Default Description
field_FullName_Enabled boolean True Indicates whether Full name of the person / employee is enabled.
field_FullName_Required boolean True Indicates whether Full name of the person / employee is required.
field_Email_Enabled boolean True Indicates whether Email of the person is enabled.
field_Email_Required boolean False Indicates whether Email of the person is required.
field_EmployeeId_Enabled boolean True Indicates whether For example Employee ID, Student ID, etc is enabled.
field_EmployeeId_Required boolean False Indicates whether For example Employee ID, Student ID, etc is required.
field_Title_Enabled boolean True Indicates whether Title of the person is enabled.
field_Title_Required boolean False Indicates whether Title of the person is required.
field_Phone_Enabled boolean True Indicates whether Phone number of the person is enabled.
field_Phone_Required boolean False Indicates whether Phone number of the person is required.
field_Notes_Enabled boolean True Indicates whether Text area for notes is enabled.
field_Notes_Required boolean False Indicates whether Text area for notes is required.
field_Site_Enabled boolean True Indicates whether System field to link person to a Site is enabled.
field_Site_Required boolean False Indicates whether System field to link person to a Site is required.
field_Location_Enabled boolean True Indicates whether System field to link person to a Location is enabled.
field_Location_Required boolean False Indicates whether System field to link person to a Locatio is required.
field_Department_Enabled boolean True Indicates whether System field to link person to a Department is enabled.
field_Department_Required boolean False Indicates whether System field to link person to a Department is required.
field_FullName_Unique boolean True Specifies whether Full Name serves as the unique identifier. When false, Email is used as the unique identifier instead.
Result Enum

Enumerates possible outcomes or statuses of an operation, such as Success, Success, or ErrorOccoured.

Field Description
Success Request completed successfully.
NotFound The requested resource could not be found.
ErrorOccoured An unexpected error occurred during the operation.
AccessDenied Forbidden access denied.
AlreadyAutherized You are already autherized.
TokenExpired Unauthorized access. AuthToken is expired.
MissingToken Invalid or missing/expired Token.
TokenNotfound Token not found or invalid token.
BadRequest Invalid request (e.g., missing or incorrect refId)
Conflict Resource already exists.
InvalidRequest Validation error
NotImplemented Not implemented
NotAllowed Method Not Allowed
TooManyRequests Too many requests. Please try again later.
BadGateway Bad Gateway.
GatewayTimeout Gateway Timeout.
ServiceUnavailable Service temporarily unavailable
InternalServerError Internal Server Error
UnauthorisedAccess Unauthorized access
FeatureDisabled Feature disabled.
PlanLimitReached Subscription plan limit reached.
ScanType Enum

Specifies the type of scanner to be used for barcode or QR code scanning.

Field Description
DefaultScanner Uses the application's built-in default scanner to scan using the device camera. Supports QR Code, 2D Barcode (Data Matrix), Code 39, Code 128, UPC-A, UPC-E, EAN-8, EAN-13, and Code 93.
DeviceScanner Uses the device’s native camera or hardware scanner for scanning.
SearchType Enum

Defines the available search types that can be used in queries.

Field Description
Contains Matches records that contain the specified value anywhere.
Exact Matches records that exactly equal the specified value.
StartWith Matches records that begin with the specified value.
EndsWith Matches records that end with the specified value.
Shelf Object

Represents a shelf within an aisle in the inventory storage hierarchy. A shelf contains one or more bins. Applicable only when multi-quantiy feature is enabled

Field Type Description
refId int32 Unique identifier (primary key) for the Shelf (positive integer only).
name string Shelf Name (Shelf name cannot exceed 100 characters.)
bins [Bin(Object)] A collection of bins associated with this shelves.May be empty if none are defined.
ShelfListRequest Object

Request model for fetching a list of shelves. Applicable only when multi-quantiy feature is enabled

Field Type Required Nullable Default Description
aisleRefId int32 No Yes - Unique identifier (primary key) for the Aisle (positive integer only). Leave this field empty to retrieve unallocated locations. Required only when the inventory location hierarchy is configured as Aisle > Shelf > Bins.
searchKeyword string No Yes - Search keyword to filter shelves by name (Search keyword cannot exceed 100 characters.).
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith".
orderBy DataField (Enum) No No - The field to order results by shelf name. Default: "Name" Allowed values: "Name".
sortOrder SortOrder (Enum) No No - The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc".
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100.
Site Object

Represents a high-level classification for assets and/or inventory items.

Field Type Description
refId int32 Unique identifier (primary key) for the site (positive integer only).
name string Site Name (site name cannot exceed 50 characters.)
address1 string Address1 (address1 cannot exceed 500 characters.)
address2 string Address2 (address2 cannot exceed 500 characters.)
city string City (city cannot exceed 50 characters.)
state string State (state cannot exceed 50 characters.)
zip string Zip (zip cannot exceed 50 characters.)
countryRefId int32 Foreign key referencing the country.
countryName string Readable name of the country (resolved from CountryRefId).
description string Description (description cannot exceed 1000 characters.)
locations [Location(Object)] A collection of locations associated with this entity. May be empty if none are defined.
SiteListRequest Object

Request model for fetching a list of sites.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter sites by name (cannot exceed 100 characters).
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith".
orderBy DataField (Enum) No No - The field to order results by site name. Default: "Name" Allowed values: "Name".
sortOrder SortOrder (Enum) No No - The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc".
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100.
SkippedAsset Object

An asset that was skipped during a bulk operation, with the reason.

Field Type Description
assetRefId int32 Unique identifier (primary key) of the skipped asset.
message string Reason the asset was skipped: already audited under the audit name, or not found (also returned when the asset is inactive or outside your access).
SortOrder Enum

The sorting direction (Ascending or Descending).

Field Description
Asc Sorts results in ascending order.
Desc Sorts results in descending order.
Status Enum

Represents the current lifecycle status of an asset. Standard statuses reflect the outcome of the last event applied to the asset. When a custom event is applied, Status is `Custom`.

Field Description
Available Asset is available and not currently assigned to any event.
Checkout Asset has been checked out to a person or location.
Lease Asset is currently under an active lease agreement.
Lost Asset has been reported lost or missing.
Repair Asset is currently under repair or maintenance.
Broken Asset has been marked as broken or damaged beyond normal use.
Dispose Asset has been disposed of (retired or scrapped).
Donate Asset has been donated.
Sell Asset has been sold.
Custom Asset status reflects a user-defined custom event.
StockSummary Object

Represents the stock quantity held at a single storage location (Aisle/Shelf/Bin) for an inventory item. Only the ref id(s) relevant to the configured inventory location level (Bins / Shelf-Bins / Aisle-Shelf-Bins) are populated; the rest are null.

Field Type Description
aisleRefId int32 Foreign key referencing the aisle. Populated only when inventory location level is configured as Aisle > Shelf > Bins.
shelfRefId int32 Foreign key referencing the shelf. Populated only when inventory location level is configured as Shelf > Bins or Aisle > Shelf > Bins.
binRefId int32 Foreign key referencing the bin. Populated for any inventory location level, since Bins is the lowest level in every configuration.
quantity double Stock quantity held at this location.
StockType Enum

Represents the stock availability classification for inventory items.

Field Description
All Includes all stock types without any filtering.
Ideal Includes items with ideal stock levels (within the desired range).
IdealAndLow Includes items with either ideal or low stock levels.
IdealAndOverflow Includes items with either ideal or overflow (excess) stock levels.
Low Includes items with low stock levels (below the minimum threshold)
LowAndOverflow Includes items with either low or overflow stock levels.
Overflow Includes items with overflow stock levels (above the maximum threshold).
SubCategory Object

Represents a subcategory under a primary category to organize assets and/or inventory items more granularly.

Field Type Description
refId int32 Unique identifier (primary key) for the subcategory (positive integer only).
name string SubCategory Name (SubCategory name cannot exceed 50 characters.)
categoryRefId int32 Foreign key referencing the category.
dateAdded date-time Datetime (UTC) when the sub categories was added.
category Category (Object) Represents a high-level classification for assets and/or inventory items.
SubCategoryListRequest Object

Request model for fetching a list of subcategories.

Field Type Required Nullable Default Description
categoryRefId int32 Yes No - Unique identifier (primary key) for the category (positive integer only).
searchKeyword string No Yes - Search keyword to filter subcategories by name (Search keyword cannot exceed 100 characters.)
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: "Contains", "Exact", "StartWith", "EndsWith".
orderBy DataField (Enum) No No - The field to order results by subcategory name. Default: "Name" Allowed values: "Name".
sortOrder SortOrder (Enum) No No - The sorting direction (Ascending or Descending). Default: "Asc" Allowed values: "Asc", "Desc".
fetchCategory boolean No No False Whether to include category in the result. Default: "false".
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed values: Must be between 1 and 100.
TimeFormat Object

Represents a time display format available for user and configuration.

Field Type Description
refId int32 Unique identifier (primary key) for the time format.
name string Display name of the time format (e.g., 12-Hour).
format string Time format pattern string used for formatting (e.g., hh:mm tt).
example string Example time rendered using this format (e.g., 02:30 PM).
TimeZone Object

Represents a time zone available for user and configuration.

Field Type Description
refId int32 Unique identifier (primary key) for the time zone.
name string Display name of the time zone (e.g., Eastern Standard Time).
gmt string GMT offset label for the time zone (e.g., GMT-05:00).
offset double Numeric UTC offset in hours (e.g., -5.0 for UTC-5).
id string IANA or Windows time zone identifier (e.g., America/New_York).
Transaction Object

Represents a transaction record for inventory item, including details such as event type, quantity, cost, and associated person or customer.

Field Type Description
refId int32 Unique identifier (primary key) for the inventory transaction.
inventoryItemRefId int32 Reference ID of the associated inventory item.
inventoryEvent InventoryEvent (Enum) Type of inventory event (e.g., Added, Removed, Opening, Adjustment).
addedByRefGuid string Unique GUID of the user who added the transaction.
personRefId int32 Reference ID of the person related to the transaction.
customerRefId int32 Reference ID of the customer related to the transaction.
personName string person/customer name related to the transaction.
eventDate date-time Date added by user at the time of the transaction.
refNo string Reference number associated with the transaction.
quantity double Quantity of inventory involved in the transaction.
unitCost double Unit cost of the item at the time of the transaction.
totalCost double Total cost of the transaction (Quantity × UnitCost).
notes string Additional notes or comments related to the transaction.
signature string Unique identifier (GUID) of the signature associated with this transaction.
dateAdded date-time Datetime (UTC) when the transaction record was created in the system.
runningBalance double Running balance after the transaction was processed.
aisle string Aisle name indicating the top-level storage location where the inventory item is placed.
shelf string Shelf name within the specified aisle representing the intermediate storage level.
bin string Bin Name within the specified shelf representing the exact storage position of the item.
transactionSummaries [StockSummary(Object)] Location-wise breakdown of this transaction, one entry per Aisle/Shelf/Bin combination the transaction quantity was split across. Returned only when inventory multi-quantity feature is enabled.
TransactionLocationEntry Object

Represents a single location entry in a multi-quantity inventory transaction. Each entry specifies the quantity allocated to a particular storage location identified by its Aisle, Shelf, and Bins reference IDs. Used within the Locations array of AddTransactionRequest for accounts with stock-location tracking enabled.

Field Type Required Nullable Default Description
aisleRefId int32 No Yes - Reference ID (primary key) of the aisle. Omit or set to 0 when the location level does not include aisles.
shelfRefId int32 No Yes - Reference ID (primary key) of the shelf. Omit or set to 0 when the location level does not include shelves.
binRefId int32 No Yes - Reference ID (primary key) of the bin.
quantity double Yes No - Quantity at this specific location. Must be greater than zero.
TransactionSummary Object

Represents the single storage location (Aisle/Shelf/Bin) and quantity involved in one inventory transaction. Returned only when the inventory Multi-Quantity feature is enabled.

Field Type Required Nullable Default Description
aisleRefId int32 No Yes - Foreign key referencing the aisle. Populated only when inventory location level is configured as Aisle > Shelf > Bins.
shelfRefId int32 No Yes - Foreign key referencing the shelf. Populated only when inventory location level is configured as Shelf > Bins or Aisle > Shelf > Bins.
binRefId int32 No Yes - Foreign key referencing the bin. Populated for any inventory location level, since Bins is the lowest level in every configuration.
quantity double No Yes - Stock quantity held at this location.
UnlinkContractAssetsRequest Object

Request model for unlinking one or more assets from a contract.

Field Type Required Nullable Default Description
assetRefIds [integer] Yes No - One or more asset reference IDs to unlink from the contract. Maximum 100 items.
UnlinkFundAssetsRequest Object

Request model for unlinking one or more assets from a fund.

Field Type Required Nullable Default Description
assetRefIds [integer] Yes No - One or more asset reference IDs to unlink from the fund. Maximum 100 items.
UnlinkInsuranceAssetsRequest Object

Request model for unlinking one or more assets from a insurance.

Field Type Required Nullable Default Description
assetRefIds [integer] Yes No - One or more asset reference IDs to unlink from the insurance. Maximum 100 items.
UpdateAisleRequest Object

Request model for updating aisle. Applicable only when multi-quantiy feature is enabled

Field Type Required Nullable Description
name string Yes No Name of the aisle (Aisle name cannot exceed 100 characters.).
UpdateAssetRequest Object

Request model for update an asset. Contains core item details, category/location assignment, purchase and depreciation information, and optional custom fields.

Field Type Required Nullable Description
assetTagId string Yes No Unique tag identifier assigned to the asset (e.g., barcode or QR code label). Cannot exceed 50 characters.
description string Yes No Detailed description of the asset including its purpose, specifications, or notes. Cannot exceed 1000 characters.
brand string No Yes Brand or manufacturer name of the asset (e.g., Dell, HP, Samsung). Cannot exceed 50 characters.
model string No Yes Model name or number of the asset as specified by the manufacturer. Cannot exceed 50 characters.
serialNo string No Yes Unique serial number assigned by the manufacturer for asset identification and warranty tracking. Cannot exceed 50 characters.
purchaseDate date No Yes The date the asset was purchased. Format: yyyy-MM-dd.
purchaseFrom string No Yes Name of the vendor or supplier from whom the asset was purchased. Cannot exceed 100 characters.
cost currency No Yes Original purchase price of the asset at the time of acquisition.
siteRefId int32 No Yes Foreign key referencing the site or facility where the asset is located.
locationRefId int32 No Yes Foreign key referencing the physical location where the asset is stored or deployed.
categoryRefId int32 No Yes Foreign key referencing the asset's primary category (e.g., IT Equipment, Furniture, Vehicles).
subCategoryRefId int32 No Yes Foreign key referencing the sub-category for more granular asset classification.
departmentRefId int32 No Yes Foreign key referencing the department responsible for or assigned to this asset.
depreciationMethod DepreciationMethod (Enum) No Yes Type of Depreciation Method. Allowed values: StraightLine, DecliningBalance, DecliningBalance150Percent, SumoftheYearsDigits, DoubleDecliningBalance.
dateAcquired date No Yes The date the asset was formally acquired or put into service. Format: yyyy-MM-dd.
isDepreciable boolean No No Indicates whether this asset is subject to depreciation calculations.
initialCost currency No Yes The original value of the asset at the start of its depreciable life.
salvageValue currency No Yes The estimated residual or scrap value of the asset at the end of its useful life.
assetLife int32 No Yes The expected useful lifespan of the asset, in months.
customFieldRequest [CustomFieldRequest(Object)] No Yes Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.
UpdateAuditRequest Object

Request model for updating an asset audit.

Field Type Required Nullable Description
auditNameRefId int32 Yes No Foreign key referencing the audit name to audit the asset against. Must not be locked.
siteRefId int32 Yes No Foreign key referencing the site where the audit took place.
locationRefId int32 Yes No Foreign key referencing the location where the audit took place. Must belong to siteRefId.
notes string No Yes Text area for notes. (cannot exceed 1000 characters.)
updateAssetLocation boolean Yes No When true, updates the asset's own site/location to match siteRefId/locationRefId and logs a history entry for the change.
recordGps boolean Yes No Indicates whether GPS coordinates were captured for this audit.
latitude double No Yes Latitude coordinate where the audit was performed. Required when recordGps is true.
longitude double No Yes Longitude coordinate where the audit was performed. Required when recordGps is true.
UpdateBinRequest Object

Request model for updating bin. Applicable only when multi-quantiy feature is enabled

Field Type Required Nullable Description
aisleRefId int32 No Yes Optional foreign key referencing the aisle. Set null to create an unallocated. Required only when the inventory location hierarchy is configured as Aisle > Shelf > Bins.
shelfRefId int32 No Yes Optional foreign key referencing the shelf. Set null to create an unallocated bin (not assigned to any shelf). Required only when the inventory location hierarchy is configured as Shelf > Bins.
name string Yes No Updated name of the Bin (Bin Name cannot exceed 100 characters.).
UpdateBrokenEventRequest Object

Request model for updating a broken event.

Field Type Required Nullable Description
date1 date-time Yes No Date the asset was found broken. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for broken in Setup Events.
notes string No Yes Broken notes. (cannot exceed 1000 characters.)
UpdateCategoryRequest Object

Request model for updating category.

Field Type Required Nullable Description
name string Yes No Name of the category (cannot exceed 50 characters.).
UpdateCheckinEventRequest Object

Request model for updating a check-in event.

Field Type Required Nullable Description
checkinFrom AssignTo (Enum) Yes No Who or where the asset was checked in from. Allowed values: Person, SiteLocation.
date1 date-time Yes No Check-in (return) date. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for check-in in Setup Events (the same setting as check-out time).
siteRefId int32 No Yes Foreign key referencing the site the asset was checked in from. Required when checkinFrom is SiteLocation.
locationRefId int32 No Yes Foreign key referencing the location the asset was checked in from. Used when checkinFrom is SiteLocation; must belong to siteRefId.
notes string No Yes Check-in notes. (cannot exceed 1000 characters.)
UpdateCheckoutEventRequest Object

Request model for updating a check-out event to an asset.

Field Type Required Nullable Description
checkoutTo AssignTo (Enum) Yes No Who or where the asset is checked out to. Allowed values: Person, SiteLocation.
date1 date-time No Yes Check-out date. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when check-out time is enabled in Setup Events.
date2 date-time No Yes Due date. Leave empty for no due date. Same format as date1.
personRefId int32 No Yes Foreign key referencing the person the asset is checked out to. Required when checkoutTo is Person.
siteRefId int32 No Yes Foreign key referencing the site the asset is checked out to. Required when checkoutTo is SiteLocation.
locationRefId int32 No Yes Foreign key referencing the location the asset is checked out to. Used when checkoutTo is SiteLocation; must belong to siteRefId.
notes string No Yes Check-out notes. (cannot exceed 1000 characters.)
UpdateContractRequest Object

Request model for update contract.

Field Type Required Nullable Description
contractTitle string Yes No Title or name of the contract or license. (cannot exceed 50 characters.)
description string No Yes Additional details or notes about the contract or license. (cannot exceed 1000 characters.)
hyperlink uri No Yes Website URL or hyperlink associated with the contract or license. (cannot exceed 150 characters.)
contractNo string No Yes Contract or license number assigned by the vendor or provider. (cannot exceed 50 characters.)
vendor string No Yes Name of the vendor associated with the contract. (cannot exceed 50 characters.)
contactPerson string No Yes Name of the primary contact person for the contract or license. (cannot exceed 50 characters.)
phone tel No Yes Phone number of the contract or license contact person. (cannot exceed 20 characters.)
cost currency No Yes Cost of the contract or license.
startDate date Yes No Start date of the contract or license (yyyy-MM-dd).
endDate date No Yes End date or expiration date of the contract or license (yyyy-MM-dd). Required unless NoEndDate is true (returns 422 if missing). When NoEndDate is true, send null; any stored end date is cleared.
licenseCount int32 No Yes Number of licenses covered by the contract.
noEndDate boolean No No Indicates whether the contract has no expiration date.
softwareContract boolean No No Indicates whether the contract is for software.
customFieldRequest [CustomFieldRequest(Object)] No Yes Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.
UpdateCustomerRequest Object

Request model for update customer.

Field Type Required Nullable Description
name string Yes No Customer Name (cannot exceed 100 characters.)
company string No Yes Company name of the customer. (cannot exceed 100 characters.)
address1 string No Yes Address1 of the customer. (cannot exceed 250 characters.)
address2 string No Yes Address2 of the customer. (cannot exceed 250 characters.)
city string No Yes City of the customer (cannot exceed 50 characters.)
state string No Yes State of the customer. (cannot exceed 50 characters.)
zip string No Yes Zip of the customer. (cannot exceed 50 characters.)
countryRefId int32 No Yes Foreign key referencing the country.
phone string No Yes Phone number of the customer. (cannot exceed 50 characters.)
cell string No Yes Cell number of the customer. (cannot exceed 50 characters.)
email email No Yes Email of the customer. (cannot exceed 50 characters.)
notes string No Yes Notes or Comment (cannot exceed 1000 characters.)
customFieldRequest [CustomFieldRequest(Object)] No Yes Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.)
UpdateDepartmentRequest Object

Request model for updating department.

Field Type Required Nullable Description
name string Yes No Name of the department (cannot exceed 50 characters.).
UpdateDisposeEventRequest Object

Request model for updating a dispose event.

Field Type Required Nullable Description
date1 date-time Yes No Date the asset was disposed. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for dispose in Setup Events.
textField string No Yes Who or what the asset was disposed to (free text, e.g. a recycling vendor). (cannot exceed 100 characters.)
notes string No Yes Dispose notes. (cannot exceed 1000 characters.)
UpdateDonateEventRequest Object

Request model for updating a donate event.

Field Type Required Nullable Description
date1 date-time Yes No Date the asset was donated. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for donate in Setup Events.
textField string No Yes Who the asset was donated to (free text, e.g. a charity). (cannot exceed 100 characters.)
currency double Yes No Value of the donation. Use 0 when there is no value.
boolean boolean Yes No Whether the donation is tax deductible.
notes string No Yes Donate notes. (cannot exceed 1000 characters.)
UpdateFoundEventRequest Object

Request model for updating a found event. Replaces the event's found date and notes; omitted notes are cleared.

Field Type Required Nullable Description
date1 date-time Yes No Date the asset was found. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for found in Setup Events.
notes string No Yes Found notes. (cannot exceed 1000 characters.)
UpdateFundRequest Object

Request model for updating an existing fund.

Field Type Required Nullable Description
name string Yes No Name of the fund. Must be unique.(cannot exceed 50 characters.)
description string No Yes Description of the fund.(cannot exceed 1000 characters.)
amount currency No Yes Total allocated amount.
startDate date No Yes Fund start date (yyyy-MM-dd).
endDate date No Yes Fund end date (yyyy-MM-dd).
notes multiline No Yes Additional notes.(cannot exceed 1000 characters.)
active boolean Yes No Whether this fund is active (default: true).
UpdateInsuranceRequest Object

Request model for updating an existing insurance.

Field Type Required Nullable Description
insuranceCo string No Yes Name of the insurance company or provider.(cannot exceed 100 characters.)
description string Yes No Additional details or notes about the insurance policy.(cannot exceed 100 characters.)
person string No Yes Name of the primary contact person for the insurance policy.(cannot exceed 50 characters.)
phone tel No Yes Contact phone number for the insurance provider or representative.(cannot exceed 20 characters.)
email email No Yes Contact email address for the insurance provider or representative.(cannot exceed 50 characters.)
policy string No Yes Policy number assigned by the insurance provider.(cannot exceed 50 characters.)
coverage string No Yes Coverage details provided by the insurance policy.(cannot exceed 50 characters.)
limits string No Yes Coverage limits or maximum claim amount defined by the policy.(cannot exceed 50 characters.)
deductible currency No Yes Deductible amount that must be paid before insurance coverage applies.
premium currency No Yes Premium amount paid for the insurance policy.
startDate date Yes No Policy start date (yyyy-MM-dd).
endDate date Yes No Policy end or expiration date (yyyy-MM-dd).
active boolean Yes No Whether this insurance is active (default: true).
UpdateInventoryItemRequest Object

Request model for update inventory item. Contains core item details, stock information, pricing, alerts, opening date, and optional custom fields.

Field Type Required Nullable Description
inventoryTagId string Yes No Unique tag or code assigned to the inventory item for tracking. (cannot exceed 50 characters.)
description string Yes No Detailed description of the inventory item. (cannot exceed 1000 characters.)
categoryRefId int32 No Yes Readable name of the main category (resolved from CategoryRefId).
subCategoryRefId int32 No Yes Readable name of the main subcategory (resolved from SubCategoryRefId).
notes multiline No Yes Notes. (Notes cannot exceed 1000 characters.)
sku string No Yes Stock Keeping Unit – unique identifier used for managing stock. (SKU cannot exceed 100 characters.)
brand string No Yes Brand name of the item. (cannot exceed 50 characters.)
model string No Yes Model name/number of the item. (cannot exceed 50 characters.)
vendor string No Yes Supplier or vendor associated with the item. (cannot exceed 50 characters.)
url uri No Yes Reference URL (e.g., vendor page, product page, or documentation). (cannot exceed 100 characters.)
size string No Yes Size or dimensions of the item. (cannot exceed 50 characters.)
color string No Yes Color of the item. (cannot exceed 50 characters.)
style string No Yes Style or variant of the item (if applicable). (cannot exceed 50 characters.)
unit string Yes No Unit of measurement (e.g., piece, box, kg, liter). (cannot exceed 50 characters.)
minQty double No Yes Minimum quantity threshold for stock. (used for re-order alerts).
maxQty double No Yes Maximum quantity limit for stock. (used for inventory control).
hasMaxQtyAlert boolean No No Enable Maximum quantity alert.
hasMinQtyAlert boolean No No Enable Minimum quantity alert.
minQtyAlert double No Yes Minimum quantity alert.
maxQtyAlert double No Yes Maximum quantity alert.
openingDate date No Yes Opening date in yyyy-MM-dd format. Applicable only when the Multi-Quantity feature is disabled.
unitCost currency No Yes Unit Cost. Applicable only when the Multi-Quantity feature is disabled.
totalCost currency No Yes Total Cost. Applicable only when the Multi-Quantity feature is disabled.
refNo string No Yes Reference No. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
aisle string No Yes Aisle, Warehouse, Site. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
shelf string No Yes Shelf, Rack, Cabinet. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
bin string No Yes Bins, Bay, Drawer. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
eventNotes multiline No Yes Event Notes. (cannot exceed 1000 characters.) Applicable only when the Multi-Quantity feature is disabled.
customFieldRequest [CustomFieldRequest(Object)] No Yes Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.
UpdateLeaseEventRequest Object

Request model for updating a lease event.

Field Type Required Nullable Description
customerRefId int32 Yes No Foreign key referencing the customer the asset is leased to.
date1 date-time Yes No Date the lease begins. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for lease in Setup Events.
date2 date-time No Yes Date the lease expires. Leave empty for no end date. Same format as date1.
notes string No Yes Lease notes. (cannot exceed 1000 characters.)
UpdateLeaseReturnEventRequest Object

Request model for updating a lease return event.

Field Type Required Nullable Description
date1 date-time Yes No Date the leased asset was returned. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for lease return in Setup Events.
notes string No Yes Lease return notes. (cannot exceed 1000 characters.)
UpdateLocationRequest Object

Request model for updating an existing location.

Field Type Required Nullable Description
name string Yes No Name of the location (cannot exceed 100 characters).
siteRefId int32 Yes No Foreign key referencing the parent site (positive integer only).
description string No Yes Description (cannot exceed 1000 characters).
UpdateLostEventRequest Object

Request model for updating a lost event.

Field Type Required Nullable Description
date1 date-time Yes No Date the asset was lost. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for lost in Setup Events.
notes string No Yes Lost notes. (cannot exceed 1000 characters.)
UpdatePersonRequest Object

Request model for update person.

Field Type Required Nullable Description
name string Yes No Person Name (cannot exceed 100 characters.)
title string No Yes Title of the person. (cannot exceed 100 characters.)
phone string No Yes Phone number of the person. (cannot exceed 20 characters.)
email email No Yes Email of the person. (cannot exceed 50 characters.)
notes string No Yes Notes or Comment (cannot exceed 1000 characters.)
empId string No Yes EmpId of the person. (cannot exceed 50 characters.)
siteRefId int32 No Yes Foreign key referencing the site.
locationRefId int32 No Yes Foreign key referencing the location.
departmentRefId int32 No Yes Foreign key referencing the department.
customFieldRequest [CustomFieldRequest(Object)] No Yes Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.
UpdateRepairEventRequest Object

Request model for updating a repair event.

Field Type Required Nullable Description
date1 date-time Yes No Date the repair is scheduled. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for repair in Setup Events.
textField string No Yes Who the repair is assigned to (free text, e.g. a technician or vendor). (cannot exceed 100 characters.)
date2 date-time No Yes Date the repair was completed. Setting it ends the repair: the asset goes back to its previous check-out or lease, or to Available. Same format as date1.
currency double No Yes Cost of the repair.
notes string No Yes Repair notes. (cannot exceed 1000 characters.)
UpdateReserveRequest Object

Request model for updating an asset reservation.

Field Type Required Nullable Description
reserveTo AssignTo (Enum) Yes No Who or where the asset is reserved for. Allowed values: Person, SiteLocation, Customer.
personRefId int32 No Yes Foreign key referencing the person the asset is reserved for. Required when reserveTo is Person.
customerRefId int32 No Yes Foreign key referencing the customer the asset is reserved for. Required when reserveTo is Customer.
siteRefId int32 No Yes Foreign key referencing the site the asset is reserved for. Required when reserveTo is SiteLocation.
locationRefId int32 No Yes Foreign key referencing the location the asset is reserved for. Optional with reserveTo SiteLocation; must belong to siteRefId.
date1 date-time Yes No Reservation start. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for reservations in Setup Events.
date2 date-time Yes No Reservation end; must not be before date1. Same format as date1. Without time, the reservation runs to the end of this day.
notes string No Yes Reservation notes. (cannot exceed 1000 characters.)
sendEmail boolean No No When true and reserveTo is Person or Customer, sends the reservation confirmation email to that person's or customer's email address and turns on the reminder emails below. No email is sent if they have no email address.
firstReminderEnabled boolean No No Send reminder email #1. Applies only when sendEmail is true.
firstReminderLeadTimeDays int32 No No Days before the reservation starts to send reminder email #1 (1-99, default 2).
secondReminderEnabled boolean No No Send reminder email #2. Applies only when sendEmail is true.
secondReminderLeadTimeDays int32 No No Days before the reservation starts to send reminder email #2 (1-99, default 1).
UpdateSellEventRequest Object

Request model for updating a sell event.

Field Type Required Nullable Description
date1 date-time Yes No Date the asset was sold. Format: yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss when Enable Time is turned on for sell in Setup Events.
textField string No Yes Who the asset was sold to (free text). (cannot exceed 100 characters.)
currency double No Yes Amount the asset was sold for.
notes string No Yes Sell notes. (cannot exceed 1000 characters.)
UpdateShelfRequest Object

Request model for updating shelf. Applicable only when multi-quantiy feature is enabled

Field Type Required Nullable Description
aisleRefId int32 No Yes Optional foreign key referencing the aisle. Set null to create an unallocated shelf (not assigned to any aisle). Required only when the inventory location hierarchy is configured as Aisle > Shelf > Bins.
name string Yes No Name of the shelf (Shelf name cannot exceed 100 characters.).
UpdateSiteRequest Object

Request model for updating an existing site.

Field Type Required Nullable Description
name string Yes No Name of the site (cannot exceed 50 characters).
address1 string No Yes Address line 1 (cannot exceed 500 characters).
address2 string No Yes Address line 2 / Apt. / Suite (cannot exceed 500 characters).
city string No Yes City (cannot exceed 50 characters).
state string No Yes State / Province (cannot exceed 50 characters).
zip string No Yes Postal / Zip code (cannot exceed 50 characters).
countryRefId int32 No Yes Foreign key referencing the country (positive integer only).
description string No Yes Description (cannot exceed 1000 characters).
UpdateSubCategoryRequest Object

Request model for updating subcategory.

Field Type Required Nullable Description
name string Yes No Updated name of the subcategory (Subcategory name cannot exceed 100 characters.).
UpdateTransactionRequest Object

Represents a transaction record for inventory item, including details such as event type, cost, and associated person or customer.

Field Type Required Nullable Description
personRefId int32 No Yes Reference ID of the employee/person associated with the transaction. Applicable only for Remove Stock transactions. Only one of personRefId, customerRefId, or personName may be provided — supplying more than one returns a 422 Validation error.
customerRefId int32 No Yes Reference ID of the customer associated with the transaction. Applicable only for Remove Stock transactions. Only one of personRefId, customerRefId, or personName may be provided — supplying more than one returns a 422 Validation error.
personName string No Yes Free-text name of the person or customer associated with the transaction (max 50 characters). Applicable only for Remove Stock transactions. Only one of personRefId, customerRefId, or personName may be provided — supplying more than one returns a 422 Validation error.
eventDate date Yes No Date added by user at the time of the transaction in yyyy-MM-dd format.
unitCost currency No Yes Unit cost of the item at the time of the transaction. Applicable only for Add Stock and Opening Stock transactions.
totalCost currency No Yes Total cost of the transaction (quantity × unitCost). Applicable only for Add Stock and Opening Stock transactions.
refNo string No Yes Reference number associated with the transaction. (cannot exceed 50 characters.) Applicable only for Add Stock and Opening Stock transactions.
notes string No Yes Additional notes or comments related to the transaction. (cannot exceed 1000 characters.)
aisle string No Yes Aisle name indicating the top-level storage location where the inventory item is placed. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
shelf string No Yes Shelf name within the specified aisle representing the intermediate storage level. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
bin string No Yes Bin Name within the specified shelf representing the exact storage position of the item. (cannot exceed 50 characters.) Applicable only when the Multi-Quantity feature is disabled.
User Object

Represents a system user with personal details, contact information, authentication settings, security options, and system-related metadata.

Field Type Description
refGuid string Globally unique identifier for the user.
firstName string User’s first name. (first name cannot exceed 50 characters.)
lastName string User’s last name. (last name cannot exceed 50 characters.)
title string Optional title or designation (e.g., “Mr.”, “Dr.”, “Manager”). (title cannot exceed 50 characters.)
phone string User’s phone number. (phone cannot exceed 20 characters.)
email string User’s email address (used for login and notifications). (email cannot exceed 70 characters.)
photo string URL to the user’s profile photo or avatar. (user image cannot exceed 1000 characters.)
timeZoneRefId int32 Foreign key reference to the user’s selected time zone.
timeZone string User’s selected time zone.
dateFormatRefId int32 Foreign key reference to the user’s preferred date format (e.g., dd/MM/yyyy,MM-dd-yyyy )
dateFormat string User’s selected Date Format.
timeFormatRefId int32 Foreign key reference to the user’s preferred time format (e.g., 12-hour, 24-hour
timeFormat string User’s selected Time Format.
lastLogin date-time Date and time of the user’s last successful login.
userRole string Shows the access role assigned to the user (e.g. SuperAdmin / User).
emailVerified boolean Shows whether the user’s email is verified or not.
userGroup string Shows the classification or role group assigned to the user within the system.
userGroupDescription string Shows readable description of the user’s group or role, explaining its purpose or permission level.
registerDate date-time The date and time when the user registered in the system.
lastAccessIP string The IP address from which the user last accessed the system.
lastAccessDevice string The IP address from which the user last accessed the system.
twoFAEnabled boolean Indicates whether two-factor authentication (2FA) is enabled for the user.
twoFAPhone string Phone number used for receiving OTP (One-Time Password) for 2FA.
twoFAPhoneVerified boolean Indicates whether the 2FA phone number has been verified.
twoFAByEmail boolean Whether OTP is also sent to the user’s email for 2FA.
twoFAByPhone boolean Whether OTP is sent to the user’s phone for 2FA.
twoFAPhoneCountry int32 Foreign key reference to the user’s country calling code (e.g., +91 for India).
apiEnabled boolean Determines whether API access is enabled for this user.
defaultSelectionEnabled boolean Specifies if the default selection is enabled for this user when adding/editing assets or inventory items.
accessibilityEnabled boolean Indicates whether accessibility features are enabled for the user.
defaultSiteRefId int32 Specifies the site ref ID of the user’s default selected site when adding/editing assets or inventory items.
defaultLocationRefId int32 Specifies the location ref ID of the user’s default selected location when adding/editing assets or inventory items.
defaultCategoryRefId int32 Specifies the category ref ID of the user’s default selected category when adding/editing assets or inventory items.
defaultSubCategoryRefId int32 Specifies the subcategory ref ID of the user’s default selected subcategory when adding/editing assets or inventory items.
defaultDepartmentRefId int32 Specifies the department ref ID of the user’s default selected department when adding/editing assets or inventory items.
scannerType ScanType (Enum) Specifies the type of scanner configured or used by the user.
barcodes string Contains the barcode(s) associated with the user.
WarrantyListRequest Object

Request model for filtering, sorting, and paginating warranty records.

Field Type Required Nullable Default Description
searchKeyword string No Yes - Search keyword to filter warranties by defined search fields. Maximum length: 100 characters.
searchType SearchType (Enum) No No - Defines how the search text should be matched against the field. Default: "Contains" Allowed values: Contains, Exact, StartWith, EndsWith.
searchFields [DataFields(Enum)] No Yes [AssetTagId, Description, Notes] Defines which asset fields can be searched. Default: "AssetTagId", "Description", "Notes". Allowed values include: AssetTagId, Description, Notes, PurchaseFrom, Brand, Model, SerialNo.
searchCustomFields [integer] No No - Defines which warranty custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES.
searchAssetCustomFields [integer] No No - Defines which asset custom fields can be searched (Excluding Data Type Date, Date and Time). Please provide custom field Id. Allowed custom field data type: TEXT, NUMERIC, NUMERICAUTOINCREMENT, CURRENCY, DROPDOWNLIST, MEMO, EMAIL, URL, SCANNER, RADIOBUTTONLIST, CHECKBOXLIST, GPSCOORDINATES.
categoryRefId int32 No Yes - Unique identifier (primary key) of the category to filter by. Pass 0 to filter unassigned categories.
subCategoryRefId int32 No Yes - Unique identifier (primary key) of the subcategory to filter by. If provided, categoryRefId must also be specified. Pass 0 to filter unassigned subcategories.
siteRefId int32 No Yes - Unique identifier (primary key) of the site to filter by. Pass 0 to filter unassigned sites.
locationRefId int32 No Yes - Unique identifier (primary key) of the location to filter by. If provided, siteRefId must also be specified. Pass 0 to filter unassigned locations.
departmentRefId int32 No Yes - Unique identifier (primary key) of the department to filter by. Pass 0 to filter unassigned departments.
personRefId int32 No No - Unique identifier (primary key) of the assigned person to filter by.
customerRefId int32 No No - Unique identifier (primary key) of the assigned customer to filter by.
eventTypes [EventType(Enum)] No Yes - Filters assets by the specified event types. Selecting "Custom" includes all user-defined custom events.
orderBy DataField (Enum) No No - The field to order results by. Default: "ExpiryDate". Allowed values: ExpiryDate, AssetTagId, Description, Brand, Model, SerialNo, PurchaseDate, DateCreated, CreatedBy, WarrantyNotes, WarrantyLength, WarrantyCreatedBy, Cost, PurchaseFrom, InitialCost, SiteName, LocationName, CategoryName, SubCategoryName, DepartmentName, isDepreciable, SalvageValue, AssetLife, DepreciationMethodName, DateAcquired, Status, PersonName, LeaseTo, Reservation, EventDate1, EventDate2, Relation, IsLinked, CurrentCost.
sortOrder SortOrder (Enum) No No - The sorting direction for the result set. Default: "Asc" Allowed values: Asc, Desc.
startDate date No No - The start date for filtering warranty records. Format: "yyyy-MM-dd" Example: 2025-04-01.
endDate date No No - The end date for filtering warranty records. Format: "yyyy-MM-dd" Example: 2025-04-30.
dateRangeBy DataField (Enum) No No - Defines which date field the filtering should apply to. Ignored if dateRangeByCustomField or dateRangeByAssetCustomField is provided. Default: "ExpiryDate" Allowed values: ExpiryDate, DateCreated, PurchaseDate, DateAcquired.
dateRangeByCustomField int32 No Yes - Defines which warranty custom date field the filter should apply to. Provide the warranty Custom Field ID to enable the dateRangeByCustomField filter, which takes precedence over dateRangeBy when set. Requires startDate and endDate to also be provided.
dateRangeByAssetCustomField int32 No Yes - Defines which asset custom date field the filter should apply to. Provide the asset Custom Field ID to enable this filter, which takes precedence over dateRangeBy and dateRangeByCustomField when set. Requires startDate and endDate to also be provided.
fetchCustomFields boolean No No False Whether to include custom fields in the result. Default: "false".
offset int32 No No 0 The number of records to skip before returning results. Default: "0"
limit int32 No No 20 The maximum number of records to return. Default: "20" Allowed range: 1-100.
WarrantyRequest Object

Request model for adding or updating an asset warranty. Contains the associated asset, warranty length, expiry date, notes, and optional custom fields.

Field Type Required Nullable Default Description
assetRefId int32 Yes No - Unique identifier (primary key) of the asset to associate with the warranty.
length int32 No Yes - Length of the warranty (in months). (Must be within 1 to 9999.)
expiryDate date Yes No - Date when warranty expires. Format: yyyy-MM-dd.
notes string No Yes - Text area for notes. (cannot exceed 1000 characters.)
customFieldRequest [CustomFieldRequest(Object)] No Yes - Represents a value submitted for a specific custom field. Used for text, numeric, date, dropdown, radio, or checkbox list fields.
WarrantySetting Object

Represents configuration settings for warranty fields, including visibility (enabled/disabled) and validation rules (required).

Field Type Default Description
field_ExpiryDate_Enabled boolean True Indicates whether Expiry Date is enabled. Always true — this field cannot be disabled.
field_ExpiryDate_Required boolean True Indicates whether Expiry Date is required. Always true — this field is always required.
field_Length_Enabled boolean False Indicates whether Length is enabled.
field_Length_Required boolean False Indicates whether Length is required.
field_Notes_Enabled boolean False Indicates whether Notes is enabled.
field_Notes_Required boolean False Indicates whether Notes is required.