--- title: "Retrieve a Work Orders" method: GET path: "/odata/locations({locationId})/workorders" tags: ["WorkOrders"] --- # Retrieve a Work Orders `GET /odata/locations({locationId})/workorders` ## Request - Base URL: `https://sb2api.servicechannel.com/v3` - URL: `https://sb2api.servicechannel.com/v3/odata/locations({locationId})/workorders` - Auth: OAuth 2 - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize` - Token URL: `https://sb2login.servicechannel.com/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieve a Work Orders.
One page contains 50 items by default. To get next 50 items use the "$skip" parameter (for example $skip=50 and so on).
The filter expressions by defaul is "$filter CallDate ge (Now+90 days)".
The maximum CallDate value is 365 days even if provided. ## Path parameters - `locationId` integer, required ## Query parameters - `$expand` string - `$select` string - `$filter` string - `$orderby` string - `$top` integer - `$skip` integer - `$count` boolean ## Response `200` Indicates that the request succeeded and that the requested information is in the response. - ServiceChannelServicesMessagingWorkordersWorkOrder[] - `Id` integer: Work Order identifier. - `Number` string: Work Order Number - `PurchaseNumber` string: Purchase number of work order - `Subscriber` ServiceChannelServicesMessagingSubscribersSubscriber - `Id` integer - `ShortName` string - `Email` string - `Users` ServiceChannelServicesMessagingUsersUser[] - `Id` integer: Unique user identifier. - `SubscriberId` integer: Unique subscriber ID. - `UserName` string: Username of the user.
• For subscriber users, the username appears as **User Id** on the "General Info" tab of the user profile page.
• For provider users, the username is listed as **UserID** under "Access" on the "General" tab of the user profile page. - `FullName` string: Full name of the user.
• For subscriber users, the full name appears as **User Name** on the "General Info" tab of the user profile page.
• For provider users, you can see their first and last name under "Basic" on the "General" tab of the user profile page. - `Email` string: User’s email address. - `PsmEmail` string: Email address through which a user can reset their password. - `Disabled` boolean: Defines if a user is deactivated. - `IsLocked` boolean: Defines if a user is locked. - `Roles` string[]: Secondary roles assigned to a subscriber user that determine their permissions and level of access to various Service Automation modules. - `Permissions` string[]: Permissions assigned to a subscriber user that determine whether they have full or read-only access to various Service Automation modules. - `UserType` 'Corporate' | 'Dashboard' | 'ServiceChannel': Subscriber user type defining their level of access to ServiceChannel:
• `Corporate` — a user can work in Service Automation.
• `Dashboard` — a user can only access the dashboard assigned to them.
`0` is returned for provider users. - `Dashboard` ServiceChannelServicesMessagingUsersDashboardInfo: Dashboard details object. - `Id` integer: Unique dashboard identifier. - `Name` string: Dashboard name. - `RedirectToDashboard` boolean: Defines whether a subscriber user is redirected to a dashboard once they log in. - `Access` ServiceChannelServicesMessagingUsersAccessOptions: Object listing locations, districts, regions, and trades a subscriber user has access to. Learn more about [granting access based on locations, districts, and regions](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/585107276/Location+District+Region+Access+Tab) in ServiceChannel University. - `Locations` string[]: Locations a user has access to. - `Districts` string[]: Districts a user has access to. - `Regions` string[]: Regions a user has access to. - `Trades` string[]: Trades a user is permitted to work with. - `Limits` ServiceChannelServicesMessagingUsersLimitOptions: Object for NTE, proposal, and invoice limits set for a subscriber user. - `NteLimit` ServiceChannelServicesMessagingUsersLimit: Object for limit details set for a subscriber user. - `Amount` number, double: Limit amount. - `CurrencyId` integer: Identifier of the currency the limit is set in. - `ProposalLimit` ServiceChannelServicesMessagingUsersLimit: Object for limit details set for a subscriber user. - `Amount` number, double: Limit amount. - `CurrencyId` integer: Identifier of the currency the limit is set in. - `InvoiceLimit` ServiceChannelServicesMessagingUsersLimit: Object for limit details set for a subscriber user. - `Amount` number, double: Limit amount. - `CurrencyId` integer: Identifier of the currency the limit is set in. - `FeedRole` string - `MliUserInfo` ServiceChannelServicesMessagingUsersMliUserInfo - `Id` integer - `MliLevel` string - `MliLocations` integer[] - `MlpUserInfo` ServiceChannelServicesMessagingUsersMlpUserInfo - `Id` integer - `MlpLevel` string - `MlpLocations` integer[] - `PrimaryCurrency` ServiceChannelServicesMessagingCurrenciesCurrency - `Id` integer - `AlphabeticalCode` string - `DecimalCount` integer - `Entity` string - `CurrencyName` string - `NumericCode` string - `Rate` number, double - `IsOutsourcedWorkOn` boolean - `Name` string, required: Required Name Name - name of the subscriber - `Address1` string: Optional - `Address2` string: Optional - `Country` string: Optional - `State` string: Optional - `City` string: Optional - `Zip` string: Optional - `Phone` string: Optional - `Fax` string: Optional - `ContactName` string: Optional - `TimeFormat` string - `DateFormat` string - `DecimalSeparator` string - `Provider` ServiceChannelServicesMessagingProvidersProvider - `Phone` string - `FullName` string: Full Name - `Address1` string: Address1 - `Address2` string: Adress2 - `City` string: City - `State` string: State - `Zip` string: Zip - `Country` string: Country - `MainContact` string: Main Contact - `DateCreated` string, date-time: Date Created - `LastUserDate` string: Last User Date - `SuperUser` string: SuperUser - `WebSite` string: WebSite - `Email` string: Email - `TaxId` string: Tax Id - `Trade` string: Trade - `ProcessingEmail` string: Processing Email - `FaxNumber` string: Fax Number - `SuiteFloor` string: Suite Floor - `MailInfo` string: Mail Info - `ImageFile` string: Image File - `ReturnMail` string: Return Mail - `MailFrequency` integer: Mail Frequency - `FormId` integer: Form Id - `Pager` string: Pager - `NightRequest` integer: NightRequest - `ShortFormatEmail` string: Short Format Email - `LastTrainingDate` string, date-time: Last Training Date - `LastTrainingDateStr` string: Last Training Date as a string - `IsInternal` boolean: Is Internal - `IsOnOffShoreFeatureEnabled` boolean: Is OnOffShoreFeature Enabled - `Id` integer: Id - `Name` string: Name - `DoNotDispatch` boolean: DoNotDispatch enabled? - `Location` ServiceChannelServicesMessagingLocationLocation: General location details object. - `Id` integer: Unique location identifier. - `SubscriberId` integer: Unique subscriber identifier. - `SubscriberName` string - `StoreId` string: Alphanumeric identifier of the store in the client's system. Assigned by and unique per subscriber. - `Name` string: Location name. - `ShortName` string: Shortened location name. - `Latitude` number, double: Global position. Latitude. - `Longitude` number, double: Global position. Longitude. - `Distance` number, double: Distance from GPS coordinate to this location - `Radius` number, double: GPS radius for the location. - `LocationTypeId` integer: Numeric identifier of the location type. - `Address1` string: Additional location address. - `Address2` string: Main location address. - `City` string: Location city. - `State` string: State where the location is situated. - `StateId` integer: Numeric identifier of the location’s state. - `Region` string: Part of the country where the location is situated. - `District` string: Abbreviation of the town or country area where the location is situated. - `Zip` string: Location ZIP or postal code. - `Country` string: Abbreviation of the country name where the location is situated. - `CountryId` integer: Numeric identifier of the country of the location. - `ClosedDate` string, date-time: Last day when the location is open for business. - `OpenDate` string, date-time: First day when the location is open for business. - `Status` string: Status of the location. Possible values: *open*, *closed*. - `Email` string: Email the location can be contacted at. - `FaxNumber` string: Fax number the location can be contacted at. - `Phone` string: Contact phone number of the location. - `Contact` string: Name of the main person to contact at the location. - `HasInventory` boolean: Indicates whether it’s an inventory location or not. Possible values: *true*, *false*. - `SquareValue` number, double: Square value of the facility. - `SquareMeasure` string: Unit or system of units for measuring location area. - `TimeZoneInfoId` integer: Numeric identifier of the location time zone. - `TimeZoneShortDescription` string: Location time zone abbreviation. - `TimeZoneMsName` string: Location time zone Microsoft Name. e.g "Eastern Standard Time" - `TimeZoneIanaName` string: Location time zone Iana Name. e.g. "America/New_York" - `TypeLabel` string: [Inventory location type](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/1209106525/Creating+Inventory+Locations?preview=%2F1209106525%2F1205830388%2FSupply-House-Type.png). Possible values: *Location*, *Warehouse*, *Supply House*, *Truck*. - `Supplier` string: Supplier’s location name. - `CountyId` integer: County numeric identifier. - `Notes` ServiceChannelServicesMessagingLocationNoteLocationNote[] - `Id` integer: Location note numeric identifier. - `HeaderId` integer: Unique location note header identifier. - `Value` string: Location note content. - `Header` string: Name of the note. - `TimeShiftToEST` integer - `AddressTypeId` integer: Address format pattern Id - `FormattedAddress` string - `LocationFormattedAddressTail` string - `IsInternational` boolean - `Address` string - `LocationId` integer: LocationId for use in ODATA calls without expanding Location property (ref. PLAT-55878) - `Status` ServiceChannelServicesMessagingWorkordersWorkorderStatusDescriptor - `Primary` string: Primary work order status value, you can pass status id or its name here. To get all subscriber's statuses see [Statuses] in Statuses section - `Extended` string: Extended status value - `CanCreateInvoice` boolean: True if invoice creation is allowed - `IssueTicketInfo` ServiceChannelServicesMessagingIssueListsIssueTicketInformation - `Id` integer - `AreaId` integer - `AreaName` string - `ProblemGroup` string - `Equipment` string - `ProblemCode` string - `TicketType` string - `SetupId` integer - `Caller` string: Caller - `CreatedBy` string - `CallDate` string, date-time - `CallDate_DTO` string, date-time - `ReassignDate` string, date-time - `ReassignDate_DTO` string, date-time - `LocationOpenDate` string - `LocationRemodelDate` string - `EstimatedCompletionDate` string, date-time - `OriginalEstimatedCompletionDate` string, date-time - `ProjectedCompletionDate` string, date-time - `OriginalProjectedCompletionDate` string, date-time - `Priority` string - `PriorityId` integer - `Trade` string - `TradeId` integer - `ApprovalCode` string - `ScheduledDate` string, date-time - `ScheduledDate_DTO` string, date-time - `CompletedDate` string, date-time - `CompletedDate_DTO` string, date-time - `ExpirationDate` string, date-time: Gets or sets ExpirationDate. - `ExpirationDate_DTO` string, date-time - `OriginalEta` string, date-time - `OriginalEta_DTO` string, date-time - `UpdatedDate` string, date-time: Updated Date - `UpdatedDate_DTO` string, date-time - `CreatedDate` string, date-time: s Created Date - `CreatedDate_DTO` string, date-time - `Description` string - `CategoryId` integer - `Category` string - `Nte` number, double - `Tax` number, double: Tax - `Tax2` number, double: Tax2 - `Tax2Type` string: Tax2Type - `Price` number, double: Price (subtotal) - `Currency` ServiceChannelServicesMessagingCurrenciesCurrency - `Id` integer - `AlphabeticalCode` string - `DecimalCount` integer - `Entity` string - `CurrencyName` string - `NumericCode` string - `Rate` number, double - `ProblemCode` string - `Invoice` ServiceChannelServicesMessagingInvoicesInvoice - `Provider` ServiceChannelServicesMessagingProvidersProvider - `Phone` string - `FullName` string: Full Name - `Address1` string: Address1 - `Address2` string: Adress2 - `City` string: City - `State` string: State - `Zip` string: Zip - `Country` string: Country - `MainContact` string: Main Contact - `DateCreated` string, date-time: Date Created - `LastUserDate` string: Last User Date - `SuperUser` string: SuperUser - `WebSite` string: WebSite - `Email` string: Email - `TaxId` string: Tax Id - `Trade` string: Trade - `ProcessingEmail` string: Processing Email - `FaxNumber` string: Fax Number - `SuiteFloor` string: Suite Floor - `MailInfo` string: Mail Info - `ImageFile` string: Image File - `ReturnMail` string: Return Mail - `MailFrequency` integer: Mail Frequency - `FormId` integer: Form Id - `Pager` string: Pager - `NightRequest` integer: NightRequest - `ShortFormatEmail` string: Short Format Email - `LastTrainingDate` string, date-time: Last Training Date - `LastTrainingDateStr` string: Last Training Date as a string - `IsInternal` boolean: Is Internal - `IsOnOffShoreFeatureEnabled` boolean: Is OnOffShoreFeature Enabled - `Id` integer: Id - `Name` string: Name - `DoNotDispatch` boolean: DoNotDispatch enabled? - `Subscriber` ServiceChannelServicesMessagingSubscribersSubscriber - `Id` integer - `ShortName` string - `Email` string - `Users` ServiceChannelServicesMessagingUsersUser[] - `Id` integer: Unique user identifier. - `SubscriberId` integer: Unique subscriber ID. - `UserName` string: Username of the user.
• For subscriber users, the username appears as **User Id** on the "General Info" tab of the user profile page.
• For provider users, the username is listed as **UserID** under "Access" on the "General" tab of the user profile page. - `FullName` string: Full name of the user.
• For subscriber users, the full name appears as **User Name** on the "General Info" tab of the user profile page.
• For provider users, you can see their first and last name under "Basic" on the "General" tab of the user profile page. - `Email` string: User’s email address. - `PsmEmail` string: Email address through which a user can reset their password. - `Disabled` boolean: Defines if a user is deactivated. - `IsLocked` boolean: Defines if a user is locked. - `Roles` string[]: Secondary roles assigned to a subscriber user that determine their permissions and level of access to various Service Automation modules. - `Permissions` string[]: Permissions assigned to a subscriber user that determine whether they have full or read-only access to various Service Automation modules. - `UserType` 'Corporate' | 'Dashboard' | 'ServiceChannel': Subscriber user type defining their level of access to ServiceChannel:
• `Corporate` — a user can work in Service Automation.
• `Dashboard` — a user can only access the dashboard assigned to them.
`0` is returned for provider users. - `Dashboard` ServiceChannelServicesMessagingUsersDashboardInfo: Dashboard details object. - `Id` integer: Unique dashboard identifier. - `Name` string: Dashboard name. - `RedirectToDashboard` boolean: Defines whether a subscriber user is redirected to a dashboard once they log in. - `Access` ServiceChannelServicesMessagingUsersAccessOptions: Object listing locations, districts, regions, and trades a subscriber user has access to. Learn more about [granting access based on locations, districts, and regions](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/585107276/Location+District+Region+Access+Tab) in ServiceChannel University. - `Locations` string[]: Locations a user has access to. - `Districts` string[]: Districts a user has access to. - `Regions` string[]: Regions a user has access to. - `Trades` string[]: Trades a user is permitted to work with. - `Limits` ServiceChannelServicesMessagingUsersLimitOptions: Object for NTE, proposal, and invoice limits set for a subscriber user. - `NteLimit` ServiceChannelServicesMessagingUsersLimit: Object for limit details set for a subscriber user. - `Amount` number, double: Limit amount. - `CurrencyId` integer: Identifier of the currency the limit is set in. - `ProposalLimit` ServiceChannelServicesMessagingUsersLimit: Object for limit details set for a subscriber user. - `Amount` number, double: Limit amount. - `CurrencyId` integer: Identifier of the currency the limit is set in. - `InvoiceLimit` ServiceChannelServicesMessagingUsersLimit: Object for limit details set for a subscriber user. - `Amount` number, double: Limit amount. - `CurrencyId` integer: Identifier of the currency the limit is set in. - `FeedRole` string - `MliUserInfo` ServiceChannelServicesMessagingUsersMliUserInfo - `Id` integer - `MliLevel` string - `MliLocations` integer[] - `MlpUserInfo` ServiceChannelServicesMessagingUsersMlpUserInfo - `Id` integer - `MlpLevel` string - `MlpLocations` integer[] - `PrimaryCurrency` ServiceChannelServicesMessagingCurrenciesCurrency - `Id` integer - `AlphabeticalCode` string - `DecimalCount` integer - `Entity` string - `CurrencyName` string - `NumericCode` string - `Rate` number, double - `IsOutsourcedWorkOn` boolean - `Name` string, required: Required Name Name - name of the subscriber - `Address1` string: Optional - `Address2` string: Optional - `Country` string: Optional - `State` string: Optional - `City` string: Optional - `Zip` string: Optional - `Phone` string: Optional - `Fax` string: Optional - `ContactName` string: Optional - `TimeFormat` string - `DateFormat` string - `DecimalSeparator` string - `Location` ServiceChannelServicesMessagingLocationLocation: General location details object. - `Id` integer: Unique location identifier. - `SubscriberId` integer: Unique subscriber identifier. - `SubscriberName` string - `StoreId` string: Alphanumeric identifier of the store in the client's system. Assigned by and unique per subscriber. - `Name` string: Location name. - `ShortName` string: Shortened location name. - `Latitude` number, double: Global position. Latitude. - `Longitude` number, double: Global position. Longitude. - `Distance` number, double: Distance from GPS coordinate to this location - `Radius` number, double: GPS radius for the location. - `LocationTypeId` integer: Numeric identifier of the location type. - `Address1` string: Additional location address. - `Address2` string: Main location address. - `City` string: Location city. - `State` string: State where the location is situated. - `StateId` integer: Numeric identifier of the location’s state. - `Region` string: Part of the country where the location is situated. - `District` string: Abbreviation of the town or country area where the location is situated. - `Zip` string: Location ZIP or postal code. - `Country` string: Abbreviation of the country name where the location is situated. - `CountryId` integer: Numeric identifier of the country of the location. - `ClosedDate` string, date-time: Last day when the location is open for business. - `OpenDate` string, date-time: First day when the location is open for business. - `Status` string: Status of the location. Possible values: *open*, *closed*. - `Email` string: Email the location can be contacted at. - `FaxNumber` string: Fax number the location can be contacted at. - `Phone` string: Contact phone number of the location. - `Contact` string: Name of the main person to contact at the location. - `HasInventory` boolean: Indicates whether it’s an inventory location or not. Possible values: *true*, *false*. - `SquareValue` number, double: Square value of the facility. - `SquareMeasure` string: Unit or system of units for measuring location area. - `TimeZoneInfoId` integer: Numeric identifier of the location time zone. - `TimeZoneShortDescription` string: Location time zone abbreviation. - `TimeZoneMsName` string: Location time zone Microsoft Name. e.g "Eastern Standard Time" - `TimeZoneIanaName` string: Location time zone Iana Name. e.g. "America/New_York" - `TypeLabel` string: [Inventory location type](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/1209106525/Creating+Inventory+Locations?preview=%2F1209106525%2F1205830388%2FSupply-House-Type.png). Possible values: *Location*, *Warehouse*, *Supply House*, *Truck*. - `Supplier` string: Supplier’s location name. - `CountyId` integer: County numeric identifier. - `Notes` ServiceChannelServicesMessagingLocationNoteLocationNote[] - `Id` integer: Location note numeric identifier. - `HeaderId` integer: Unique location note header identifier. - `Value` string: Location note content. - `Header` string: Name of the note. - `TimeShiftToEST` integer - `AddressTypeId` integer: Address format pattern Id - `FormattedAddress` string - `LocationFormattedAddressTail` string - `IsInternational` boolean - `Address` string - `Id` integer - `Number` string: Gets or sets invoice number. - `BatchNumber` string: Gets or sets Batch number. - `InvoiceTax` number, double - `PostedTaxRate` number, float - `PostedTax2Rate` number, float - `VendorPayeeId` integer - `InvoiceTotal` number, double: Gets or sets total with tax amounts. - `InvoiceBalance` number, double - `Currency` ServiceChannelServicesMessagingCurrenciesCurrency - `Id` integer - `AlphabeticalCode` string - `DecimalCount` integer - `Entity` string - `CurrencyName` string - `NumericCode` string - `Rate` number, double - `ApprovedDate` string, date-time - `ApprovalCode` string - `EditableAdditionalApprovalCode` ServiceChannelServicesMessagingApprovalCodesEditableAdditionalApprovalCode - `Header` string - `Value` string - `SetupId` integer - `LocationId` integer - `DefaultOptionId` integer - `ValueFormat` integer - `EditableAtLineItemLevel` integer - `Options` ServiceChannelServicesMessagingApprovalCodesAdditionalApprovalCodeOption[] - `Id` integer - `Value` string - `DefaultValue` string - `PostedDate` string, date-time - `PostedBy` string - `Subtotal` number, double - `Status` string - `Trade` string - `TradeId` integer - `Category` ServiceChannelServicesMessagingInvoicesInvoiceCategoryMessaging - `Id` integer - `Name` string - `InvoiceAmountsDetails` ServiceChannelServicesMessagingInvoicesInvoiceAmountsDetails: Object containing the list of the invoice charges. - `LaborAmount` number, double: Amount of the labor charge. Must equal `Labors.Amount`. - `MaterialAmount` number, double: Amount of the material charge. Must equal `Materials.Amount`. - `TravelAmount` number, double: Amount of the trip charge. - `FreightAmount` number, double: Amount of the freight charge. - `OtherAmount` number, double: Amount of other charges. When you add this parameter, also specify `InvoiceAmountsDetails.OtherDescription`. - `OtherDescription` string - `InvoiceTaxesDetails` ServiceChannelServicesMessagingInvoicesInvoiceTaxesDetails: Object containing the list of taxes. You can add taxes as a fixed amount or as a percentage. - `LaborTaxPercent` number, double: Amount of the labor tax in percentage (for countries other than USA and Canada). - `MaterialTaxPercent` number, double: Amount of the material tax in percentage (for countries other than USA and Canada). - `TravelTaxPercent` number, double: Amount of the travel tax in percentage (for countries other than USA and Canada). - `FreightTaxPercent` number, double: Amount of the freight tax in percentage (for countries other than USA and Canada). - `OtherTaxPercent` number, double: Amount of other taxes in percentage (for countries other than USA and Canada). - `LaborTax` number, double: Amount of the labor tax. - `MaterialTax` number, double: Amount of the material tax. - `TravelTax` number, double: Amount of the travel tax. - `FreightTax` number, double: Amount of the freight tax. - `OtherTax` number, double: Amount of other taxes. - `Tax2Details` ServiceChannelServicesMessagingInvoicesTax2Details: Information on the additional tax. Only invoices for Canadian locations can have Tax2Details. - `Tax2Amount` number, double: Amount of the additional tax. - `Tax2Name` string: Name of the additional tax, for example, *VAT*, *HST*, *PST*, or *QST*. - `Labors` ServiceChannelServicesMessagingInvoicesInvoiceLabor[] - `Id` integer - `InvoiceId` integer: Invoice identifier. - `SkillLevel` string, byte: The skill level of a worker. Valid values: `1` - Supervisor, `2` - Technician, `3` - Helper. - `LaborType` string, byte: The type of the pay rate. Valid values: `1` - Regular, `2` - Overtime, `3` - Double time. - `NumOfTech` string, byte: Number of workers. - `HourlyRate` number, double: Worker hourly rate. - `Hours` number, double: Total hours the worker spent to complete the work order. - `Amount` number, double: The amount of the labor charge. The sum of all `Amount` parameters in the `Labors` array must equal `InvoiceAmountsDetails.LaborAmount`. - `IsOffShore` boolean: Type of the shore (`1` - Onshore, `2` - Offshore). - `ServiceType` string, byte: Type of the service (`1` - Design Engineering, Architecture, Technical Service, `2` - Installation and Supervision, `3` - Survey and Troubleshooting). - `CityPerformed` string: City where services are performed. - `RateDiscrepancyReason` string: Rate discrepancy reason. - `AgreedRate` number, double: Agreed rate. - `ApprovalCodeGroup` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `Amount` number, double - `ApprovalCodes` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeChild[] - `Amount` number, double - `Id` integer - `InvoiceId` integer - `InvoiceChargeId` integer - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `ParentId` integer - `InternalId` integer - `InternalParentId` integer - `IsDefault` boolean - `IsRateDiscrepancy` boolean - `isNontaxableVATEU` boolean - `Materials` ServiceChannelServicesMessagingInvoicesInvoiceMaterial[] - `Id` integer - `InvoiceId` integer: Invoice identifier. - `Description` string: Name or description of the material. Length limit is 100 symbols. - `PartNum` string: Part, serial, or manufacturer number of the material. Length limit is 100 symbols. - `UnitType` string, byte: Unit of measurement. Valid values: 1 — Each; 2 — Box; 3 — Feet; 4 — Sqft; 5 — Lbs; 6 — Gal; 7 — Oz. Default value: 1. - `UnitPrice` number, double: Price per unit. - `PartName` string: Part name. - `MarkUpPercent` number, double: Markup percent. - `AgreedMarkUpPercent` number, double: Agreed markup percent. - `MarkUpDiscrepancyReason` string: Mark up discrepancy reason. - `AgreedPartPrice` number, double: Agreed part price. - `Quantity` number, double: Quantity of the material. - `Amount` number, double: The amount of the material cost. The sum of all `Amount` parameters in the `Materials` array must equal `InvoiceAmountsDetails.MaterialAmount`. - `ApprovalCodeGroup` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `Amount` number, double - `ApprovalCodes` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeChild[] - `Amount` number, double - `Id` integer - `InvoiceId` integer - `InvoiceChargeId` integer - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `ParentId` integer - `InternalId` integer - `InternalParentId` integer - `IsDefault` boolean - `IsMarkUpDiscrepancy` boolean: Markup discrepancy. - `IsPartPriceDiscrepancy` boolean: Part price discrepancy. - `PriceDiscrepancyReason` string: Price discrepancy reason. - `isNontaxableVATEU` boolean - `Travels` ServiceChannelServicesMessagingInvoicesInvoiceTravel[] - `Id` integer - `InvoiceId` integer: Invoice identifier. - `Description` string: Description of the trip. - `UnitType` string, byte: Unit of measurement. - `UnitPrice` number, double: Price per unit. - `Quantity` number, double: Quantity. - `Amount` number, double: The amount of the trip cost. The sum of all `Amount` parameters in the `Travels` array must equal `InvoiceAmountsDetails.TravelAmount`. - `IsOffShore` boolean: Type of the shore (`1` - Onshore, `2` - Offshore). - `ApprovalCodeGroup` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `Amount` number, double - `ApprovalCodes` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeChild[] - `Amount` number, double - `Id` integer - `InvoiceId` integer - `InvoiceChargeId` integer - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `ParentId` integer - `InternalId` integer - `InternalParentId` integer - `IsDefault` boolean - `isNontaxableVATEU` boolean - `Others` ServiceChannelServicesMessagingInvoicesInvoiceOther[] - `Id` integer - `InvoiceId` integer: Invoice identifier. - `Description` string: Get or set description. - `Type` string: Get or set type of charge. - `Amount` number, double: Get or set the amount of money that is charged. - `UnitType` string, byte: Get or set the unit of measure - `UnitPrice` number, double: Get or set the price of unit - `Quantity` number, double: Get or set the quantity - `AgreedUnitPrice` number, double: Get or set the AgreedUnitPrice - `UnitPriceDiscrepancyReason` string: UnitPriceDiscrepancyReason - `PriceListOtherChargeId` integer: Get or set the PriceListOtherChargeId - `IsUnitPriceDiscrepancy` boolean: Get IsUnitPriceDiscrepancy - `ApprovalCodeGroup` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `Amount` number, double - `ApprovalCodes` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeChild[] - `Amount` number, double - `Id` integer - `InvoiceId` integer - `InvoiceChargeId` integer - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `ParentId` integer - `InternalId` integer - `InternalParentId` integer - `IsDefault` boolean - `isNontaxableVATEU` boolean - `TaxApprovalCodeGroups` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup[] - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `Amount` number, double - `ApprovalCodes` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeChild[] - `Amount` number, double - `Id` integer - `InvoiceId` integer - `InvoiceChargeId` integer - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `ParentId` integer - `InternalId` integer - `InternalParentId` integer - `IsDefault` boolean - `Tax2ApprovalCodeGroups` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup[] - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `Amount` number, double - `ApprovalCodes` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeChild[] - `Amount` number, double - `Id` integer - `InvoiceId` integer - `InvoiceChargeId` integer - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `ParentId` integer - `InternalId` integer - `InternalParentId` integer - `IsDefault` boolean - `FreightApprovalCodeGroups` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeGroup[] - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `Amount` number, double - `ApprovalCodes` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCodeChild[] - `Amount` number, double - `Id` integer - `InvoiceId` integer - `InvoiceChargeId` integer - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `ParentId` integer - `InternalId` integer - `InternalParentId` integer - `IsDefault` boolean - `WithMismatchedRates` boolean - `IsOutsourced` boolean - `StarredBy` string - `IsStarred` boolean - `IsTransferred` boolean - `StarredDate` string, date-time - `Description` string - `InvoiceDate` string, date-time - `LaborTaxIncluded` boolean - `TravelTaxIncluded` boolean - `MaterialsTaxIncluded` boolean - `FreightTaxIncluded` boolean - `OtherTaxIncluded` boolean - `NonTaxableLabor` integer - `NonTaxableTravel` integer - `NonTaxableMaterial` integer - `NonTaxableFreight` integer - `NonTaxableOther` integer - `IsExists` boolean - `StatusChangeDate` string, date-time - `StatusChangeUser` string - `StatusChangeUserid` string - `IsDuplicate` boolean - `WoTrackingNumber` integer: Gets or sets work order tracking number. - `Terms` string: terms - `Comments` string - `PaidDate` string, date-time - `TransferredDate` string, date-time - `LastActionDate` string, date-time - `UpdatedDate` string, date-time: Updated Date - `StatusHistoryShort` ServiceChannelServicesMessagingInvoicesStatusHistoryShort[] - `CreatedBy` string - `CreatedById` integer - `Status` string - `InvId` integer - `ActionDate` string - `WoAssignedTo` string: Gets or sets WO Assignee - `ApprovalCodes` ServiceChannelServicesMessagingInvoicesInvoiceApprovalCode[] - `Id` integer - `InvoiceId` integer - `InvoiceChargeId` integer - `ApprovalCodeType` 'Labor' | 'Travel' | 'Material' | 'Freight' | 'Other' | 'Tax' | 'Tax2' | 'LineItem' | 'FreightGenerated' - `ApprovalCode` string - `AdditionalApprovalCode` string - `ParentId` integer - `InternalId` integer - `InternalParentId` integer - `IsDefault` boolean - `IsChargesApprovalCodesDefault` boolean - `Payments` ServiceChannelServicesMessagingInvoicesInvoicePaymentResponse[] - `Id` integer: Numeric identifier of the payment. - `PaymentDate` string, date-time: Date and time when the specified invoice was paid. - `PaidBy` string: Username of the employee who made the payment. - `PaymentNumber` string: Order number of payment. - `PaymentAmount` number, double: Amount paid for the invoice. The value is negative if it’s a credited invoice. - `StoredFeatures` string[] - `Resolution` string - `Asset` ServiceChannelServicesMessagingAssetsAssetResponse: Object details of an asset. - `Id` integer: Unique numeric asset identifier assigned by the system. - `Tag` string: Alphanumeric asset identifier assigned by the client. - `Manufacturer` string: Company name that produces an asset. - `ModelNo` string: Asset model number. - `SerialNo` string: Asset serial number. - `LocationId` integer: Unique numeric identifier of a location an asset is assigned to. - `Area` string: Place where an asset is physically located. - `WorkOrderArea` string: Work order area, such as *Dining Room*, *Kitchen*, *Storage*. - `StoreId` string: Alphanumeric location identifier assigned by the client. - `Trade` string: Trade of an asset type the asset is assigned to, for example, *HVAC*, *DOORS*, *ELECTRICAL*. - `TradeId` integer: Numeric identifier of the primary trade of an asset. - `Type` string: Asset type, for example, *Refrigerator*, *Computer Monitor*, etc. - `AssetTypeId` integer: Unique numeric identifier of an asset type. - `BrandId` integer: Unique numeric identifier of a manufacturer that produces an asset. - `InstallDate` string: Date and time when an asset was installed at the current location. - `InstallDateVal` string, date-time: Date and time when an asset was installed at the current location. - `ManufacturerDate` string, date-time: Date and time when an asset was produced. - `ManufacturerDateStr` string: Date and time when an asset was produced by the manufacturer. - `PurchaseDate` string: Date and time when an asset was purchased. - `UsesRefrigerant` integer: Defines whether an asset uses a refrigerant. **Possible values**: 0 - no, 1 - yes. - `Active` boolean: Shows whether an asset is still in use. **Possible values**: *true*, *false*. - `IsLeased` boolean: Defines whether an asset is leased. **Possible values**: *true*, *false*. - `LifeExpectancy` integer: Estimated useful life of an asset in months. - `OriginalValue` number, double: Original asset price. - `LeaseDate` string: Date and time when a lease was signed. - `LeasePeriod` integer: Period of time in months a contracted lease is in place. - `Condition` integer: Value representation of an asset condition. **Possible values**: `0` - *broken*, `25` - *poor*, `50` - *average*, `75` - *good*, `100` - *excellent*. - `ConditionString` string: Current condition of an asset. **Possible values**: *broken*, *poor*, *average*, *good*, *excellent*. - `EnergyEfficiency` string: Provides information on energy efficiency of a particular asset. Maximum is 150 characters. - `Capacity` string: Provides information on the maximum amount of the refrigerant an asset can contain. Maximum is 150 characters. - `HasLeakDetector` boolean: Defines whether an asset has a leak detector and belongs to the Leak Detector asset type. **Possible values**: *true*, *false*. - `AssetLeakDetectorConnectionId` integer: ID of the leak detector that is connected to an asset. - `Location` string: Place where an asset is physically located. - `Warranty` ServiceChannelServicesMessagingAssetsWarranty: Object containing warranty parameters. - `ExpirationDate` string, date-time: Warranty expiration date based on the warranty expiration settings. - `ProviderId` integer: ID of a provider who is in charge of warranty services. - `NTE` number, double: Maximum amount of money to be spent on warranty services in USD. Value -1 means that the amount is not applicable. - `Priority` string: Defines how quickly warranty services should be provided, for example, *Emergency-4 Hours*, *Normal-48 Hours*, *7 Days*. - `PriorityId` integer - `Category` string: Warranty category, for example, *ADVISE ONLY*, *REPAIR*, *DISASTER*. - `CategoryId` integer - `Provider` ServiceChannelServicesMessagingAssetsWarrantyProvider: Object containing warranty provider details. - `Type` 'Fixed' | 'PrimaryRanked' | 'FixedRanked': Defines the provider type responsible for warranty services. **Possible values**: `0` - Fixed provider, `1`- Primary rank provider, `2` - Fixed rank provider. - `Value` integer: Provider type value. Displays provider ID for the fixed provider type; provider rank number — from 1 to 100 — for the fixed rank type; 1 for a primary rank provider. - `ProviderName` string: Name of the provider who is in charge of warranty services. - `Expiration` ServiceChannelServicesMessagingAssetsWarrantyExpiration: Object containing warranty expiration details. - `Type` 'FromPurchaseDate' | 'FromInstallDate': Warranty expiration calculation type. **Possible values**: 0 - the expiration date is calculated starting from the asset purchase data; 1 - the expiration date is calculated starting from the asset installation date. - `Period` integer: Warranty period in months. - `IsReplaceEquipment` boolean: Defines if the current asset is a replacement for another on condition that a tracking number is provided. **Possible values**: *true*, *false*. - `HasTagged` boolean: Defines if an asset contains ‘Asset Tag’. - `LastModifiedUseDate` string, date-time: Date and time when an asset was last updated. - `LastModifiedUserName` string: Name of the user who updated an asset. - `SubName` string: Subscriber’s name who added an asset. - `AssetRefrigerant` ServiceChannelServicesMessagingRefrigerantTrackingAssetRefrigerant - `Id` integer - `AssetId` integer - `RefrigerantUsageType` integer - `RackId` string - `RackEntityId` integer - `CarbID` string - `IsCarbReporting` boolean - `SystemLocation` string, byte - `OperationalStatus` string, byte - `RefrigerantPartNumber` string - `PartNumberId` integer - `RackTypeId` integer - `CurrentCharge` number, double - `CurrentChargeMetrics` number, double - `CurrentChargeOunces` number, double - `ChargeDescriptionId` integer - `ChargeProviderName` string - `EffectiveChargeDate` string, date-time - `RefrigerantChargeOptionId` integer - `RackTypeName` string - `UserId` integer - `TagId` string - `AssetTypeId` integer - `RefrigerantPurposeId` integer - `RefrigerantPurposeName` string - `ParentId` integer - `CreateOperationalStatusHistory` boolean - `OperationStatusDate` string, date-time - `HasLeakDetector` boolean - `AssetLeakDetectorId` integer - `InitialCharge` boolean - `RackType` string, byte - `NeedsRetrofitRetirement` boolean - `RequiresAutomaticLeakDetector` boolean - `ConnectedRackId` integer - `PreviousConnectedRackId` integer - `UpdatedDate` string, date-time - `AssetAttributesMap` ServiceChannelServicesMessagingAssetsAssetAttributesMap - `StandardAttributesMap` integer - `ViewableForProvidersAttributesMap` integer - `EditableForProvidersAttributesMap` integer - `RequiredStandardAttributesMap` integer - `AssetTag` string: Unique alphanumeric decoded value contained in a barcode, QR code, or NFC tag of an asset. It is used to scan assets via [ServiceChannel Mobile](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/575341308/Asset+Tagging#AssetTagging-AccessingtheAssetScanningModuleinSCMobile) and [ServiceChannel Provider](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/1181745372/Scanning+and+Validating+Assets+via+SC+Provider+for+FTM+Internal+Techs). - `ImportedFrom` integer: Provides the number of the template an asset was imported from. - `ParentId` integer: Unique numeric identification of an asset that has a circuit or component. - `Description` string: Comment created by a user when adding an asset. - `HasComponents` boolean: Defines whether an asset has components. **Possible values**: *true*, *false*. - `HasCircuits` boolean: Defines if an asset has an added circuit. **Possible values**: *true*, *false*. - `IsCircuit` boolean: Defines whether an asset is a circuit. **Possible values**: *true*, *false*. - `SubscriberId` integer: Unique numeric ID of the subscriber an asset belongs to. - `AssetValidated` boolean: Defines whether the asset has been validated by a technician. **Possible values**: *true*, *false*. - `ValidationRequired` boolean: Defines whether an asset needs to be validated by a technician upon check-in. - `IsLeakDetector` boolean: Defines whether an asset belongs to the *Leak Detector* asset type. - `AssetStatus` string, byte: Defines an asset repair status. **Possible values**: `0` - *In Use*, `1` - *Out For Repair*, `2` - *Replacement Recommended*, `3` - *Repaired*. - `AssetUpdatesStatus` string, byte: Defines the asset update status. **Possible values**: 0 - Attributes updated by provider, 1- New unconfirmed - asset created by provider, 2 - Rejected, 3 - Asset change confirmed. - `AdditionalTradesNames` string: Names of the additional trades for an asset type. - `AdditionalTradeIds` integer[] - `CreatedDate` string, date-time: Date and time of the asset creation. - `ModifiedDate` string, date-time: Date and time of the last asset update. - `AssetTypeGroupId` integer: Unique ID of an asset type group. - `Spend` number, double: Total asset cost. Can be calculated if the *IncludeTotalCostOfOwnership* feature flag is enabled. - `IsCarbReporting` boolean: Defines whether an asset is included in a CARB report. **Possible values**: *true*, *false*. - `AssetValidationStatus` integer - `UnableToScanReason` string: Asset tag not scanned reason - `UnableToScanReasonCustomText` string: Asset tag not scanned reason custom text - `UnableToScanReasonId` integer: Asset tag not scanned reason id - `CustomAttributes` ServiceChannelServicesMessagingEquipmentsEquipmentAttributeDescription[]: Custom Attributes - `EquipmentAttributeId` integer - `EquipmentTypeAttributeId` integer - `ValueType` integer - `EquipmentId` integer - `Value` SystemObject - `ValueText` string - `SelectedOptionsText` string - `Visible` boolean - `Editable` boolean - `Required` boolean - `Name` string - `Custom` boolean - `HasChilds` boolean - `Currency` integer - `ModifiedDateDto` string, date-time: ModifiedDate datetime offset - `RetiredDate` string, date-time: Date and time of the asset deactivation. - `Assets` ServiceChannelServicesMessagingAssetsAssetResponse[] - `Id` integer: Unique numeric asset identifier assigned by the system. - `Tag` string: Alphanumeric asset identifier assigned by the client. - `Manufacturer` string: Company name that produces an asset. - `ModelNo` string: Asset model number. - `SerialNo` string: Asset serial number. - `LocationId` integer: Unique numeric identifier of a location an asset is assigned to. - `Area` string: Place where an asset is physically located. - `WorkOrderArea` string: Work order area, such as *Dining Room*, *Kitchen*, *Storage*. - `StoreId` string: Alphanumeric location identifier assigned by the client. - `Trade` string: Trade of an asset type the asset is assigned to, for example, *HVAC*, *DOORS*, *ELECTRICAL*. - `TradeId` integer: Numeric identifier of the primary trade of an asset. - `Type` string: Asset type, for example, *Refrigerator*, *Computer Monitor*, etc. - `AssetTypeId` integer: Unique numeric identifier of an asset type. - `BrandId` integer: Unique numeric identifier of a manufacturer that produces an asset. - `InstallDate` string: Date and time when an asset was installed at the current location. - `InstallDateVal` string, date-time: Date and time when an asset was installed at the current location. - `ManufacturerDate` string, date-time: Date and time when an asset was produced. - `ManufacturerDateStr` string: Date and time when an asset was produced by the manufacturer. - `PurchaseDate` string: Date and time when an asset was purchased. - `UsesRefrigerant` integer: Defines whether an asset uses a refrigerant. **Possible values**: 0 - no, 1 - yes. - `Active` boolean: Shows whether an asset is still in use. **Possible values**: *true*, *false*. - `IsLeased` boolean: Defines whether an asset is leased. **Possible values**: *true*, *false*. - `LifeExpectancy` integer: Estimated useful life of an asset in months. - `OriginalValue` number, double: Original asset price. - `LeaseDate` string: Date and time when a lease was signed. - `LeasePeriod` integer: Period of time in months a contracted lease is in place. - `Condition` integer: Value representation of an asset condition. **Possible values**: `0` - *broken*, `25` - *poor*, `50` - *average*, `75` - *good*, `100` - *excellent*. - `ConditionString` string: Current condition of an asset. **Possible values**: *broken*, *poor*, *average*, *good*, *excellent*. - `EnergyEfficiency` string: Provides information on energy efficiency of a particular asset. Maximum is 150 characters. - `Capacity` string: Provides information on the maximum amount of the refrigerant an asset can contain. Maximum is 150 characters. - `HasLeakDetector` boolean: Defines whether an asset has a leak detector and belongs to the Leak Detector asset type. **Possible values**: *true*, *false*. - `AssetLeakDetectorConnectionId` integer: ID of the leak detector that is connected to an asset. - `Location` string: Place where an asset is physically located. - `Warranty` ServiceChannelServicesMessagingAssetsWarranty: Object containing warranty parameters. - `ExpirationDate` string, date-time: Warranty expiration date based on the warranty expiration settings. - `ProviderId` integer: ID of a provider who is in charge of warranty services. - `NTE` number, double: Maximum amount of money to be spent on warranty services in USD. Value -1 means that the amount is not applicable. - `Priority` string: Defines how quickly warranty services should be provided, for example, *Emergency-4 Hours*, *Normal-48 Hours*, *7 Days*. - `PriorityId` integer - `Category` string: Warranty category, for example, *ADVISE ONLY*, *REPAIR*, *DISASTER*. - `CategoryId` integer - `Provider` ServiceChannelServicesMessagingAssetsWarrantyProvider: Object containing warranty provider details. - `Type` 'Fixed' | 'PrimaryRanked' | 'FixedRanked': Defines the provider type responsible for warranty services. **Possible values**: `0` - Fixed provider, `1`- Primary rank provider, `2` - Fixed rank provider. - `Value` integer: Provider type value. Displays provider ID for the fixed provider type; provider rank number — from 1 to 100 — for the fixed rank type; 1 for a primary rank provider. - `ProviderName` string: Name of the provider who is in charge of warranty services. - `Expiration` ServiceChannelServicesMessagingAssetsWarrantyExpiration: Object containing warranty expiration details. - `Type` 'FromPurchaseDate' | 'FromInstallDate': Warranty expiration calculation type. **Possible values**: 0 - the expiration date is calculated starting from the asset purchase data; 1 - the expiration date is calculated starting from the asset installation date. - `Period` integer: Warranty period in months. - `IsReplaceEquipment` boolean: Defines if the current asset is a replacement for another on condition that a tracking number is provided. **Possible values**: *true*, *false*. - `HasTagged` boolean: Defines if an asset contains ‘Asset Tag’. - `LastModifiedUseDate` string, date-time: Date and time when an asset was last updated. - `LastModifiedUserName` string: Name of the user who updated an asset. - `SubName` string: Subscriber’s name who added an asset. - `AssetRefrigerant` ServiceChannelServicesMessagingRefrigerantTrackingAssetRefrigerant - `Id` integer - `AssetId` integer - `RefrigerantUsageType` integer - `RackId` string - `RackEntityId` integer - `CarbID` string - `IsCarbReporting` boolean - `SystemLocation` string, byte - `OperationalStatus` string, byte - `RefrigerantPartNumber` string - `PartNumberId` integer - `RackTypeId` integer - `CurrentCharge` number, double - `CurrentChargeMetrics` number, double - `CurrentChargeOunces` number, double - `ChargeDescriptionId` integer - `ChargeProviderName` string - `EffectiveChargeDate` string, date-time - `RefrigerantChargeOptionId` integer - `RackTypeName` string - `UserId` integer - `TagId` string - `AssetTypeId` integer - `RefrigerantPurposeId` integer - `RefrigerantPurposeName` string - `ParentId` integer - `CreateOperationalStatusHistory` boolean - `OperationStatusDate` string, date-time - `HasLeakDetector` boolean - `AssetLeakDetectorId` integer - `InitialCharge` boolean - `RackType` string, byte - `NeedsRetrofitRetirement` boolean - `RequiresAutomaticLeakDetector` boolean - `ConnectedRackId` integer - `PreviousConnectedRackId` integer - `UpdatedDate` string, date-time - `AssetAttributesMap` ServiceChannelServicesMessagingAssetsAssetAttributesMap - `StandardAttributesMap` integer - `ViewableForProvidersAttributesMap` integer - `EditableForProvidersAttributesMap` integer - `RequiredStandardAttributesMap` integer - `AssetTag` string: Unique alphanumeric decoded value contained in a barcode, QR code, or NFC tag of an asset. It is used to scan assets via [ServiceChannel Mobile](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/575341308/Asset+Tagging#AssetTagging-AccessingtheAssetScanningModuleinSCMobile) and [ServiceChannel Provider](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/1181745372/Scanning+and+Validating+Assets+via+SC+Provider+for+FTM+Internal+Techs). - `ImportedFrom` integer: Provides the number of the template an asset was imported from. - `ParentId` integer: Unique numeric identification of an asset that has a circuit or component. - `Description` string: Comment created by a user when adding an asset. - `HasComponents` boolean: Defines whether an asset has components. **Possible values**: *true*, *false*. - `HasCircuits` boolean: Defines if an asset has an added circuit. **Possible values**: *true*, *false*. - `IsCircuit` boolean: Defines whether an asset is a circuit. **Possible values**: *true*, *false*. - `SubscriberId` integer: Unique numeric ID of the subscriber an asset belongs to. - `AssetValidated` boolean: Defines whether the asset has been validated by a technician. **Possible values**: *true*, *false*. - `ValidationRequired` boolean: Defines whether an asset needs to be validated by a technician upon check-in. - `IsLeakDetector` boolean: Defines whether an asset belongs to the *Leak Detector* asset type. - `AssetStatus` string, byte: Defines an asset repair status. **Possible values**: `0` - *In Use*, `1` - *Out For Repair*, `2` - *Replacement Recommended*, `3` - *Repaired*. - `AssetUpdatesStatus` string, byte: Defines the asset update status. **Possible values**: 0 - Attributes updated by provider, 1- New unconfirmed - asset created by provider, 2 - Rejected, 3 - Asset change confirmed. - `AdditionalTradesNames` string: Names of the additional trades for an asset type. - `AdditionalTradeIds` integer[] - `CreatedDate` string, date-time: Date and time of the asset creation. - `ModifiedDate` string, date-time: Date and time of the last asset update. - `AssetTypeGroupId` integer: Unique ID of an asset type group. - `Spend` number, double: Total asset cost. Can be calculated if the *IncludeTotalCostOfOwnership* feature flag is enabled. - `IsCarbReporting` boolean: Defines whether an asset is included in a CARB report. **Possible values**: *true*, *false*. - `AssetValidationStatus` integer - `UnableToScanReason` string: Asset tag not scanned reason - `UnableToScanReasonCustomText` string: Asset tag not scanned reason custom text - `UnableToScanReasonId` integer: Asset tag not scanned reason id - `CustomAttributes` ServiceChannelServicesMessagingEquipmentsEquipmentAttributeDescription[]: Custom Attributes - `EquipmentAttributeId` integer - `EquipmentTypeAttributeId` integer - `ValueType` integer - `EquipmentId` integer - `Value` SystemObject - `ValueText` string - `SelectedOptionsText` string - `Visible` boolean - `Editable` boolean - `Required` boolean - `Name` string - `Custom` boolean - `HasChilds` boolean - `Currency` integer - `ModifiedDateDto` string, date-time: ModifiedDate datetime offset - `RetiredDate` string, date-time: Date and time of the asset deactivation. - `AssetCount` integer - `Attachments` ServiceChannelServicesMessagingAttachmentsAttachmentsDescriptor - `Count` ServiceChannelServicesMessagingCountDescriptor - `Total` integer - `Own` integer - `Notes` ServiceChannelServicesMessagingNotesNotesDescriptor - `WorkOrderId` integer - `Last` ServiceChannelServicesMessagingNotesNoteInfo - `Id` integer - `DocumentId` string - `Number` integer - `NoteData` string - `DateCreated` string, date-time - `DateCreated_DTO` string, date-time - `ActionRequired` boolean - `MailedTo` string - `CreatedBy` string - `Count` ServiceChannelServicesMessagingCountDescriptor - `Total` integer - `Own` integer - `PostedId` integer: Gets or sets PostedId. - `LinkedWorkOrders` ServiceChannelServicesMessagingIdentityObject[] - `Id` integer - `LinkedInWorkOrders` ServiceChannelServicesMessagingIdentityObject[] - `Id` integer - `IsCheckInDenied` boolean: Gets or sets a value indicating whether IsDenied. - `CheckInDeniedReason` string: Gets or sets Reason. - `RecallWorkOrder` integer: Recall WorkOrder Id - `ReassignedRecallWorkOrder` integer: Reassigned Recall WorkOrder Id - `IsInvoiced` boolean: Gets or sets IsInvoiced. - `IsExpired` boolean: Gets or sets IsExpired. - `IsEnabledForMobile` boolean: Gets or sets value that allowed clients to manage their vendors to participate in the mobile App process. - `HasWorkActivity` boolean - `Source` string - `ClosingAuthorizationNumber` integer - `CallerId` integer - `AutoComplete` boolean - `Labels` ServiceChannelApiModelWorkordersWorkOrderLabel[] - `Id` integer - `Label` string - `AutoInvoice` boolean - `Assignee` ServiceChannelServicesMessagingWorkordersAssigneeUser - `UserId` integer - `UserName` string - `ProjectId` integer - `FrequencyId` integer - `ServiceId` integer - `WeatherEvent` ServiceChannelServicesMessagingWorkordersWeatherEvent - `Id` integer - `Name` string - `WorkFlowType` integer - `ProjectedCompletionDate_DTO` string, date-time - `OriginalProjectedCompletionDate_DTO` string, date-time --- [API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)