HomeGuidesAPI ReferenceAnnouncements
HomeGuidesAPI ReferenceChangelogDeveloper Q&A
HomeGuidesAPI ReferenceAnnouncementsLog In

API Models for 9.23

​ ​

Corrigo Enterprise Integration Api


Entities :

TaxCode

Property Name Property Value Property Description
DisplayAs String Displayable name.
ExtId String Gets or sets a external ID (used to communicate with third-party tax service)
Descr String Gets or sets a description, this field is optional
Country String Gets or sets a country, this field is optional
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

InvoiceDictionaryItem

Property Name Property Value Property Description
Descr String Gets or sets a description, this field is optional
TaxCode {TaxCode entity reference} Gets or sets a tax code object
CostCategory CostCategory enumeration member Gest or sets a cost category
GlExpense String Gets or sets GL expense code, this field is optional
GlIncome String Gets or sets GL expense code, this field is optional
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
DisplayAs String Gets or sets the display as CorrigoNet entity value.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

BillingAccount

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
CpThemeId Integer Customer Portal Theme linked to the record; references CPThemeObject.ID. Supported by Customer Group only.
IsBillAcct Boolean Boolean flag defining object type. False means Customer Group; True means Billing Account.
Number String Number (often used as integration key). Supported by both object types.
PaymentTerms String Payment terms; free-text. Supported by Billing Account only.
PaymentNumberOfDays Integer Number of days in which Customer Invoice becomes due. Allowed values 0 - 999. Supported by Billing Account only.
PaymentInstrustions String Payment instructions; free-text. Supported by Billing Account only.
IsCreditHold Boolean Boolean flag; may be set manually to identify customers who became overdue on their payments. Supported by Billing Account only.
AccrualMargin Integer Accrual Margin, "whole" percentage value. Supported values are 0 -99. Supported by Billing Account only.
SalesRep String Name of the sales representative, free-text, optional. Supported by Billing Account only.
IsTaxExempt Boolean True means tax exemption status applies to Customer Invoices. Supported by Billing Account only.
CorpEntity {CorporateEntity entity reference} Financial Entity collecting sales tax. References CompanyObject.ID. Supported by Billing Account only.
Balance Decimal Outstanding balance computed based on Customer Invoices and Payments activity. Supported by Billing Account only.
PayDayType Byte Defines billing schedule type.
PayDayNumber Byte Defines billing schedule day. Supported values depend on payDayWeekday
IsSelfSelect Boolean True means Customer Group is available for Contact's self-selection on Customer Portal. Supported by Customer Group only.
CurrencyTypeId CurrencyType enumeration member Chosen currency, references LangLookup.ID.
Users [{LinkUserAndCustomerGroup entity reference}, ...]
Customers [{LinkCustomerAndGroup entity reference}, ...]
Contacts [{LinkContactAndGroup entity reference}, ...]
CustomFields [{CustomField2 entity reference}, ...]
Address {Address2 entity reference}
Notes [{Note entity reference}, ...]
SynchronizeNte Boolean Boolean flag; True means Customer NTE change affects Vendor NTE for WOs linked to this Billing Account. Supported by Billing Accounts only.
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WorkOrder

Property Name Property Value Property Description
Number String Gets a work order number. Automatically generated if not supplied automatically. Max Length=32
TypeCategory WOType enumeration member Type: Unknown, Basic, PMRM(Preventive Maintenance/Routine Maintenance), Turn, Request. It determines behavior of the work order during its lifecycle. Is required.
WorkOrderCost {WorkOrderCost entity reference} WO Invoice. Financial Record represents Work Order's data related to financial side of the workflow: costs tracking, vendor invoice, service fees etc.
Priority {WoPriority entity reference} It indicates the urgency level of the work order.
StatusId WorkOrderStatus enumeration member Status: Unknown, Open, Paused, Cancelled, Closed, Attention, New, OnHold, InProgress, Completed
RequestorContact {Contact entity reference} Requestor contact data
Access PTEType enumeration member Access: Unknown, PTE, Appointment, CallFirst, NotApplicable
MainAsset {Location entity reference} Asset representing main WO location
ShortLocation String Shortened asset inventory location for display purposes. Max Length=128
TaskRefinement String Contains work description for the Work Order. This value is automatically generated or entered by user manually. Max Length=512
WorkZone {WorkZone entity reference} NonUpdatable. Specifies an area in which service is provided
Employee {Employee entity reference} NonUpdatable. Primary technician responsible for executing of the work order
Duration Integer Expected duration for the work related to this work order in minutes.
VendorNte {MoneyValue entity reference} NTE (Not to Exceed) for vendor invoice.
Specialty {Specialty entity reference} Specifies what type of work needs to be done for this work order
PoNumber String Purchase Order Number. Max Length=50
SubType {WorkOrderType entity reference} Work order custom type. Each custom type corresponds to one of the base work order type. References table [vlangWOTypeLookup]. Is required.
RepairCode {RepairCode entity reference} Repair codes are a means of gathering completion data in the field. These codes are not limited to repair data. It can be customized and used to capture whatever kind of information that is most useful for organization to collect.
Customer {Customer entity reference} Customer. Is required.
ContactName String Contact name. Max Length=256
WonId Integer WON (Work Order Network) Id.
IsWarranty Boolean "True" means WO might be covered by provider's warranty.
Flag {WoActionReasonLookup entity reference} Action Reason. References table [WOActionReasonLookup]
FlagId Integer Action Reason ID.
TimeZone Integer Time Zone
CurrencyTypeId CurrencyType enumeration member Currency Type
LastActionDate DateTime Last Action Date
DtCreated DateTime Date the work order was created. If not specified will be Now().
DtScheduledStart DateTime or NULL Work Order scheduled start time
DtDue DateTime or NULL Local time indicating moment when WO becomes overdue; Computed based on work zone settings and WO priority (which makes it dependent on WO items); can be overridden by end user
DtAcknowledgeBy DateTime or NULL Local time indicating moment by which WO needs to be "acknowledged", i.e. picked up; NULL means value is undefined.
AcknowledgeByUtc DateTime or NULL UTC time indicating moment by which WO needs to be "acknowledged", i.e. picked up; NULL means value is undefined.
LastActionDateUtc DateTime Last Action Date Utc
CreatedDateUtc DateTime Date Utc the work order was created. If not specified will be UtcNow().
ScheduledStartUtc DateTime or NULL Work Order scheduled Utc start time. If not specified will be UtcNow().
DueDateUtc DateTime or NULL Utc time indicating moment when WO becomes overdue
DtOnSiteBy DateTime or NULL Local time indicating moment by which WO needs to be "responded to", i.e. started; Computed based on WO priority (which makes it dependent on WO items); can be overridden by end user.
DtUtcOnSiteBy DateTime or NULL Utc time indicating moment by which WO needs to be "responded to", i.e. started
LastAction {WoLastAction entity reference} Last Action. WO Shadow record.
Address {Address2 entity reference} Address
Items [{WoItem entity reference}, ...] Work order tasks.
EquipmentWorkedOn [{WoEquipment entity reference}, ...] Equipment
Notes [{WoNote entity reference}, ...] Notes
CompletionNote {WoNote entity reference} Completion Note
ContactAddress {ContactInfo entity reference} Contact Address. Is required.
Assignments [{WoAssignment entity reference}, ...] Assignments
Procedures [{WoProcedure entity reference}, ...] Punch List Items
Documents [{Document entity reference}, ...] Documents
CustomFields [{CustomField2 entity reference}, ...] Custom Fields
Verifications [{WoVerification entity reference}, ...] Verifications. (WO Ratings)
Quote {WoQuote entity reference} Quote
CheckInOuts [{WoOnSite entity reference}, ...] Check In/Outs Log
ActionLogRecords [{WoActionLog entity reference}, ...] Action Logs
Estimate {WoEstimate entity reference} Customer Estimate
Owner {Employee entity reference} WO Owner
InductionAndSafetyStatusID IsmStatus enumeration member Induction and Safety Management(ISM) status ID, references vlangIsmStatus.ID; also matches enumeration IsmStatus. This field is not supposed to be updated directly.
Flags [{WoFlag entity reference}, ...]
WoSecondarySchedules [{WoSchedule entity reference}, ...]
Score Integer Wo Score
TravelTimeFrom Integer Estimated time to travel from the work order location.
TravelTimeTo Integer Estimated time to travel to the work order location.
Visits [{WoVisit entity reference}, ...]
VisitServices [{WoVisitSvc entity reference}, ...] Visit Services Data.
WoVisitCfgList [{WoVisitCfg entity reference}, ...] Visit Configuration List
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Location

Property Name Property Value Property Description
Name String Gets a location name. Max Length=64. Is required.
Address {Address2 entity reference} Gets a location address. Is required.
ModelId Integer Model Id. Is required.
Orphan Boolean True means Asset is orphaned. Is required.
TypeId AssetType enumeration member Asset Category: Unknown, Regular, Building, Unit, Community, RoomArea, Floor, Utility, Equipment. Is required.
ParentId Integer "Fake" field without underlying table field; used only in insert/update operations. Can't be used in query conditions and can't be retrieved. Is required.
RootId Integer "Fake" field without underlying table field; used only in insert operations. Can't be used in query conditions and can't be retrieved. Is required.
IsTemplate Boolean "Fake" field without underlying table field; used only in insert/update/delete operations. "True" when asset is a part of template hierarchy - not real work zone asset. Is required.
Info {AssetInfo entity reference} Asset additional info.
Documents [{Document entity reference}, ...] Asset documents: links and/or files.
IsOffline Boolean "True" when asset is offline.
IsLocked Boolean "True" when asset is locked.
IsRestricted Boolean "True" means Asset is critical.
Attributes [{AssetAttribute entity reference}, ...]
IsDirectParts Boolean "True" means DirectParts=Yes.
DirectParts [{LinkProductAndQtyAttribute entity reference}, ...] Gets list of DirectParts. Used for: ProductId, Qty
IncludeNonControllableExpenses Boolean "True" means Includes non-controllable expenses in Reactive Spend
CriticalFacilities CriticalFacilitiesSettingValues or NULL Defines whether the {!{Unit}!} is considered a Critical Facility. If set to "Yes", then all {!{Work Orders}!} manually created in this {!{Unit}!} will go through the Approval flow. If set to "Inherit from parent", the {!{Property}!} criticality (including possible multiple Primary {!{Portfolios}!} inheritance) will be used to determine the criticality of the {!{Unit}!}.
CommunityId Integer CommunityId field which represents the id of the Work Zone for the asset.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Address

Property Name Property Value Property Description
Street String Gets a street
City String Gets a city
State String Gets a state
Zip String Gets a zip code
Street2 String Gets a street2
ActorTypeId Integer Gets a actor type id
TypeId Char Gets a address type id
ActorId Integer Gets a actor id
Latitude Double Gets a latitude
Longitude Double Gets a longitude
Country String Gets a country
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Customer

Property Name Property Value Property Description
DisplayAs String Gets a display as value. Max Length=64. Is required.
Name String Customer's name. Max Length=64. Is required.
WorkZone {WorkZone entity reference} Community, the Work Zone to which Customer belongs. Is required.
Dba String Gets a DBA (Doing business as) value. Max Length=64. Is required.
Instructions String Service instructions to relay to team members who are visiting this customer, HTML content supported. Max Length=3072.
TenantCode String Gets a tenant code - unique number, usually used to map customer to external system. Max Length=64. Is required.
TaxExempt Boolean Gets a value indicating whether this customer can be defined as tax exemption, True means Customer doesn't pay sales taxes (used by Customer Invoices). Is required.
Spaces [{Space entity reference}, ...] Spaces. Space (sometimes called Location) is occupancy record connecting Customer and Unit. Space means that Customer occupies particular Unit Asset.
Contacts [{Contact entity reference}, ...] Contacts are persons who are working for Customer and who actively participate in Work Order lifecycle. Is required.
CustomFields [{CustomField2 entity reference}, ...] Custom Fields
Notes [{Note entity reference}, ...] Notes
Addresses [{Address2 entity reference}, ...] Zero or one Street Address. Is required.
Contract {Contract entity reference} Default Financial contract assigned when work order is created for this customer, if it's not defined - the work zone contract will be used. Contract affects costs, vendor invoice/WON, charges etc.
GroupsBridge [{LinkCustomerAndGroup entity reference}, ...] Customer Groups. Is required.
ApprovalScopes [{ApprovalScope entity reference}, ...]
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Invoice

Property Name Property Value Property Description
CurrencyTypeId CurrencyType enumeration member Currency type inherited from work zone upon WO creation. References vlangLangLookup.ID; also matches enumeration CurrencyType. Modifications for existing records are not allowed.
TimeSetId Integer Gets a time period ID
Period {TimePeriod entity reference} TimePeriod object defined by TimeSetId
Group {BillingAccount entity reference} Gets a billing account object
BillingContact {Contact entity reference} Billing Contact associated with the Billing Account
Number String Gets a invoice number; initially empty, generated by Post action
State CiInvoiceState enumeration member Gets a invoice state; supported values are draft, posted, paid, paid in full, credit, credit used.
PoNumber String Gets an optional field used for customer reference
DtDue DateTime or NULL Gets an invoice due date computed when invoice is posted; initially empty
GlAccount String Gets a GL account number
Comments String Gets a comments
AmtBase {MoneyValue entity reference} Gets an invoice subtotal before tax
AmtTax {MoneyValue entity reference} Gets an invoice total tax amount
AmtTotal {MoneyValue entity reference} Gets an invoice total amount (base + tax)
IsMultiline Boolean Gets a value indicating whether this invoice consists of more than one line item
TaxTransactionId String Gets a tax transaction ID (non-empty value means tax was computed)
IsTaxDirty Boolean Gets a value indicating whether invoice content was changed since tax was computed.
LineItems [{InvoiceLine entity reference}, ...] Gets a line items collection.
ExtNumber String Gets or sets an external number
DtPosted DateTime or NULL Date of "posted" action; a.k.a. Invoice Date
IsManuallySent Boolean True means Customer Invoice was sent manually to the client (i.e. as e-mail, rather than electronically through Corrigo platform). This flag is available for posted Customer Invoices.
DraftProcessStepId DraftProcessStep enumeration member Sub-status value, used when Customer Invoice status is Draft. Indicates either desired action (such as "Customer Invoice is ready to Post") or result of the action (such as "Post operation failed").
CanExpedite Boolean Option for the SPs to request Expedite flag on their invoices
CanEarlyPayment Boolean Option for the SPs to request Early payment flag on their invoices
IsAvailableExpeditedInvoiceFlags Boolean Read only settings for Invoice Flags
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

InvoiceLine

Property Name Property Value Property Description
CurrencyTypeId CurrencyType enumeration member Currency type inherited from work zone upon WO creation. Modifications for existing records are not allowed.
InvoiceItem {InvoiceDictionaryItem entity reference} Invoice dictionary item object
WorkOrder {WorkOrder entity reference} Gets a work order object
Location {Location entity reference} Location object
Customer {Customer entity reference} Gets a customer object
Type CiItemType enumeration member Gets a type of the relationship with WO; supported values are single WO, group header, group child, none
DtService DateTime or NULL Date of service; supported for items associated with WOs
Descr String Description
Qty Decimal Quantity, precision is up to 5 digits
Rate {MoneyValue entity reference} Rate
TaxRate Decimal Gets a tax rate, precision is up to 5 digits
AmtTax {MoneyValue entity reference} Gets a tax amount (computed by tax software)
AmtTotal {MoneyValue entity reference} Gets a total amount
TaxCode String Get or set tax code.
TaxCodeReference {TaxCode entity reference} Get or set tax code reference.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

CorporateEntity

Property Name Property Value Property Description
DisplayAs String Gets or sets a display as value
Number String Gets or sets a number
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

GLAccount

Property Name Property Value Property Description
DisplayAs String Gets or sets a display as value.
Descr String Gets or sets a description, this field is optional.
IsIncome Boolean Gets or sets a value indicating whether this account is income
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Payment

Property Name Property Value Property Description
CurrencyTypeId CurrencyType enumeration member
Group {BillingAccount entity reference} Gets or sets a billing account object
Number String Gets a payment number; initially empty, generated by Post action.
State PaymentState enumeration member Gets a payment state; Supported values are draft, posted, posted-credit.
Comments String Gets or sets comments, optional.
Method PaymentMethod enumeration member Gets or sets a payment method; Supported values are check (default), cash, credit card, EFT, account credit.
Reference String Gets o sets reference or check number, optional.
DtStamp DateTime Gets or sets a payment date (set by user explicitly), required.
AmtPayment {MoneyValue entity reference} Gets or sets amount that came from customer (credits not included), cannot be negative.
AmtBalance {MoneyValue entity reference} Remaining balance, cannot be negative. Calculated automatically as payment amount plus used credits minus amounts applied to invoices.
DtPosted DateTime or NULL Gets a remaining balance, cannot be negative. Calculated automatically as payment amount plus used credits minus amounts applied to invoices.
TimeSetId Integer Gets or sets a time period ID
Items [{PaymentItem entity reference}, ...] Gets or sets an items collection.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

PaymentItem

Property Name Property Value Property Description
CurrencyTypeId CurrencyType enumeration member
ObjectTypeId ActorType enumeration member Gets or sets type ID of the object referenced by record. Required. For credit records it either #29 (credit memo) or #30 (payment). For non-credit records it's always #29 (invoice).
ObjectId Integer Gets or sets reference to object which record is based upon, either invoice/credit memo or payment. Required.
IsCredit Boolean Gets or sets a value indicating whether this record stores credit used (true - credit otherwise debit).
AmtBalance {MoneyValue entity reference} Gets an object's (credit memo/invoice or payment) remaining balance BEFORE payment was posted. Optional. Zero for draft payments.
AmtUsed {MoneyValue entity reference} Gets or sets amount taken from credit (auto-calculated), or amount applied to invoice (entered by user). Cannot be negative; zero is allowed only for credit records.
RefInvoice {Invoice entity reference} Gets an invoice on which payment is based. Based on and
RefPayment {Payment entity reference} Gets a payment on which payment is based. Based on and
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Employee

Property Name Property Value Property Description
FirstName String First name. Max Length=80. Is required.
LastName String Last name. Max Length=176. Is required.
DisplayAs String Displayable name. Max Length=256. Is required.
Role {Role entity reference} Role. Is required.
AccessToAllWorkZones Boolean True means Technician has access to all work zones and thus his Team, Portfolio and direct Work Zone scope are irrelevant for determining list of accessible work zones.
LanguageId Integer Preferred language
ActorTypeId ActorType enumeration member Should be ActorType.Employee. Is required.
Username String User ID. Max Length=256. Is required.
DtPwdChange DateTime Date (no time part) when password was set/changed last time; based on server time. This value is used by code enforcing password policies.
ProviderInvitedOn DateTime or NULL Date (no time part) when Provider was invited to WON (Work Order Network) last time. This field is not used by Technicians.
Instructions String Special instructions. Max Length=3072.
WonMemberId Integer WON (Work Order Network) member ID; non-zero indicates connected Providers. This field is not used by Technicians.
WonLocationId Integer WON (Work Order Network) location ID;
WonServiceRadius Integer Service radius in miles or kilometers, depending on WonRadiusType value. Is required.
IsElectronicPayment Boolean True means Provider prefers electronic payments. This field is not used by Technicians.
ProviderStatusId EmployeeWonStatus enumeration member WON (Work Order Network) status. This field is computed automatically in response to modifications for certain fields.
LabelId Integer User-defined Provider label. This field is not used by Technicians.
FreeTextAllowed Boolean True means Provider can enter free-text entries (i.e. not based on price list imposed by requestor) when preparing invoices. This field is not used by Technicians.
RadiusUnit DistanceUnit enumeration member Stores units for service radius. Supported values are kilometers and miles.
Password String User's password for login. Max Length=64. Is required.
Number String Number (often used as integration key). Max Length=64.
JobTitle String Job Title. Max Length=256.
FederalId String Federal ID#. Used for tax purposes. Max Length=64.
ExternalId String Used by Providers. Max Length=64.
ForcePasswordReset Boolean True means Technician must reset his password upon login. This field is not used by Providers.
TaxWarnOnly Boolean Tax Warn Only
DefaultPriceList {PriceList entity reference} Default Price List
PriceLists [{LinkProviderPriceList entity reference}, ...] Price Lists
CustomFields [{CustomField2 entity reference}, ...] Custom Fields
Organization {Organization entity reference} Organization Bridge
BillAtZero Boolean Bill At Zero
IsSupplier Boolean Is Supplier [Obsolete("Disabled for writing since 9.6su1")]
ProviderTypeId ProviderlType enumeration member ProviderTypeId (tied with Is Supplier for backward compatibility)
ContactAddresses [{ContactInfo entity reference}, ...] Contact Addresses
Certifications [{UserCertification entity reference}, ...] Certifications
Address {Address2 entity reference} Address
Teams [{LinkUserAndTeam entity reference}, ...] Teams
WorkZones [{LinkUserAndWorkZone entity reference}, ...] Work Zones
Portfolios [{LinkUserAndPortfolio entity reference}, ...] Portfolios
CustomerGroups [{LinkUserAndCustomerGroup entity reference}, ...] Customer Groups
Specialties [{LinkUserAndSpecialty entity reference}, ...] Specialties
PayRates [{UserPayRate entity reference}, ...] Pay Rates
StockLocations [{LinkUserAndStockLocation entity reference}, ...] Stock Locations
Services [{LinkProviderAndService entity reference}, ...] Services
AlertSubscriptions [{AlertSubscription entity reference}, ...] Alert Subscriptions
TaxExempt Boolean TaxExempt
LimitAssignmentByPortfolioId Integer
PriceListIntegrationStatus PriceListIntegrationStatus enumeration member PriceListIntegrationStatus
PriceListIntegrationEnabled Boolean or NULL PriceListIntegrationEnabled
PriceListIntegrationDate DateTime or NULL Last sync date for specific company
StartAddress {Address2 entity reference} StartAddress. This value comes from StartLocation property.
ShiftHours [{EmpShiftHours entity reference}, ...]
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WorkZone

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
Asset {Location entity reference} Root of work zone's asset tree; references InvItemObject.ID.
TimeZone Integer Time zone ID used by all work orders and other objects associated with work zone.
LanguageId Integer Usage is not clear.
WoNumberPrefix String Used as WO number prefix when creating the Work Order.
Entity String Identifies larger entity Work Zone belongs to; used by integration and by JLL WON setup (aggregator instance keeps requestor name in that field).
SchedulingWindow Integer Scheduling/appointment window size in minutes. Supported values are 15 - 1440 (i.e. up to 24 hours).
NoIncompleteProcedure Boolean Boolean flag. True means WOs with incomplete punch list are not allowed to be completed.
AccessOptionsMask Integer Bitmask defining what access/PTE options are allowed for Work Zone; each bit matches PTEType enumeration value (except Unknown). Zero value is not allowed.
Number String Number (often used as integration key). This value is either empty or unique.
AdvanceNotice Integer Number of hours from current date/time that the first appointment may be scheduled. Supported values are 0 - 240 (up to 10 days).
TaxRegion {TaxRegion entity reference} Tax Region ID, optional. References DefTaxObject.ID.
WoNumberDigits Integer Number of digits in WO number numeric suffix. Supported values are 1 - 10.
RoundApptTimeTo Integer Defines appointment time rounding value in minutes (i.e. "round appointment start time to closest X minutes"). Supported values are 15, 30 and 60.
WorkPlanAutoCancel Boolean Boolean flag; True means child WOs will be automatically cancelled when their parent or root are cancelled.
WorkPlanChildResolution Boolean Boolean flag; True means work plan root WO cannot be completed until it has pending child WOs (e.g. not completed/cancelled).
WorkPlanAutoDependency Boolean Boolean flag; True means dependent sibling WO will be reopened or put on hold when status of "primary" WO changes in certain way.
CpThemeId Integer Customer Portal Theme associated with Work Zone; references CPThemeObject.ID.
DefaultAccess PTEType enumeration member Default access/PTE option; references vlangPTETypeLookup.ID; also matches enumeration PTEType. Zero value is not allowed.
AutoAssignEnabled Boolean Boolean flag; True means routing by Specialty is enabled.
BackupRoutingId BackupRouting enumeration member
BillingAccount {BillingAccount entity reference} Billing Account linked to Work Zone; references lsGroupObject.ID.
Contract {Contract entity reference} Contract linked to Work Zone; references WOCostDefaultObject.ID.
NoIncompleteItem Boolean Boolean flag. True means WOs with incomplete Items (i.e. WO Item Disposition is not "done") are not allowed to be completed.
UiShowProvidersFirst Boolean Boolean flag. True means "Providers" tab should appear first when WO Assignment dialog opens (False means "Technicians" tab will appear).
CurrencyTypeId CurrencyType enumeration member Chosen currency, references LangLookup.ID. Regarding UPD#2, it is recommended to update currency type separately from modifying other objects
IsOffline Boolean Boolean flag; True means Work Zone is offline/disabled (WO creation limited; PM Schedules suspended; Customer may be deactivated, etc.).
ContactAddresses [{ContactInfo entity reference}, ...]
CustomFields [{CustomField2 entity reference}, ...]
Portfolios [{LinkPortfolioAndWorkZone entity reference}, ...]
SlaValues [{SlaValuesOverride entity reference}, ...]
Teams [{LinkTeamAndWorkZone entity reference}, ...]
BizHours [{BusinessHours entity reference}, ...]
BlackoutDays [{BlackoutDay entity reference}, ...]
Holidays [{Holiday entity reference}, ...]
EscalationRules [{EscalationRule entity reference}, ...]
SpecDispatchRules [{SpecDispatchRule entity reference}, ...]
OnCallRules [{OnCallRule entity reference}, ...]
Responsibilities [{Responsibility entity reference}, ...]
UseBizHours Boolean True means Work Zones's/Portfolio's Business Hours data will participate in workflow inheritance (even when such data is missing).
UseHolidays Boolean True means Work Zones's/Portfolio's Holidays data will participate in workflow inheritance (even when such data is missing).
UseBlackoutDays Boolean True means Work Zones's/Portfolio's Blackout Date data will participate in workflow inheritance (even when such data is missing).
UseOnCall Boolean True means Work Zones's/Portfolio's On Call data will participate in workflow inheritance (even when such data is missing).
UseEscalation Boolean True means Work Zone's/Portfolio's Escalation List data will participate in workflow inheritance (even when such data is missing).
DefaultBillToLogic Integer Bill To Type; references vlangBillToTypeLookup.ID; there is also related enumeration BillToType. Bill To Types with rule BillToTypeRule.LogicDisabled are not allowed
TurnKickOffAuto Boolean Boolean flag indicating automatic kick-off for Turns is allowed. True means scheduler will automatically kick-off pending Turns (i.e. create work plans) when they are due.
TurnKickOffLagDays Integer Turns are kicked-off TurnKickOffLagDays days before event date. Values 0 - 120 are allowed.
TurnKickOffOnDays Byte Bitmask indicating on which weekdays turns and work template WOs can be scheduled to start. Each bit matches one weekday. Bit 0x01 is Sunday, 0x02 is Monday, 0x04 is Tuesday and so forth. Zero value (no days selected) is allowed; in this case application behavior is the same as if all days are selected.
EarliestSlot Integer Number of working days an offset for starting from which day (Today = 0, Tomorrow = 1, etc.) the search for the first available slot shall be performed. Default = 1; Min = 0; Max = 100
LatestSlot Integer Number of working days how many days out, starting with the Earliest slot setting, the latest appointment might be scheduled (1 meaning just for the day selected in the previous setting). Default = 7; Min = 1; Max = 7
SlotsCount Integer Defines up to how many options will be offered for Precalculated type
IsPrecalculatedSchedule Boolean Boolean flag; True means Precalculated (new behavior that provides a choice of N appointments)
AllowTimePreference Boolean Boolean flag; True means Contact is allowed to choose between morning and afternoon appointments
TurnTemplateId Integer
IsmSpecGroupId Integer
IsmUrl String
ExcludeNonCompliantProviders ExcludeCoi enumeration member COI Super Lockout
IsNteAuto Boolean or NULL IsNteAuto
CriticalFacilities CriticalFacilitiesSettingValues enumeration member If set to "Yes," then all {!{Work Orders}!} manually created in a Critical Facilities {!{Property}!} will go through the Approval flow
UnitTemplateID Integer Asset Template ID, optional. References InvTopLevel.ID.
RegulatoryFrameworkID Integer or NULL Regulatory Framework
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Space

Property Name Property Value Property Description
CustomerId Integer Customer Id. Is required.
Asset {Location entity reference} Unit Asset occupied by Customer. Is required.
StartDate DateTime or NULL Start date of lease. Is required.
EndDate DateTime or NULL End date of lease. Is required.
MoveOutDate DateTime or NULL Date of expected or actual Move Out date. Is required.
WorkZone {WorkZone entity reference} Space work zone - taken from customer. Is required.
StatusId LeasingSpaceStatus enumeration member Unknown, Historical, Current, OnNotice, Pending. Is required.
Addresses [{Address2 entity reference}, ...] One address from unit asset(Asset). Is required.
Instructions String Space instructions. Max Length=256.
MoveInDate DateTime or NULL Move in date.
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Task

Property Name Property Value Property Description
ModelId Integer Asset model which supports this task. Is required.
DisplayAs String Task name for UI. Max Length=400. Is required.
Preventive Boolean "True" for preventative task. Is required.
Routine Boolean "True" for routine task. Is required.
Corrective Boolean "True" for corrective task. Is required.
Default Boolean "True" if this is default Asset's(its Model's) task in work order. Is required.
Symptom Boolean "True" for symptom task. Is required.
CompletionTime Integer Time to complete task in minutes, supported values 0-599999. Is required.
Specialty {Specialty entity reference} Specialty that is needed to resolve that task - used for work order employee assignment.
ProcedureTemplate {ProcedureTemplate entity reference} Read-only reference to Procedure Template associated with Task
ProcedureTemplateReferenceId Integer Reference to Procedure Template Proxy associated with Task
Priority {WoPriority entity reference} Priority associated with Task - set to work order priority when created. Is required.
SelfHelpType TaskSelfHelpType or NULL Instructions format: Html, Hyperlink, YouTube
Instructions String Set of instructions for a task. Max Length=Nvarchar(max)
SelfHelpContent String Links to auxilary information in different format. Max Length=2048
PeopleRequired Integer Number of employees required.
SkillLevel Integer Necessary skill level.
GlAccount String GL Account number. Max Length=32
Number String External number. Might be provided by integration; also used by WON (Work Order Network). Max Length=64
Currencies [{TaskMoneyValues entity reference}, ...] Money values
ChargeCode {ChargeCodeLookup entity reference} ChargeCode
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Disposition

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
IsCompleted Boolean True means WO items with this disposition are completed and no longer pending.
IsCancelled Boolean True means WO items with this disposition are cancelled and no longer pending.
OnCreate Boolean True means this disposition is set automatically when child WO gets added to work plan.
OnComplete Boolean True means this disposition is set automatically when at least one child WO is completed and no pending child WOs remain (work plan automation).
OnCancel Boolean True means this disposition is set automatically when all child WOs are cancelled (work plan automation).
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoItem

Property Name Property Value Property Description
WorkOrderId Integer Parent Work Order Id. Is required.
SortOrderIdx Integer Order in parents container. Sort index; 1-based; must has unique value per WO and used to sort items on UI. Only positive values are allowed (>= 1). Is required.
Disposition {Disposition entity reference} Allows to define a point of WorkOrder workflow at which the item is to be processed (e.g. on WorkOrder status changed to Completed).
AssetLocation String Free-text value representing item's location in the asset hierarchy, relative to WO's main location. This value is computed by BO. Max Length=128.
Asset {Location entity reference} Asset to work with. Is required.
Task {Task entity reference} The task to be done in frame of the item. Is required.
Comment String Plain text to clarify the items purpose. Max Length=3096.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

CustomFieldDescriptor

Property Name Property Value Property Description
ActorTypeId ActorType enumeration member Custom field object type and field type. Is required.
Length Integer Field length. Max value string length (if string type)
Type CfType enumeration member Field type : Unknown, String, Integer, Decimal, Money, Phone, Date, Time, Boolean, Url. Is required.
SharedWithProvider CfSharingMode enumeration member Shared mode with provider Exposed as scalar CfSharingMode enumeration value.
SharedByRequestor CfSharingMode enumeration member Shared mode by requestor Exposed as scalar CfSharingMode enumeration value. Read-only
CpnRequestorId Integer CPN Requestor ID Read-only
Name String Custom field name. Max Length=64. Is required.
Options [{CustomFieldOption entity reference}, ...] A list of values that can be set in custom field - null for strings
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

CustomField

Property Name Property Value Property Description
Descriptor {CustomFieldDescriptor entity reference} Gets custom field metadata
ObjectId Integer Object ID
Value String Gets Custom Field name
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Organization

Property Name Property Value Property Description
DisplayAs String Displayable name.
Number String Number using our standard "unique or empty" pattern
CustomFields [{CustomField2 entity reference}, ...]
Notes [{Note entity reference}, ...]
ContactAddresses [{ContactInfo entity reference}, ...]
Address {Address2 entity reference}
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Contact

Property Name Property Value Property Description
DisplayAs String Gets or sets a display as value. Max Length=256. Is required.
FirstName String First Name. Max Length=50
LastName String Last Name. Max Length=50. Is required.
TypeId LeaseContactType enumeration member Type: Unknown, Alternate, Emergency, Primary
CustomerId Integer Customer Id.
CanViewAnyRequest Boolean Flag to determine level of access. "True" allows authorization for other's expense. No is only for contact's own expenses. Default is "False".
CanCreateRequest Boolean Allow Request Creation. Default is "True".
PriorityThreshold Integer Priority threshold.
CustomFields [{CustomField2 entity reference}, ...] Custom Fields.
ContactAddresses [{ContactInfo entity reference}, ...] Phone, Email, other can be defined here.
GroupsBridge [{LinkContactAndGroup entity reference}, ...] Contact/Customer Group Bridge records.
Username String If using the Customer Portal, then this is the login id. The login must be unique amongst the user community. Suggest using their phone number, employee number or e-mail address. Max Length=64. Is required.
Number String Number which can be used as a unique identifier for integration purposes. Max Length=64. Is required.
MustResetPassword Boolean True in case user has to change password.
NoAlertEmails Boolean Disable alert emails.
Comment String Comments. Max Length=256. Is required.
UnlimitedRequest Boolean True means Contact has unlimited request authority.
UnlimitedAuthorization Boolean True means Contact has unlimited authorization authority.
SupervisorId Integer Contact's supervisor. This is reference to another Contact record, i.e. lsAccessObject.ID.
LanguageId Integer Contact's language preference; references LangLookup.ID.
CustomerNoteAccessId LsNoteAccess enumeration member Contact's access level to Customer Notes.
NoPwdExpirationAlert Boolean Boolean flag; True means password expiration notifications will not be sent to this particular Contact.
Currencies [{ContactMoneyValues entity reference}, ...] Money values
CountryId String Gets or sets a country abbreviation Max Length=2. Is required.
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

TimePeriod

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
StartDate DateTime Start date (computed for dynamic periods; value from the database field for static). This is date only; no time. Please note special handling for "Current Period" interval.
EndDate DateTime End date (computed for dynamic periods; value from the database field for static). This end of the last period's day (midnight minus 1 tick). Please note special handling for "Current Period" interval.
dtStart DateTime or NULL dtStart field
dtEnd DateTime or NULL dtEnd field
IsFinancial Boolean Flag indicating financial period.
IsTime Boolean Supported for predefined intervals only. True means interval boundaries don't match day boundaries; and thus it's not suitable for date interval control (for instance, "next 48 hours").
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Specialty

Property Name Property Value Property Description
DisplayAs String The name of the Specialty. Max Length=40. Is required.
WONServiceId Integer Related to WON (Work Order Network) Service
Instructions String Service instructions to relay to team members; HTML content supported. Max Length=3072.
TaxCode {TaxCode entity reference} Labor Tax Code.
Currencies [{SpecialtyMoneyValues entity reference}, ...] Money values
IsNteAuto Boolean or NULL IsNteAuto
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WorkOrderType

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
TypeId WOType enumeration member
Abbr String Abbreviated version of the displayable name.
IsDefSR Boolean True indicates Custom WO type is used as default selection when user creates new request WO from Customer Portal UI.
IsDefBasic Boolean True indicates Custom WO type is used as default selection when user creates new basic WO (for instance, by adding child to work plan).
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

CustomerNoteType

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

RepairCode

Property Name Property Value Property Description
DisplayAs String Name of the object. Is shown on UI. Max Length=64. Is required.
ParentId Integer References parent Category; null indicates Category records. Is required.
Codes [{RepairCode entity reference}, ...] Child Repair Codes. Always empty for Repair Code with ParentID equals to NULL.
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

AttributeDescriptor

Property Name Property Value Property Description
Type CfType enumeration member
Name String Gets or sets DisplayAs field value.
IsHistory Boolean Boolean flag. True means users want to track value changes for this attribute (affects UI).
DisplayInWorkOrder Boolean Boolean flag. True means this attribute is important from operational standpoint and displayed on UI related to Work Orders.
Options [{AttributeOption entity reference}, ...]
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoActionReasonLookup

Property Name Property Value Property Description
DisplayAs String How the reason is represented in UI. Max Length=128
ActionId WOActionType enumeration member Enumeration which describes an action had been taken over the WorkOrder.
ReasonId Byte Link to reason object, unique within WO Action.
Hide Boolean Flag to decide whether the object is shown on UI.
Descr String Comment for the action reason. Max Length=256
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoPriority

Property Name Property Value Property Description
DisplayAs String Label, unique value. Max Length=40. Is required.
IsEmergency Boolean Escalate. Is required.
AcknowledgeInMinutes Integer "Acknowledge In" SLA value. Required.
RespondInMinutes Integer Response hrs. Is required.
DueInMinutes Integer Complete hrs. Is required.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoLastAction

Property Name Property Value Property Description
Id Integer Internal Id
WorkOrderId Integer NOTE: It's used as ID
LastAction {WoActionLog entity reference} Reference to last status-changing action for WO, WOActionLog2Object.ID.
EmergencyReason {WoActionReasonLookup entity reference} Reason for escalating WO to Emergency when creating new WO from Customer Portal. References WOActionReasonLookup.(ActionID = WOActionType.PriorityChanged, ReasonID).
Reason {WoActionReasonLookup entity reference} Reason matching current WO status. Only On Hold and Cancelled statuses support and require reasons; for other statuses this field is null/empty.
BillStatus BillStatus enumeration member WO billing status computed based on WO status and financial status(es). It's a bitmask matching enumeration BillStatus. Cumulative mask value is a reference to vlangWOBillingStatusLookup.ID.
Invoice {Invoice entity reference} Customer Invoice associated with WO; references ciInvoiceObject.ID.
BilledTotal {MoneyValue entity reference} Contains total billed value; either preview (when ciInvoiceID == NULL) or actual version (otherwise). This field is nullable; NULL value is different from zero; it means total billed preview was never computed (when ciInvoiceID == NULL) or total billed amount is not applicable to this WO (otherwise).
XNumber String "External" WO number provided by third-party application. Used by integration. Max Length=256
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoNote

Property Name Property Value Property Description
CreatedDate DateTime Note creation date and time in work zone time. Is required.
Body String Note text. Max Length=6144. Is required.
WorkOrderId Integer Work Order Id. Is required.
NoteTypeId WONoteType enumeration member Type: Unknown, Completion, Public, Private. Is required.
CreatedBy {Actor entity reference} Represents the user, provider or other part that created that note.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Actor

Property Name Property Value Property Description
Id Integer Gets or sets a Corrigo entity identifier.
TypeId ActorType enumeration member Enumeration which defines type of object the Actor is (e.g. Employee)
DisplayAs String How an object is represented on UI. Max Length=256
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ContactAddress

Property Name Property Value Property Description
TypeId ContactAddrType enumeration member
Address String
IsDefault Boolean
IsAlert Boolean
IsLocked Boolean
IsReport Boolean
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Address2

Property Name Property Value Property Description
ActorTypeId ActorType enumeration member Actor Type of the parent object. Is required.
ActorId Integer ID of the parent object. Is required.
TypeId StreetAddrType enumeration member Type of the address (CLookup records of type 'SADT'). Unknown, Primary or Home. Is required.
Street String Street name. Max Length=128. Is required.
Street2 String Street name (extension). Max Length=128
City String City name. Max Length=40
State String State abbreviation. Max Length=2
Zip String ZIP code. Max Length=10
Country String Country abbreviation. Max Length=2
GeoStatusId GeoStatus enumeration member Geocoding status matching enumeration GeoStatus.
Latitude Double Location's latitude
Longitude Double Location's longitude
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ContactInfo

Property Name Property Value Property Description
ActorTypeId ActorType enumeration member Actor Type of the parent object : Customer, Employee, etc. Is required.
ActorId Integer ID of the parent object. Is required.
AddrTypeId ContactAddrType enumeration member Contact Address Type Id. Is required.
Address String Contact address value. Max Length=512 Is required.
IsAlert Boolean True means this contact address is suitable for sending alerts.
IsReport Boolean True means this contact address is suitable for sending report subscriptions.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

CustomField2

Property Name Property Value Property Description
Descriptor {CustomFieldDescriptor entity reference} Gets custom field metadata. Is required.
ObjectId Integer Parent Object ID. Is required.
ObjectTypeId ActorType enumeration member Parent Object Type ID. Is required.
Value String Gets Custom Field value. Max Length=1024. Is required.
CurrencyTypeId CurrencyType enumeration member Required for Custom Fields where data type is Currency (DataType.Money); otherwise ignored. Modifications for existing records are not allowed.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Note

Property Name Property Value Property Description
ActorId Integer Parent Object ID
ActorTypeId ActorType enumeration member Parent Object Type ID
NoteTypeLookup {CustomerNoteType entity reference} Note type
IsResolved Boolean True means Note was "resolved"
CreatedAt DateTime Local date/time when Note was created
CreatedBy {Actor entity reference} Actor who created the Note
UpdatedAt DateTime or NULL Local date/time when Note was created
UpdatedBy {Actor entity reference} Actor who last modified the Note
NoteText String Customer note text
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WorkOrderCost

Property Name Property Value Property Description
Id Integer Internal Id
WorkOrderId Integer NOTE: It's used as ID
CurrencyTypeId CurrencyType enumeration member Currency type inherited from WO
BillToType BillToType enumeration member Enumeration of values: None, Customer, WorkZone, Other. This field defines type of entity which will be billed for this WO, or lack thereof. This property is not mapped. It's supported for backward compatibility. Should not be exposed via API to clients
BillToOption {BillToOption entity reference} This field defines type of entity which will be billed for this WO, or lack thereof.
CostsTotal {MoneyValue entity reference} Total amount of Costs associated with WO. Zero value is allowed.
ApStateId ApState enumeration member AP State matching current Vendor Invoice status.
ApStatusId Integer Vendor Invoice status
JobCode String Job Code; this field has no associated business logic and set manually by user. Max Length=32
Contract {Contract entity reference} Contract associated with WO; references WOCostDefaultObject.ID.
AuthorizationCode String Authorization code for Vendor Invoice; set by user when Vendor Invoice status is set to predefined status "Authorized". Max Length=32
CheckNumber String Check number; set by user when Vendor Invoice status is set to predefined status "Paid". Max Length=64
PaymentAmount {MoneyValue entity reference} Amount paid to vendor; set by user when Vendor Invoice status is set to predefined status "Paid".
PaymentNotes String Payment Notes. Max Length=3072
CheckCutDate DateTime or NULL Payment date; set by user when Vendor Invoice status is set to predefined status "Paid". Value is date only, no time part.
CheckClearDate DateTime or NULL Date when check to vendor was cleared. There is no business logic for this field. Value is date only, no time part.
GlAccount String GL Account number matching GLAccountObject.DisplayAs. Max Length=32
Number String Vendor Invoice Number. This value is set either manually or by WON provider when invoice is submitted. Max Length=32
VendorInvoiceDate DateTime or NULL Vendor invoice submission date provided received from 6.x. Value is date only, no time part.
VendorInvoiceReceivedDate DateTime or NULL Actual vendor invoice submission date (automatically set when invoice is received from 6.x). Value is date only, no time part.
VendorInvoiceTotal {MoneyValue entity reference} Vendor Invoice total amount. Zero value is allowed.
IsPreBilled Boolean True means this is pre-billed vendor invoice. Such vendor invoices can be created from PM/RM templates; they have distinct WON workflow in 6.x.
ExpensesTotal {MoneyValue entity reference} Total amount of costs plus Vendor Invoice total. This represents total amount of expenses associated with WO. Zero value is allowed.
BillingRule BillingRule enumeration member Enumeration of values: Unknown, VendorAndServiceFee, Contract, NotBilled, ServiceFee, All, CostsAndFees.
TaxStatus TaxValidationStatus enumeration member Enumeration of values: Unknown, None, Success, Failure, Provider
CustomerNte {MoneyValue entity reference} Customer NTE (not to exceed).
Items [{FinancialItem entity reference}, ...] Financial Items
TaxValidationNote {Blob entity reference} Tax Validation Note
TaxDetails [{TaxDetail entity reference}, ...] Tax Details based on Tax Validation Note
ServiceFeesTotal {MoneyValue entity reference} Total amount of service fees. Precision 2 digits; negative and zero values are allowed. This value is computed by BO.
CostStatusId Integer Cost status; references vlangARBillStatusLookup.ID.
CostState CostState enumeration member Enumeration of values: Pending, Submitted, Approved, Exported Cost State matching current Cost status; references vlangCostState.ID and matches enumeration CostState. Is required.
ChargeCode {ChargeCodeLookup entity reference} Custom charge back classification defined by client; used only when Customer Invoicing module is off. References ChargeCodeObject.ID; there is predefined default value ChargeCode.None which is used by BO. Is Required.
BillingAccount {BillingAccount entity reference} Billing Account associated with WO; references lsGroupObject.ID and must match record with IsBillAcct == True.
BillingContact {Contact entity reference} Billing Contact associated with WO; references lsAccessObject.ID
ExternalId String External ID; used by integration clients. Max Length=64
ServiceDate DateTime or NULL Date the work was actually done, or if more than one day of work was done, the day of work that will actually be billed for.
TaxIdPrimary String Primary Tax Id
TaxIdSecondary String Secondary Tax Id
CanExpedite Boolean Option for the SPs to request Expedite flag on their invoices
CanEarlyPayment Boolean Option for the SPs to request Early payment flag on their invoices
IsAvailableExpeditedInvoiceFlags Boolean Read only settings for Invoice Flags
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoAssignment

Property Name Property Value Property Description
WorkOrderId Integer Assignment work order id. Is required.
IsPrimary Boolean True means primary assignment; in this case Actor_ID value matches WorkOrder2Object.Owner_EmployeeID.
EmployeeId Integer Id of an Employee the WorkOrder assigned to. Is required.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoOnSite

Property Name Property Value Property Description
WorkOrderId Integer
EmployeeId Integer Employee performing work; references EmployeeObject.ID.
TimeZone Integer Time Zone value inherited from WO
DtCheckIn DateTime Is local timestamp (depends on TimeZone) of check-in event.
InCheckTypeId OnSiteValidationType enumeration member Verification method; matches enumeration OnSiteValidationType. References vlangWoOnSiteCheckType.ID.
InValidationValue String Might store tag or phone number when verification method is IVR or Barcode. Zero-length value is allowed.
InLatitude Decimal Stores latitude part of Employee location when verification method is GPS. Allowed values are from -90 to 90.
InLongitude Decimal Stores longitude part of Employee location when verification method is GPS. Allowed values are from -180 to 180.
InInvItemId Integer Inventory Asset ID; might be defined when verification method is Barcode. References InvItemObject.ID. This field is nullable.
InDistance Decimal Computed distance in miles between WO main location and actual Employee location during event. Supported when verification method is GPS. Zero value is allowed.
InStatusId OnSiteValidationResult enumeration member Verification status; matches enumeration OnSiteValidationResult. References vlangWoOnSiteStatus.ID.
DtCheckOut DateTime or NULL Is local timestamp (depends on TimeZone) of check-out event.
OutCheckTypeId OnSiteValidationType enumeration member Verification method; matches enumeration OnSiteValidationType. References vlangWoOnSiteCheckType.ID. If check-out event is missing, oCheckTypeID == OnSiteValidationType.Unknown.
OutValidationValue String Might store tag or phone number when verification method is IVR or Barcode. Zero-length value is allowed.
OutLatitude Decimal Stores latitude part of Employee location when verification method is GPS. Allowed values are from -90 to 90.
OutLongitude Decimal Stores longitude part of Employee location when verification method is GPS. Allowed values are from -180 to 180.
OutInvItemId Integer Inventory Asset ID; might be defined when verification method is Barcode. References InvItemObject.ID. This field is nullable.
OutDistance Decimal Computed distance in miles between WO main location and actual Employee location during event. Supported when verification method is GPS. Zero value is allowed.
OutStatusId OnSiteValidationResult enumeration member Verification status; matches enumeration OnSiteValidationResult. References vlangWoOnSiteStatus.ID.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoActionLog

Property Name Property Value Property Description
WorkOrderId Integer Work Order Id
TypeId WOActionType enumeration member Type of the action.
Actor {Actor entity reference} Link to actor who performed this action.
ActionDate DateTime Local timestamp of the action
Comment String Comment. Max Length=3072
ActionReasonId Integer Link to Action Reason. It is a calculated field, so it cannot be used as part of a query filtering/ordering condition.
IsBackDate Boolean True indicates action was backdated by end user; e.g. time when action is recorded is different from time when action was taken, according to the user.
UiTypeId UIType enumeration member Change was made from: Unknown, Corp, CallCenter, Wireless, Resident, Monitor, System, IVR, Offline, IntegrationWS, WON, OTHER. Indicates CorrigoNet interface/application where action was recorded;
TimeZone Integer Time zone ID inherited from Work Order.
SystemDateUtc DateTime UTC timestamp of the action. This value is computed by application rather than provided by user.
ObjectId Integer Action-specific value referencing object (typically, WO child) linked to this action record. Supported only for some action types.
Properties [{WoActionLogProp entity reference}, ...] Additional action information records.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoVerification

Property Name Property Value Property Description
Idx Integer
WorkOrderId Integer WorkOrder ID
WoRatingId WoRating enumeration member
Comment String
EditedDate DateTime
Actor {Actor entity reference}
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoActionLogProp

Property Name Property Value Property Description
WoActionLogId Integer Reference to parent Action Log record, WOActionLog2Object.ID.
ValueInt Integer or NULL Field where values for integer-based properties are stored. This property is nullable. E.g. default value is null; and BO must understand the difference between zero and null.
ValueStr String Field where values for text-based properties are stored. This property is nullable. E.g. default value is null; and BO must understand the difference between zero-length string and null.
TypeId WOActionProperty enumeration member Property type (enumeration member); references WOALPropertyLookup.ID.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

FinancialItem

Property Name Property Value Property Description
WoId Integer
CurrencyTypeId CurrencyType enumeration member Currency type inherited from WO
Comment String Item description; used for presentation purposes. Auto-computed for labor costs and material costs; otherwise provided by user.
Amount {MoneyValue entity reference} Item's total amount. Precision 2 digits; negative and zero values are allowed.
CostCategoryId CostCategory enumeration member Cost Category (Labor, Materials, Miscellaneous etc.). References WOCostCategoryObject.ID. Matches enumeration CostCategory.
Rate {MoneyValue entity reference} Item's rate. Precision 4 digits; negative and zero values are allowed.
StartDate DateTime or NULL Start of the labor record. Supported and required for all costs; optional for labor vendor items; otherwise NULL.
Duration Integer Labor cost record duration in minutes. Supported values are 0 - 599999999. This field is nullable. Supported and required for labor costs (in which case it's taken from user input); otherwise NULL.
InvoiceItem {InvoiceDictionaryItem entity reference} Invoice Dictionary Item associated with the record. Supported for vendor invoices; required for service fees; NULL for costs. References ciItemListObject.ID.
Exclude Boolean This property is not mapped. It's supported for backward compatibility.
RuleModification WoCostExclusion enumeration member Exclusion Rule. References vlangWoCostExclusion.ID; there is also enumeration WoCostExclusion. This value is used to tweak WO billing logic. Supported only for service fees; otherwise always False.
Product {Product entity reference} Product associated with materials item. Supported and required for material costs; otherwise NULL. References MHProductObject.ID.
Employee {Employee entity reference} Employee who performed labor. Supported and required for labor costs; otherwise NULL. References EmployeeObject.ID.
Quantity Decimal Quantity. This field is explicitly set by user (except for labor costs where user specifies duration in minutes; then Qty is computed). Precision is 5 digits; supported values are 0 - 9999999.99999.
LaborCode {LaborCode entity reference} Labor Code associated with labor record. Supported and required for labor costs; otherwise NULL. References CostCodeObject.ID.
TypeId WoCostLineType enumeration member Indicates whether item belongs to costs, vendor invoice or service fees. Matches enumeration WoCostLineType.
TaxAmount {MoneyValue entity reference} Tax amount for particular line item provided by provider. This value is only used for vendor invoice items; otherwise it's ignored. Precision 2 digits; negative and zero values are allowed.
WithholdingTaxRate Decimal Withholding Tax rate. This value is only used for vendor invoice items; otherwise it's ignored. Precision 5 digits; negative values are not allowed; supported range is 0 - 1. This field is nullable. Default value is NULL, which means there was no user input into this field. Zero value is allowed and different from NULL - it means user entered such value.
WithholdingTaxRateUndefined Boolean
StockLocation {StockLocation entity reference} Stock Location associated with materials cost record. Supported for material costs; otherwise NULL. References MHLocationObject.ID.
TaxCodeReference {TaxCode entity reference} Tax Code Item associated with the record. References ciTaxCodeObject.ID.
NonBillable Boolean or NULL Boolean flag; True means Financial Item is not billable and won't be copied to Customer invoice
MerchantName String This field is free text optional value to track and report on merchant name.
CheckForNonBillable Boolean This is a not-mapped property. It is required to indicate that NonBillable property should be calculated
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoQuote

Property Name Property Value Property Description
WoId Integer
CurrencyTypeId CurrencyType enumeration member Currency type inherited from WO
Amount {MoneyValue entity reference} Quote amount. Negative values are not allowed; zero value might be blocked by pre-commit check.
Description String Comments provided from either provider or requestor; zero length not always accepted.
Reason String Reason for rejection/recalling;; free-text. Required when Quote is Rejected.
StatusId QuoteStatus enumeration member Quote status; matches enumeration QuoteStatus; references vlangWOQuoteStatusLookup.ID.
IsMultiline Boolean Boolean flag indicating if Quote is multi-line. This value is inherited from WO when Quote is created.
Items [{QuoteOrEstimateItem entity reference}, ...]
ServiceDate DateTime or NULL Contains the Provider Service Date on the Proposal if any If empty, Price List shows only those options that have blank Start Dates and blank End Dates.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoEquipment

Property Name Property Value Property Description
WoId Integer Work Order Id. Is required.
Asset {Location entity reference} Asset of type equipment. This asset must reside under some of spaces used in work order.
Comment String Comments provided from user; zero-length value is accepted. Max Length=1024
RefrigerantUsed Boolean A three-state Boolean flag (NULL means "no value") indicating refrigerant was used when work for particular equipment was done.
Type WoEquipmentType enumeration member Type: Unknown, New, Known, NotRelated. Is required.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Blob

Property Name Property Value Property Description
Id Integer Internal Id
ActorId Integer Entity that owns this blob - work order id or other. Is required.
ActorTypeId ActorType enumeration member Work Order or other. Is required.
Body Byte[] File content. Is required.
FileName String File name
TypeId Char File type identifier
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

DocumentType

Property Name Property Value Property Description
Description String Description
DisplayAs String Gets or sets DisplayAs field value.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Document

Property Name Property Value Property Description
ActorId Integer Id of document owner. Is required.
ActorTypeId ActorType enumeration member Actor Type of the parent object. Work Order, Inventory Asset. Is required.
Description String Description. Max Length=512. Is required.
Title String Title. Max Length=80. Is required.
DocType {DocumentType entity reference} Document Type. Is required.
EndDate DateTime or NULL Defines end of document's lifetime.
StartDate DateTime Defines start of document's lifetime.
UpdatedDate DateTime Updated Date.
ExtensionId Integer Extension Id
IsShared Boolean True when is shared.
IsPublic Boolean True when is public.
StorageTypeId DocumentStorageType enumeration member Storage Type Id. Cannot be updated for existing document.
DocUrl String Url
MimeType String Mime Type. Is required.
UpdatedBy {Actor entity reference} Updated By
WonId Integer WON (Work Order Network) Id
WonMemberId Integer WON (Work Order Network) member ID
Blob {Blob entity reference} File object is a content of the file stored in BLOB
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Product

Property Name Property Value Property Description
InvoiceItem {InvoiceDictionaryItem entity reference} CiDict
DisplayAs String DisplayAs
PartName String DisplayAs
Description String Descr
Discontinued Boolean Discontinued
UnitOfMeasureId MhUnit enumeration member UnitId
Comments String Comments
Manufacturer String Manufacturer
PartNumber String PartNumber
ScanCode String ScanCode
Category {ProductCategory entity reference} Type
Suppliers [{LinkProductAndSupplier entity reference}, ...] SuppliersBridge
CustomFields [{CustomField2 entity reference}, ...] CustomFields
Currencies [{ProductMoneyValues entity reference}, ...] Money values
Critical Boolean Critical
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LaborCode

Property Name Property Value Property Description
InvoiceItem {InvoiceDictionaryItem entity reference}
Description String Labor Code description
DisplayAs String Gets or sets DisplayAs field value.
IsDefault Boolean True indicates default labor code (used when application needs to create labor record with no specific labor code provided by user).
ShowForWo Boolean True means labor code can be used by labor records
IsTimeCard Boolean True means labor code can be used for time card items (TCI).
IsProductive Boolean True means labor code qualifies as "productive" (as opposite to "vacation" or "break")
IsPaid Boolean True means labor code qualifies as "paid time".
IsShortcut Boolean True means labor code is part of "shortcut list" used by mobile client.
IsDefTimeCard Boolean True indicates default labor code for time cards.
ExternalCode String Code/number from the third-party software; used to integrate with systems such as ASP eTime.
TypeId LaborCodeType enumeration member Defines type of the Labor Code: "time" or "allowance", used for different purposes: "time" Labor Codes can be used to create WO internal costs of type Labor and "time" Time Card Items; "allowance" Labor Codes are used only to create "allowance" Time Card Items. Supported values: LaborCodeType.Time or LaborCodeType.Allowance.
Rate Decimal Rate amount computed by application.Zero and negative values are acceptable.This field is nullable; default value is NULL(not zero).
CurrencyTypeId CurrencyType enumeration member
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WpTree

Property Name Property Value Property Description
ChildWoId Integer ID of the Work Order participating in Work Plan. This field is unique for all WPTreeObject table; references WorkOrder2Object.ID.
DependOnWorkOrder {WorkOrder entity reference} Peer sibling WO on which WO defined by cWOID depends; NULL means no dependency. References WorkOrder2Object.ID.
Level Integer This field tells on which level of Work Plan WO defined by cWOID is placed. Only values 0, 1 and 2 are allowed: 0 means cWOID is the root (in this case RootWOID == cWOID); 1 means it's a child; 2 means it's a grandchild. References WorkOrder2Object.ID.
Number Integer Numeric suffix used to build WO number for WO defined by cWOID. If cWOID is root this field is zero. Allowed values are 0 - 100, which means single parent cannot have more than 100 children.
ParentWorkOrder {WorkOrder entity reference} Immediate parent of the Work Order defined by cWOID; references WorkOrder2Object.ID. If cWOID is root, pWOID == cWOID.
RootWorkOrder {WorkOrder entity reference} Root of the Work Plan; references WorkOrder2Object.ID.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoEstimate

Property Name Property Value Property Description
WorkOrderId Integer Estimate work order id. Is required.
CurrencyTypeId CurrencyType enumeration member Currency type inherited from WO
Amount {MoneyValue entity reference} Requested NTE (Not to Exceed) amount. Negative values are not allowed; zero value might be blocked by pre-commit check.
Comment String When new NTE (Not to Exceed) is requested - contains request comment. After request was approved it contains response from customer. Max Length=2048
StatusId QuoteStatus enumeration member Unknown, NotSubmitted (obsolete state), Requested, WaitingForApproval, Approved,Rejected, InProposal (reserved). Is required.
Reason String Contains response from customer after reject. Max Length=256
ContactId Integer Id of the contact that approves or rejects estimate. Required for approved and rejected state when ContactName is not defined.
ContactName String Contact that approved or rejected comment. Required for approved and rejected state when ContactId is not defined. Max Length=256
IsMultiline Boolean
Items [{QuoteOrEstimateItem entity reference}, ...]
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ToDoItem

Property Name Property Value Property Description
ActorId Integer Standard link to parent object along with ActorTypeID
ActorTypeId ActorType enumeration member Standard link to parent object along with ActorId
DtUtcDue DateTime or NULL Due date
Done Boolean True means item is done/completed
Description String Description, required.
Comments String
EmployeeId Integer Assigned Employee; references EmployeeObject.ID, optional.
CreatedEmployeeId Integer Employee who created item, references EmployeeObject.ID. This field equals to NULL if item was created as part of WO creation or escalation workflow.
CompletedEmployeeId Integer When item is done, this field may contain ID of the Employee who completed item. References EmployeeObject.ID.
DtUtcCompleted DateTime or NULL When item is done, this field contains UTC timestamp of the completion event.
Type {ToDoType entity reference} To-Do Type, references vlangToDoTypeObject.ID. This field may be required depending on instance configuration.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkCustomerAndGroup

Property Name Property Value Property Description
CustomerId Integer
CustomerGroupId Integer
IsBillingAccount Boolean
IsParentRemoved Boolean True if parent object is deleted. Single records are purged from databas; it's marked as removed only as a part of Customer deletion
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkContactAndGroup

Property Name Property Value Property Description
ContactId Integer
CustomerGroupId Integer
IsBillingContact Boolean
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

AssetInfo

Property Name Property Value Property Description
Id Integer Internal Asset Info Id.
AssetId Integer Asset id. Is required.
CommunityId Integer Work zone id. Is required.
SerialNumber String Asset serial number. Max Length=50.
TagId String Asset serial number. Max Length=892.
CheckPhone String Phone. Max Length=256.
AssetSystem {AssetSystem entity reference} Reference to AssetSystem
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Contract

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

TaxRegion

Property Name Property Value Property Description
Items [{TaxRegionItem entity reference}, ...]
DisplayAs String Gets or sets DisplayAs field value.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

TaxRegionItem

Property Name Property Value Property Description
TaxRegionId Integer Reference to parent object
TaxCode {TaxCode entity reference} Tax Code ID, references ciTaxCodeObject.ID; required.
TaxRate Decimal Tax rate; Supported values are -9999.99999 - 9999.99999; max. precision is 5 digits. Negative and zero values are allowed.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

PriceList

Property Name Property Value Property Description
CurrencyTypeId CurrencyType enumeration member Currency type (independent context).
DisplayAs String DisplayAs
TypeId PriceListType enumeration member Price list type
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

PriceListItem

Property Name Property Value Property Description
CurrencyTypeId CurrencyType enumeration member Currency type inherited from parent price list.
VendorRate {MoneyValue entity reference} Vendor Rate
Description String Description
RateType RateType enumeration member Rate Type
VendorType VendorType enumeration member Vendor Type
PriceListId Integer Price List information Id
Rate {MoneyValue entity reference} Price
InvoiceItem {InvoiceDictionaryItem entity reference} Invoice Item
StartDate DateTime or NULL Date on which the price list item's price comes into effect.
EndDate DateTime or NULL Date on which the price list price is no longer in effect.
Source WoCostPriceSource enumeration member Representation whether the Price List Item was created manually or through Integration
ExternalID String ID comming from EDP
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ChargeCodeLookup

Property Name Property Value Property Description
Code String Code. Zero-length value is acceptable.
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
DisplayAs String Gets or sets the display as CorrigoNet entity value.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

CustomFieldOption

Property Name Property Value Property Description
ParentId Integer
Idx Integer
Value String
ActionsRequired Integer Bitmask of enumeration
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Model

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
Description String Description
AssetCategoryId AssetType enumeration member
Public Boolean True means Model represents public area building (distinction between residential and public area buildings is important for Service Request Wizard in Customer Portal application).
SubComponentIdx Char Used by Customer Portal, Service Request wizard.
GlAccount String GL Account number matching GLAccountObject.DisplayAs.
Instructions String Service Instructions, optional. Max. length is 3072. This field contains HTML message shown to the end user when new WO is created.
Tasks [{Task entity reference}, ...]
AttributeDescriptors [{LinkModelAndAttribute entity reference}, ...]
Number String External number. Might be provided by integration; also used by WON. This field is either empty or unique among all Models.
AllowAnonymousRequests Boolean True means anonymous submission is allowed for assets linked to this Model.
ChargeCode {ChargeCodeLookup entity reference} ChargeCode
Parts [{LinkProductAndQtyAttribute entity reference}, ...]
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkUserAndSpecialty

Property Name Property Value Property Description
UserId Integer Employee/technician ID, references EmployeeObject.ID.
SpecialtyId Integer Specialty ID, references SpecialtyObject.ID.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkUserAndCustomerGroup

Property Name Property Value Property Description
UserId Integer Employee/technician ID, references EmployeeObject.ID.
CustomerGroupId Integer LsGroup ID, references LsGroupObject.ID.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkUserAndWorkZone

Property Name Property Value Property Description
UserId Integer Employee/technician ID, references EmployeeObject.ID.
WorkZoneId Integer Work Zone ID, references CommunityObject.ID.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkUserAndPortfolio

Property Name Property Value Property Description
UserId Integer Employee/technician ID, references EmployeeObject.ID.
PortfolioId Integer Portfolio ID, references PortfolioObject.ID.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkUserAndTeam

Property Name Property Value Property Description
UserId Integer Employee/technician ID, references EmployeeObject.ID.
TeamId Integer Team ID, references TeamObject.ID.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

UserPayRate

Property Name Property Value Property Description
LaborCodeId Integer Labor code ID, references CostCodeObject.ID.
UserId Integer Employee/technician ID, references EmployeeObject.ID.
IsDefault Boolean True means record defines default labor code and rate for the given Employee.
Currencies [{UserPayRateMoneyValues entity reference}, ...] Money values
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

UserCertification

Property Name Property Value Property Description
UserId Integer Employee/technician ID, references EmployeeObject.ID.
CertificationNumber String Certification number, Required
CertificationClassId EmpCertificationClass enumeration member Refrigerant Certification Class, Required
ExpiresDate DateTime or NULL Short date, Default = Empty
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkUserAndStockLocation

Property Name Property Value Property Description
UserId Integer Employee/technician ID, references EmployeeObject.ID.
StockLocationId Integer
FullAccess Integer Boolean flag; True means Employee has "full" access to particular Stock Location.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkProviderPriceList

Property Name Property Value Property Description
ProviderId Integer Employee/technician ID, references EmployeeObject.ID.
PortfolioId Integer Portfolio, references PortoflioObject.ID. This field equals zero for "default" record.
PriceListId Integer Vendor Price List, references WOCostPriceLstObject.ID.
Idx Integer 1-based order of preference; 1 is higher preference. Supported values are 1 - 32767; value of 32767 indicated "default" record.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkProviderAndService

Property Name Property Value Property Description
ProviderId Integer Employee/technician ID, references EmployeeObject.ID.
ServiceId Integer Service ID, references WONVerticalLookup.ID.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Role

Property Name Property Value Property Description
DisplayAs String Role's displayable name
Rank Integer Rank used to arrange roles by their level of privileges and restrict users from assigning roles indiscriminately. Supported values are 1 - 99.
UnlimitedNte Boolean Value of this field based on NteLimit field.
SsoLoginOnly Boolean Boolean flag; True means Role can login only using SSO identity provider.
Currencies [{RoleMoneyValues entity reference}, ...] Money values
IsIsmRequired Boolean Boolean flag; part of ISM setup. True means Induction and Safety Management (ISM) is applicable to Technicians assigned to this Role.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

AlertScope

Property Name Property Value Property Description
UserId Integer Employee/technician ID, references EmployeeObject.ID.
AlertTypeId AlertType enumeration member Alert Type. One of AlertType enumeration members; only Employee alerts are allowed. References vlangAlertTypeObject.ID.
ScopeId Integer Defines Work Zone or Portfolio for which subscription is configured. Also defines Specialty when ScopeTypeId == ActorType.Specialty
ScopeTypeId ActorType enumeration member Defines Work Zone or Portfolio for which subscription is configured. Supported values for ScopeTypeID are only ActorType.Property, ActorType.Portfolio and ActorType.Specialty.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

AlertSubscription

Property Name Property Value Property Description
Id Integer Employee/technician ID, references EmployeeObject.ID.
UserId Integer Employee/technician ID, references EmployeeObject.ID.
AlertTypeId AlertType enumeration member Alert Type. One of AlertType enumeration members; only Employee alerts are allowed. References vlangAlertTypeObject.ID.
FullScopeSubscription Boolean True means this subscription applies to all work zones from Technician's scope.
SubscriptionScope [{AlertScope entity reference}, ...] Alert Scope collection
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

AssetTree

Property Name Property Value Property Description
Id Integer Internal Id
ParentId Integer Parent Id of (Asset)
ChildId Integer Child Id of (Asset)
Child {Location entity reference} Child (Asset)
Distance Byte Tells how deep Child asset is situated relative to Parent(ParentId)
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

AttributeOption

Property Name Property Value Property Description
ParentId Integer
Idx Integer
Value String
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Team

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
WorkZones [{LinkTeamAndWorkZone entity reference}, ...]
Employees [{LinkUserAndTeam entity reference}, ...]
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkTeamAndWorkZone

Property Name Property Value Property Description
TeamId Integer Team ID, references TeamObject.ID.
WorkZoneId Integer Work Zone ID, references CommunityObject.ID.
IsDefault Boolean True indicates default Team for Work Zone
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkPortfolioAndWorkZone

Property Name Property Value Property Description
WorkZoneId Integer Work Zone ID, references CommunityObject.ID.
PortfolioId Integer Portfolio ID, references PortfolioObject.ID.
IsPrimary Boolean True indicates link between Work Zone and its primary portfolio.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

BusinessHours

Property Name Property Value Property Description
DayIdxDayOfWeek Integer Number of the day inside the week. Supported values are 1 - 7. 1 always means Sunday - regardless of how "First day of the week" setting is configured
FinishTime DateTime or NULL This field contains time part of the day (i.e. no date part) indicating end of the business hours. 12:00 AM/00:00 means "end of day". NULL is used when the whole day is off.
StartTime DateTime or NULL This field contains time part of the day (i.e. no date part) indicating start of the business hours. NULL is used when the whole day is off.
ActorId Integer
ActorTypeId ActorType enumeration member
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Holiday

Property Name Property Value Property Description
DisplayAs String Holiday name/label.
DtHoliday DateTime This field contains date (i.e. no time part) indicating a holiday.
ActorId Integer
ActorTypeId ActorType enumeration member
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

SpecDispatchRule

Property Name Property Value Property Description
SpecialtyId Integer Specialty for which rule is defined, references SpecialtyObject.ID. Zero is valid value for this field. It references record with ID #0 in Specialty table which means "Unspecified".
Index Integer (0) indicates a special record representing so-called "Specialty Rule" ;). Other than special zero value, this is 1-based sequential index specifying user-defined order of assignees.
UserId Integer Employee (either Technician or Provider) linked to the rule, references EmployeeObject.ID.
ActorId Integer
ActorTypeId ActorType enumeration member
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

EscalationRule

Property Name Property Value Property Description
UserId Integer Reference to parent object
NotifyAfter Integer Number of minutes since alert inception after which particular Employee may start receiving notifications. Supported values are 0 - 999.
ActorId Integer
ActorTypeId ActorType enumeration member
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

OnCallRule

Property Name Property Value Property Description
DayOfWeek Integer Number of the day inside the week. Supported values are 1 - 7. 1 always means Sunday - regardless of how "First day of the week" setting is configured.
BizHoursUserId Integer On-call person for business hours. Reference to Employee - EmployeeObject.ID.
AfterHoursUserId Integer On-call person for off hours. Reference to Employee - EmployeeObject.ID.
ActorId Integer
ActorTypeId ActorType enumeration member
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Responsibility

Property Name Property Value Property Description
UserId Integer Should not be exposed via API to clients
AssigneeId Integer Type ID of the actor chosen for this Responsibility. Supported values are ActorType.Employee and ActorType.LeaseUser only, i.e. Technician and Contact.
AssigneeTypeId ActorType enumeration member ID of the actor chosen for this Responsibility. Reference to Actor, Actors.ID.
ResponsibilityType {ResponsibilityType entity reference} Responsibility type. References vlangPortfolioType.ID;
ActorId Integer
ActorTypeId ActorType enumeration member
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Warranty

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
AdditionalInfo String Additional coverage details, terms and conditions. Max. length is 6144 characters; zero length values are allowed.
IsTemplate Boolean True indicates template; False indicates warranty.
Organization {Organization entity reference} Organization ID, references OrgObject.ID. This field is required for Template; otherwise irrelevant.
StatusId WarrantyStatus enumeration member Warranty status matching enumeration WarrantyStatus and dictionary vlangWarrantyStatus. Used by warranties only; for templates always WarrantyStatus.None.
PrimaryContact String Name of the primary contact person (used by both warranties and templates).
TemplateId Integer
WorkOrder {WorkOrder entity reference} Work Order from which Warranty was created, references WorkOrder2Object.ID. Used by warranties only; for templates always NULL.
StartDate DateTime or NULL Start of the coverage interval; date without time. Required by warranties; for templates always NULL.
EndDate DateTime or NULL End of the coverage interval; date without time. Required by warranties; for templates always NULL.
AutoCoverage Integer A bitmask defining asset categories automatically covered by Warranty Template; used by templates; otherwise irrelevant. Bit number X matches asset category X; i.e. 0x01 matches asset category #1 (AssetType.Regular).
LaborCoverageTypeId SchedInterval enumeration member Interval type for Labor/Services coverage. Warranty status matching enumeration SchedInterval and dictionary vlangSchedIntervalLookup. Used by both warranties and templates. Supported values are SchedInterval.Day and SchedInterval.Year.
LaborCoverageLength Integer Interval length for Labor/Services coverage. Used by both warranties and templates. Supported values are 0 - 999.
PartsCoverageTypeId SchedInterval enumeration member Interval type for Parts/Materials coverage. Warranty status matching enumeration SchedInterval and dictionary vlangSchedIntervalLookup. Used by both warranties and templates. Supported values are SchedInterval.Day and SchedInterval.Year.
PartsCoverageLength Integer Interval length for Parts/Materials coverage. Used by both warranties and templates. Supported values are 0 - 999.
OtherCoverageTypeId SchedInterval enumeration member Interval type for Other coverage. Warranty status matching enumeration SchedInterval and dictionary vlangSchedIntervalLookup. Used by both warranties and templates. Supported values are SchedInterval.Day and SchedInterval.Year.
OtherCoveragerLength Integer Interval length for Other coverage. Used by both warranties and templates. Supported values are 0 - 999.
WarrantorTypeId ActorType enumeration member Standard link to actor representing the Warrantor. Supported values for WarrantorTypeID are ActorType.CorrigoNet and ActorType.Provider.
WarrantorId Integer Standard link to actor representing the Warrantor.
Comment String Additional comments provided by users. Used by warranties; otherwise irrelevant.
Asset {Location entity reference} Asset to which Warranty is linked, references InvItemObject.ID. This field is required for warranties; otherwise NULL.
TimeZone Integer Time Zone (typically derived from work order or asset) used to compute Warranty status. Used by warranties; otherwise irrelevant.
WorkZone {WorkZone entity reference} Auto-computed field containing parent work zone ID of Warranty's asset; references CommunityObject.ID. Used by warranties only; for templates always NULL.
ContactAddresses [{ContactInfo entity reference}, ...] Warranty support only one Contact Address type: ContactAddrType.Contact. There is no standard validation for it; all values are accepted
IsManufacturer Boolean Boolean flag. Used only by templates. True means this is a template for manufacturer warranty (there is 0 or 1 such template for each Organization).
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

AssetAttribute

Property Name Property Value Property Description
Descriptor {AttributeDescriptor entity reference} Reference to Asset Attribute Metadata, ModPropObject.ID.
AssetId Integer Reference to Asset, InvItemObject.ID.
TopAssetId Integer This field is auto-computed by application.
CurrencyTypeId CurrencyType enumeration member Required for Asset Attributes where data type is Currency (DataType.Money); otherwise ignored.
Value String
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

SpecialtyMoneyValues

Property Name Property Value Property Description
Nte Decimal or NULL Not to Exceed : approval must not be higher than this value.
AvgCostVendor Decimal or NULL Vendor Average Cost.
AvgCostTech Decimal or NULL Technician Average Cost.
AvgCostAll Decimal or NULL Total Average Cost.
CurrencyTypeId CurrencyType enumeration member Currency type
ParentId Integer Parent Id
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ContactMoneyValues

Property Name Property Value Property Description
AuthorizationLimit Decimal or NULL Authorization Limit
RequestLimit Decimal or NULL Request Limit.
NotificationThreshold Decimal or NULL Notification threshold. Money.
CurrencyTypeId CurrencyType enumeration member Currency type
ParentId Integer Parent Id
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

TaskMoneyValues

Property Name Property Value Property Description
Nte Decimal or NULL Task max price limit - Not to exceed amount.
CurrencyTypeId CurrencyType enumeration member Currency type
ParentId Integer Parent Id
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

UserPayRateMoneyValues

Property Name Property Value Property Description
Rate Decimal or NULL Rate per hour. Precision 2 digits; negative values are not allowed. Supported values are from 0 to 9999999.99.
CurrencyTypeId CurrencyType enumeration member Currency type
ParentId Integer Parent Id
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

RoleMoneyValues

Property Name Property Value Property Description
NteLimit Decimal or NULL Authorization limit, only non-negative values are accepted. 922337203685477.5807 (max. money value) means "no limit". Allowed values are 0 - 99999999999.99; also special value of 922337203685477.5807 is allowed (means "unlimited").
CurrencyTypeId CurrencyType enumeration member Currency type
ParentId Integer Parent Id
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Portfolio

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
TypeId PortfolioType enumeration member Portfolio type, matches enumeration PortfolioType. Supported values are Primary and Grouping.
ParentPortfolioId Integer Reference to parent portfolio, PortfolioObject.ID. Supported only for primary portfolios. If this field is NULL for primary portfolio, it means particular record is the root of its own hierarchy.
UseBizHours Boolean True means Work Zones's/Portfolio's Business Hours data will participate in workflow inheritance (even when such data is missing).
UseHolidays Boolean True means Work Zones's/Portfolio's Holidays data will participate in workflow inheritance (even when such data is missing).
UseBlackoutDays Boolean True means Work Zones's/Portfolio's Blackout Date data will participate in workflow inheritance (even when such data is missing).
UseOnCall Boolean True means Work Zones's/Portfolio's On Call data will participate in workflow inheritance (even when such data is missing).
UseEscalation Boolean True means Work Zone's/Portfolio's Escalation List data will participate in workflow inheritance (even when such data is missing).
TurnTemplateId Integer
SlaValues [{SlaValuesOverride entity reference}, ...]
BlackoutDays [{BlackoutDay entity reference}, ...]
Holidays [{Holiday entity reference}, ...]
CriticalFacilities CriticalFacilitiesSettingValues enumeration member If set to "Yes," then all {!{Work Orders}!} manually created in a Critical Facilities {!{Property}!} will go through the Approval flow
UnitTemplateID Integer Asset Template ID, optional. References InvTopLevel.ID.
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

AssetTemplate

Property Name Property Value Property Description
DisplayAs String Displayable name
RootAssetId Integer Reference to root Asset, InvItemObject.ID.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

AssetSystem

Property Name Property Value Property Description
Description String
DisplayAs String Gets or sets DisplayAs field value.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ProductCategory

Property Name Property Value Property Description
DisplayAs String DisplayAs
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkProductAndSupplier

Property Name Property Value Property Description
ProductId Integer ProductId
SupplierId Integer SupplierId
PartNumber String PartNumber
IsDefault Boolean IsDefault
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ProductMoneyValues

Property Name Property Value Property Description
UnitPrice Decimal or NULL Product catalog price; negative and zero values are allowed. Max. precision is 4. On save value is rounded automatically to 4 digits after the decimal point at pre-commit stage. This is done without throwing exception.
LastPrice Decimal or NULL Last purchase price; negative and zero values are allowed. Max. precision is 4. On save value is rounded automatically to 4 digits after the decimal point at pre-commit stage. This is done without throwing exception.
CurrencyTypeId CurrencyType enumeration member Currency type
ParentId Integer Parent Id
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ApInvoiceStatus

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
Description String Description; used for predefined records only
ForecastGroupId ForecastGroup enumeration member Forecast Group to which Vendor Invoice status belongs; references vlangForecastGroup.ID. Matches enumeration ForecastGroup; which means zero is allowed value.
ApStateId ApState enumeration member AP State to which Vendor Invoice status belongs; references vlangApState.ID. Matches enumeration ApState; zero is not an allowed value.
ReadyForExport Boolean Boolean flag; True means Vendor Invoices with this status are ready to be exported.
SetOnExport Boolean Boolean flag; True means this status is used when Vendor Invoices are exported.
ChildWoDefault Boolean True indicates AP Status type is used as default selection when child Work Order is created. This can be basic WO or service request.
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

TimeCardWeek

Property Name Property Value Property Description
StartDate DateTime First day of week (no time). Acts like unique ID of the week.
EndDate DateTime Last day of week (no time).
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

TimeCard

Property Name Property Value Property Description
WeekStartDate DateTime Global Week identified by its start; references tcWeekObject.dtStart.
Employee {Employee entity reference} Technician ID
Flagged Integer Flagged != 0 means Time Card is flagged
StatusId TimeCardStatus enumeration member
Week {TimeCardWeek entity reference} Global Week identified by its start.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

TimeCardItem

Property Name Property Value Property Description
Comment String Optional comment provided by Technician.
WorkZone {WorkZone entity reference} Work Zone ID
EndDate DateTime or NULL Date/time when labor ended; local time of the user
SystemEndDate DateTime or NULL Date/time when labor ended (local time of the user) as recorded automatically by application
StartDate DateTime Date/time when labor started; local time of the user
SystemStartDate DateTime or NULL Date/time when labor started (local time of the user) as recorded automatically by application
WeekStartDate DateTime Start date of the Global Week referenced by WeekID. Inherited from tcWeekObject.dtStart.
Duration Integer TCI duration in minutes auto-computed as (dtEnd - dtStart). Only zero and positive values are allowed.
Employee {Employee entity reference} Technician ID
LaborCode {LaborCode entity reference} Labor Code ID
LatitudeStart Decimal Represent geolocation result for "time card start" action
LatitudeStop Decimal Represent geolocation result for "time card stop" action
LongitudeStart Decimal Represent geolocation result for "time card start" action
LongitudeStop Decimal Represent geolocation result for "time card stop" action
TimeCard {TimeCard entity reference} Parent Time Card
TypeId TimeCardType enumeration member Technician ID, references EmployeeObject.ID.
InternalCostItem {FinancialItem entity reference} WO cost labor record
WorkOrder {WorkOrder entity reference} Inherited from WO labor cost record
Qty Integer Quantity, applicable only for Allowance Type. The field is not nullable; non-negative values are allowed.
Rate Decimal Rate copied from CostCodeObject.Rate, applicable only for Allowance Type
MoneyId CurrencyType enumeration member
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ProviderCoi

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
EmployeeId Integer Employee/technician ID, references EmployeeObject.ID.
AmtCoverage {MoneyValue entity reference} Amount of coverage. Max. precision 2 digits; negative values are not allowed.
StatusId InsuranceStatus enumeration member Insurance status, auto-computed. Matches enumeration InsuranceStatus; references vlangInsuranceStatusLookup.ID.
StartDate DateTime Date when insurance coverage starts (date only; no time).
EndDate DateTime Date when insurance coverage ends (date only; no time).
Comment String Coverage details.
CurrencyTypeId CurrencyType enumeration member Chosen currency, references LangLookup.ID.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ResponsibilityType

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
ActorTypeId ActorType enumeration member Standard link to parent object along with ActorId
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ToDoType

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
Description String Description. Max. length is 1024 characters.
IsDefault Boolean Boolean flag; True indicates default To-Do Type. The can be zero or one default record in the table; i.e. configuration with no default record is allowed.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ApprovalTemplateStep

Property Name Property Value Property Description
ApprovalTemplateId Integer Reference to parent Approval, ApprovalObject.ID.
StepNumber Integer 1-based value indicating user-defined position of the item in Approval list. Only positive values are allowed; no guarantee values start from 1 or sequential.
ActorTypeId ActorType enumeration member This field and the next one define person who is member of the list; can be only Technician or Contact. Supported values: ActorType.Employee and ActorType.LeaseUser and ActorType.CorrigoNet.
ActorId Integer ActorId
RuleId ApprovalRule enumeration member Inclusion rule; references vlangApprovalRule.ID. Also, matches enumeration ApprovalRule.
AutoSkipHours Integer Time interval in hours (business hours only) before application auto-skips unresponsive approver. This is number of hours (not minutes). Supported values 0 - 999. 0 means "No Auto-Skip".
IsParallel Boolean Boolean flag; True means person is used as parallel approver.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ApprovalTemplate

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
Steps [{ApprovalTemplateStep entity reference}, ...]
TypeId ProposalType enumeration member
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ProcedureTemplateStep

Property Name Property Value Property Description
ProcedureTemplateId Integer Reference to parent object
Index Integer Index used to sort task items; 1-based
Description String Gets or sets DisplayAs field value.
TypeId ProcedureStepType enumeration member Procedure Step Type; references vlangPlStepType.ID. There is also matching enumeration ProcedureStepType. Step type defines requirements and business rules for Procedure Template Step; it also defines rules for executing Procedure Step. Defined once when Procedure Template Step is created and can't be changed after that.
IsRequired Boolean Boolean Flag; True means step is required. Until it's done, Procedure will remain pending/open.
FieldDescriptor {CustomFieldDescriptor entity reference} ID of the Custom Field Metadata record, references vlangCfDescrObject.ID. This value is required when TypeID == ProcedureStepType.Field; otherwise not supported. It defines what data end user should provide when executing Procedure Step.
AttrDescriptor {AttributeDescriptor entity reference} ID of the Asset Attritbute Metadata record, references vlangModPropObject.ID. This value is required when TypeID == ProcedureStepType.Attribute; otherwise not supported. It defines what data end user should provide when executing Procedure Step.
Instructions String Additional Instructions, optional. Max. length is 200k. This field contains HTML message shown to the end user when Procedure Step is executed.
ConditionType ProcedureStepConditionType or NULL Type of procedure step depending on condition. Matches enumeration ProcedureStepConditionType. Step can be Regular, Parent, or Conditional, depending on hierarchy of steps.
ParentStepId Integer Linking Foreign KEy Field for ParentStep property.
ConditionCustomField {CustomFieldOption entity reference}
ConditionAttribute {AttributeOption entity reference}
YIdx Integer Index of Y in the three-position step number format "X.Y.Z", applicable only for Conditional steps.
ZIdx Integer Index of Z in the three-position step number format "X.Y.Z", applicable only for Conditional steps.
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ProcedureFlagReason

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ProcedureTemplate

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
AllowMarkAll Boolean Boolean flag. True means Procedures created from this template support functionality "mark all steps as done".
AllowNotApplicable Boolean Boolean flag. True means Procedures created from this template can be marked as "not applicable"
BaseId Integer ReferenceId
Steps [{ProcedureTemplateStep entity reference}, ...]
Summary String Summary
OperationalRisks String OperationalRisks
BackoutPlan String BackoutPlan
ProcedureCategories [{LinkProcedureCategoryAndTemplate entity reference}, ...] Procedure Category/Procedure Template Bridge records.
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoProcedureStep

Property Name Property Value Property Description
WorkOrderId Integer Reference to parent WO, WorkOrder2Object.ID. This field is redundant; value provided by parent Procedure.
Index Integer Index defining order of steps inside parent Procedure; value is unique for specific Procedure, 1-based, values are sequentials without gaps. Only positive values are allowed.
Comment String Optional comment which might be entered by user.
Description String Step description. Value is required when Step came from WON (i.e. IsWon == True), otherwise NULL. This field is not expected to be edited by end user. Its value is used as replacement for Custom Field/Asset Attribute Metadata name because these are no available when Step is received from WON.
StatusId ProcedureStatus enumeration member Status ID, references vlangPlStatus.ID. There is also matching enumeration ProcedureStatus. Only Open and Done statuses are supported. For Steps of type Field and Attribute Status ID is calculated by BO; when Step type is Text it's set by end user.
WoProcedureId Integer Reference to parent Procedure, WoProcedureObject.ID.
ProcedureTemplateStep {ProcedureTemplateStep entity reference} Reference to Procedure Template Step from which this Procedure Step was created, references plMasterDetailObject.ID. This field is required when IsWon == False, otherwise NULL.
TypeId ProcedureStepType enumeration member Procedure Step type, references vlangPlStepType.ID; matching enumeration is ProcedureStepType. Type controls validation rules and data availability.
IsWon Boolean Boolean flag. True means Procedure Step was received from WON Requestor, which changes validation rules and data availability.
IsRequired Boolean Boolean flag. True means Procedure won't be "done" until this Step is "done". True is not if Procedure Step type is Document (ProcedureStepType.Document).
FieldDescriptor {CustomFieldDescriptor entity reference} Custom Field Metadata linked to Procedure Step, references cfDescrObject.ID. Value is required when Procedure Step type is Field (ProcedureStepType.Field), otherwise NULL. This reference controls data type required for Procedure Step value and pick list.
AttrDescriptor {AttributeDescriptor entity reference} Asset Attribute Metadata linked to Procedure Step, references ModPropObject.ID. Value is required when Procedure Step type is Attribute (ProcedureStepType.Attribute), otherwise NULL. This reference controls data type required for Procedure Step value and pick list. If at the time of Procedure Step execution asset no longer supports specified attribute, Step will receive status N/A.
DataTypeId CfType enumeration member Data type for Step value, references vlangCfType.ID. Value is required when Procedure Step type is Field or Attribute (ProcedureStepType.Attribute or ProcedureStepType.Field), otherwise NULL.
DataValue String Step value stored as free-text; must be validated according to its data type DataTypeID. Value is required when Procedure Step type is Field or Attribute (ProcedureStepType.Attribute or ProcedureStepType.Field), otherwise NULL.
DataLabel String Data label; required when Step is received from WON (IsWon == True), otherwise NULL. This field is not expected to be edited by end user. Its value is used as replacement for Custom Field/Asset Attribute Metadata name because these are no available when Step is received from WON.
Flag {ProcedureFlagReason entity reference} Flag Reason ID, references vlangPlMasterNoteObject.ID. This value always references Procedure Flag Reasons from the local database, even when Step is received from WON (IsWon == True). CorrigoNet doesn't synchronize Procedure flags between provider and requestor.
IsNotApplicable Boolean Boolean flag; True means Step of type Attribute can't be executed as intended because Asset no longer supports Attribute in question or locked. This affects Step status. This field is supported only when Step type is Attribute; and it's computed by BO under normal circumstances.
MoneyId CurrencyType enumeration member Currency type associated with DataValue. Required when DataTypeID == DataType.Money; otherwise ignored.
ActionsRequired Integer Bitmask of enumeration
ActionsTaken Integer Bitmask of enumeration
CompletedActor {Actor entity reference} Reference to Actor who marked procedure step as done.
DtCompleted DateTime or NULL When procedure step is done, this field contains local timestamp of the completion event. Time zone is taken from WO.
DataValueId Integer or NULL ID of the selected pick-list item (Procedure field or Asset attribute) ID on the Requestor side. Applicable only for Steps of Field and Asset types.
IsVisible Boolean Indicates if the step is currently visible on UI, some conditional steps may be hidden, because their condition is not fulfilled
ConditionType ProcedureStepConditionType enumeration member Conditional type of the step based on enumeration ProcedureStepConditionType
ParentStepId Integer ID of parent step in the same procedure, applicable only for conditional steps
ConditionValueId Integer or NULL ID of pick-list item (Procedure field or Asset attribute) to be selected in the parent step, so conditional step becomes visible, applicable only for conditional steps
StepNumber String Step number as string, it is simple number for regular and parent steps and three-section compound construction for conditional steps
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoProcedure

Property Name Property Value Property Description
WorkOrderId Integer Reference to parent WO, WorkOrder2Object.ID.
ProcedureTemplate {ProcedureTemplate entity reference} Reference to Procedure Template on which Procedure is based on, vlangPlMasterListObject.ID. Required if Procedure type is Regular/Legacy, otherwise NULL.
Asset {Location entity reference} Reference to Asset linked to Procedure, InvItemObject.ID.
DisplayAs String Displayable name, used only by WON Procedures received from requestor. For other Procedures this field is NULL (not zero-length).
TypeId ProcedureType enumeration member Procedure type based on enumeration ProcedureType with supported values Regualr (self-explaining), Legacy (migrated from earlier version of the product) and WON (received from requestor). 0 is supported value.
AllowMarkAll Boolean Boolean flag. True means Procedures created from this template support functionality "mark all steps as done". Inherited from Procedure Template.
AllowNotApplicable Boolean Boolean flag. True means Procedures created from this template can be marked as "not applicable". Inherited from Procedure Template.
IsNotApplicable Boolean Boolean flag. True means Procedure is marked as "not applicable".
Flag {ProcedureFlagReason entity reference} Flag Reason ID, references vlangPlMasterNoteObject.ID. This field is computed by BO based on Procedure Steps state.
StatusId ProcedureStatus enumeration member Status ID, references vlangPlStatus.ID. This field is computed by BO based on Procedure Steps state. There is also matching enumeration ProcedureStatus.
Index Integer Integer index value defining Procedure's position among other Procedures for parent Work Order; this value is unique withing Work Order scope. Only positive values are allowed.
Steps [{WoProcedureStep entity reference}, ...]
Summary String Summary
OperationalRisks String OperationalRisks
BackoutPlan String BackoutPlan
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

StockLocation

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
Number String Number (often used by integration)
TypeId MhLocationType enumeration member Stock Location Type, references vlangMhLocationType.ID. There is also matching enumeration MhLocationType. Please note 0 (zero) is valid value.
ShipToName String Name of the contact person for shipping. Used only by regular Stock Locations.
BillToName String Name of the contact person for billing. Used only by regular Stock Locations.
DeliveryInstructions String Delivery instructions. Used only by regular Stock Locations.
Comments String Comments.
AllowNegativeQty Boolean True means Stock Location allows negative Product quantities.
MoneyId CurrencyType enumeration member Chosen currency, references LangLookup.ID.
TimeZoneId Integer Stock Location's time zone.
StreetAddresses [{Address2 entity reference}, ...] Street address with TypeId == StreetAddrType.Primary is shipping address; the one with TypeId == StreetAddrType.Alt is billing address.
ContactAddresses [{ContactInfo entity reference}, ...] Contact address with AddrTypeId == ContactAddrType.PrimPhone is shipping phone number; the one with AddrTypeId == ContactAddrType.AltPhone is billing phone number.
CustomFields [{CustomField2 entity reference}, ...]
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ReplenishmentOrder

Property Name Property Value Property Description
StatusId MhOrderStatus enumeration member Current status; affects business logic and BO checks. References vlangMhOrderStatus.ID; there is also enumeration MhOrderStatus.
Description String Free-text description.
PoNumber String Purchase Order number.
DEstimatedtDelivery DateTime or NULL Estimated delivery date (date only, no time).
Supplier {Employee entity reference} Provider associated with MH Order; references EmployeeObject.ID.
StockLocation {StockLocation entity reference} Stock Location associated with MH Order; references MHLocationObject.ID. Value set once when MH Order is created and never changes.
SupplierInstructions String Supplier instructions.
SupplierOrderNumber String Supplier Order Number.
IsExported Boolean True means MH Order was exported. Allowed only when status is Received; reserved for integration.
Number String Number. Will be generated automatically for new MH Order if missing; based on global sequence.
TimeZone Integer Time Zone inherited from Stock Location referenced by MHLocationID; value set once when MH Order is created and never changes. This is redundant field used to interpret timestamp values stored as part of MH Order hierarchy.
CurrencyTypeId CurrencyType enumeration member Currency Type, references LangLookup.ID. Inherited from Stock Location; never changes.
Items [{ReplenishmentOrderItem entity reference}, ...]
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ReplenishmentOrderItem

Property Name Property Value Property Description
ReplenishmentOrderId Integer Parent MH Order; references MhOrderObject.ID.
Product {Product entity reference} Product ID. References MhProductObject.ID.
Price {MoneyValue entity reference} Unit price. Precision 4 digits; negative and zero values are allowed. Supported values are from -9999999.9999 to 9999999.9999. User-friendly name: Unit Cost
QtyOrdered Decimal Quantity ordered. Precision is 5 digits; supported values are 0.00001 - 9999999.99999; zero and negative values are not allowed. User-friendly name: Quantity
QtyReceived Decimal Quantity received. Precision is 5 digits; supported values are 0 - 9999999.99999; zero value is allowed. User-friendly name: Quantity Received
AmtTotal {MoneyValue entity reference} Item's total value computed automatically as Price * QtyOrder.
CurrencyTypeId CurrencyType enumeration member Currency Type, references LangLookup.ID. Inherited from Stock Location; never changes.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ApprovalScope

Property Name Property Value Property Description
ActorId Integer This field and ActorTypeId define parent object to which Approval Scope is linked.
ActorTypeId ActorType enumeration member This field and ActorId define parent object to which Approval Scope is linked.
IsDefault Boolean Boolean flag; True indicates default Approval for parent object.
ApprovalTemplate {ApprovalTemplate entity reference} Reference to parent Approval, ApprovalObject.ID.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

CustomFieldAutocompleteOption

Property Name Property Value Property Description
DescriptorId Integer
Value String
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

TimeOff

Property Name Property Value Property Description
EmployeeId Integer ID of the vacationing Employee/technician, or ID of the provider associated to blackout period. References EmployeeObject.ID.
StartDate DateTime Start of the vacation, date + time. Interpreted as local date/time values, time zone depends on context.
EndDate DateTime End of the vacation, date + time. Interpreted as local date/time values, time zone depends on context.
ReplaceById Integer Replacement Employee/technician ID, references EmployeeObject.ID.Required for Vacation Schedule, NULL for blackout period.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

SlaValuesOverride

Property Name Property Value Property Description
ActorTypeId ActorType enumeration member
ActorId Integer
PriorityId Integer Reference to Priority ID associated with SLA rule See predefined lists of priorities
DueInMinutes Integer Default value for the time in which WO must be completed, number of minutes. Supported values 1-599999.
RespondInMinutes Integer Default value for the time in which WO must be started, number of minutes. Supported values 1-599999.
AckInMinutes Integer Default value for the time in which WO must be acknowledged (started), number of minutes. Supported values 0-599999."0" means "do not compute Acknowledge By".
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Turn

Property Name Property Value Property Description
AssetId Integer Asset; references InvItemObject.ID. Required
WtTemplateId Integer Parent Work Template; references vlangWtTemplateObject.ID.
DtReadyByDue DateTime or NULL Read/Due By date for parent Turn WO. User may provide this value explicitly when creating a Turn. If specified, dtDue will define Turn WO's Due By value.
DtParentScheduledStart DateTime or NULL Scheduled start date for parent Turn WO. This value is exposed as "Move Out Date" on UI; it's either entered by end user or taken from Space record.
StatusId TurnStatus enumeration member
ErrorDetails String Error feedback for failed Turns. This value is set by scheduler if Turn Work Order can't be created due to failure.
WorkOrderId Integer
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkModelAndAttribute

Property Name Property Value Property Description
ModelId Integer
AttributeDescriptorId Integer
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

BillToOption

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
Code String Code which is intended for use in financial support and integrations. Max. length is 64 characters
TypeId BillToTypeRule enumeration member Specifies additional restrictions for Bill To Type; based on enumeration BillToTypeRule. This field is supported only for system-defined records.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

PrintoutTemplate

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
IsDefault Boolean IsDefault field
IsHidden Boolean IsHidden field
StatusId PrintoutStatus enumeration member True means WO Printout body has passed security validation which is done inside Printouts web application.
ActorTypeId ActorType enumeration member References Actor Type for which particular printout is defined, vlangActorTypeLookup.ID.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

InvoiceLog

Property Name Property Value Property Description
Invoice {Invoice entity reference} Parent invoice
Actor {Actor entity reference} System actor who performed the action
Idx Integer Action log record number, unique for the invoice. This value is assigned by invoice BO. Required.
ActionTypeId CiActionType enumeration member Action type ID; references CLookup[TypeID = 'CIAT'].ID, required. Supported values are C|T|P|D - created, tax computed, posted, paid.
DtStamp DateTime Timestamp when action was performed(Can be ovveriden), required. At the moment server time is used.
DtActual DateTime Actual timestamp of invoice action At the moment server time is used.
Comments String Action comments, optional.
Id Integer Internal Id
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

QuoteOrEstimateItem

Property Name Property Value Property Description
WorkOrderId Integer Reference to parent WO, WorkOrder2Object.ID.
ParentId Integer Next two fields - standard link to parent object. Supported values for ObjectTypeID are ActorType.Quote and ActorType.Estimate only.
ParentTypeId ActorType enumeration member Next two fields - standard link to parent object. Supported values for ObjectTypeID are ActorType.Quote and ActorType.Estimate only.
InvoiceItem {InvoiceDictionaryItem entity reference} Invoice Dictionary Item associated with the record, required.
Description String Item description; used for presentation purposes. May be auto-computed in some scenarios (for instance, when legacy provider submits Quote and requestor is in "multi-line" mode); generally provided by user.
Quantity Decimal Quantity. This field is explicitly set by user (except for labor costs where user specifies duration in minutes; then Qty is computed). Precision is 5 digits; supported values are 0 - 9999999.99999.
Rate {MoneyValue entity reference} Item's rate.
Amount {MoneyValue entity reference} Item's total amount. Precision 2 digits; negative and zero values are allowed.
IsFlagged Boolean Boolean flag; True means Line Item was marked as objectionable by person reviewing parent Quote/Estimate. Flags are used when Quote/Estimate is rejected to clearly indicate which Line Items caused the rejection.
TaxCode {TaxCode entity reference} Tax Code ID; references ciTaxCodeObject.ID. This field is used only by tax line itmes associated with country-specific tax codes. This field is NULL for free-text tax line items. Tax line items are the ones with ciDictID == CostCategory.Tax.
CurrencyTypeId CurrencyType enumeration member Currency type inherited from Financial Record upon creation
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

MaterialTransaction

Property Name Property Value Property Description
TypeId MhTransactionType enumeration member Exposed as MhTransactionType enumeration member.
WorkOrderId Integer For retrieval only; ignored when material transaction is committed.
PoNumber String Purchase Order number.
SupplierId Integer Supplier, references EmployeeObject.ID.
SupplierOrderNumber String Supplier's order number.
TransactionDate DateTime Date/time when MHT was committed; required for committed transactions. This is local time stamp by time zone MhLocationID MhLocationObject.TimeZone. This value is either computed by application or entered manually by user.
Comments String Comments.
CreatorId Integer For retrieval only; ignored when material transaction is committed.
CreatorTypeId ActorType enumeration member For retrieval only; ignored when material transaction is committed.
IsCommitted Boolean For retrieval only; ignored when material transaction is committed.
StockLocationId Integer Reference to base Stock Location, MHLocationObject.ID.
SourceStockLocationId Integer Source Stock Location, supported and required only when transaction type is Transfer. References MHLocationObject.ID.
ReplenishmentOrderId Integer Back reference to MH Order ID, MHOrderObject.ID. Supported only when Transaction type is Receive, otherwise NULL.
Items [{MaterialTransactionItem entity reference}, ...] Exposed as list of MaterialTransactionItem entities.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

MaterialTransactionItem

Property Name Property Value Property Description
TransactionId Integer For retrieval only; ignored when material transaction is committed.
ProductId Integer
StockLocationId Integer For retrieval only; ignored when material transaction is committed.
SourceStockLocationId Integer For retrieval only; ignored when material transaction is committed.
TypeId MhTransactionType enumeration member Exposed as MhTransactionType enumeration member. For retrieval only; ignored when material transaction is committed.
FinancialItemId Integer For retrieval only; ignored when material transaction is committed.
Quantity Decimal Unit price. This field is required if transaction type is Receive; and will be computed by BO for Use in Service and Transfer transactions
Price Decimal or NULL Unit price. This field is required if transaction type is Receive; and will be computed by BO for Use in Service and Transfer transactions
LineAmount Decimal or NULL MHT Item subtotal. This field is auto-computed as Round(Qty * Price) when Price is not NULL; otherwise it's NULL
ReplenishmentOrderItemId Integer Back reference to MH Order Item ID, MHOrderDetObject.ID. Supported only when Transaction type is Receive, otherwise NULL.
CurrencyTypeId CurrencyType enumeration member Currency Type. This field is required when Price is not NULL; otherwise it's NULL.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

StockLocationInventoryDetails

Property Name Property Value Property Description
StockLocationId Integer Reference to parent Stock Location, MHLocationObject.ID.
ProductId Integer Reference to Product, MHProductObject.ID.
Price Decimal or NULL Unit price.
Quantity Decimal Quantity.
CreatedOn DateTime Timestamp showing when Product Lot record was created; i.e. when this particular set of parts/materials was delivered to Stock Location.
CurrencyTypeId CurrencyType enumeration member Currency type complementing Price.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

InternalCostStatus

Property Name Property Value Property Description
Name String Gets or sets DisplayAs field value.
Description String
ForecastGroupId ForecastGroup enumeration member
InternalCostStateId CostState enumeration member
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoFlag

Property Name Property Value Property Description
WoId Integer Parent work order, references WorkOrder2Object.ID.
FlagId Integer Flag Reason ID referencing WOActionReasonLookup.ID, i.e. loosely linked enumeration is WoActionReason. Note: Value of this database field and BO property is 256 * [flag action ID] + [reason ID].
UtcStamp DateTime UTC value indicating when this particular Flag was set most recently. This value is the same as WoActionLog2Object.UtcActual. It's not presented to the end user but rather used by BO to compute WorkOrder2Object.AttnFlagID.
Comment String Optional comment provided when this particular Flag was set most recently.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ProcedureCategory

Property Name Property Value Property Description
DisplayAs String DisplayAs
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkProcedureCategoryAndTemplate

Property Name Property Value Property Description
ProcedureCategoryId Integer
ProcedureTemplateId Integer
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkProductAndQtyAttribute

Property Name Property Value Property Description
ActorId Integer Parent Object ID
ActorTypeId ActorType enumeration member Parent Object Type ID
ProductId Integer Reference to MhProductObject.ID.
Qty Decimal This field defines a quantity of parts for certain model and/or asset.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

RequiredDocCategory

Property Name Property Value Property Description
DisplayAs String DisplayAs
IsRemoved Boolean Gets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WorkTemplate

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
Description String Free-text descriptions.
AssetTemplate {AssetTemplate entity reference} Asset Template
Model {Model entity reference} Main Model
WoSubType {WorkOrderType entity reference} User-defined WO Type
Priority {WoPriority entity reference} WO priorit
Specialty {Specialty entity reference} Specialty
IsAutoAssign Boolean Boolean flag; True means WO created from Work Template will be auto-assigned.
IsAutoSend Boolean Boolean flag; True means WO created from Work Template will be auto-sent to provider when it happens to be assigned to connected provider.
CreatedOn DateTime Date/time of the last update
UpdatedBy {Actor entity reference} Actor who updated template last.
IsDefault Boolean Boolean flag; True means Work Template is used as default Turn Template.
MainAssetId Integer Main Asset, references InvItemObject.ID. This field indicates last user selection for main Asset/Model; and used mostly by UI when user adds items to Work Template. This reference may be broken if Asset is deleted, and it's acceptable and expected behavior. Because of that BO property is scalar int32 value.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Proposal

Property Name Property Value Property Description
Type ProposalType enumeration member Type, references vlangProposalType.ID.
Status ProposalStatus enumeration member Type, references vlangProposalStatus.ID.
Amount {MoneyValue entity reference} Amount. Only positive values are supported, max. value is the same as PmSchedule.VendorNte. Max. precision is 2 digits.
WorkZone {WorkZone entity reference} Work Zone ID, references CommunityObject.ID.
WorkOrder {WorkOrder entity reference} Work Order ID, references WorkOrder2Object.ID.
Description String Description/comments.
Approval {ApprovalTemplate entity reference} Indicates which template was used to create Proposal. Only Approval Templates of the "Standard" type are available to be set
UtcSubmitted DateTime or NULL UTC timestamp reflecting when Proposal status changes to Waiting for Approval; computed by BO.
Documents [{Document entity reference}, ...] Documents
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WorkOrderCostCategory

Property Name Property Value Property Description
DisplayAs String Gets or sets DisplayAs field value.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoSchedule

Property Name Property Value Property Description
WorkOrderId Integer Parent work order, references WorkOrder2Object.ID.
WorkOrder {WorkOrder entity reference} Instance of parent work order
ScheduledStart DateTime Defines moment when work is expected to start.
Duration Integer Expected scheduled duration is minutes.
TravelTimeTo Integer Expected travel time to is minutes.
TravelTimeFrom Integer Expected travel time from is minutes.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

RcsCircuit

Property Name Property Value Property Description
ObjectId Integer Parent object for the circuit
ObjectTypeId ActorType enumeration member Gets or sets type ID of the object referenced by record.
Asset {Location entity reference} Reference to parent object when ObjectTypeId == ActorType.Asset
AssetSystem {AssetSystem entity reference} Reference to parent object when ObjectTypeId == ActorType.AssetSystem
Number String Number; unique for the whole list of Circuits including retired records.
EquipmentName String EquipmentName; unique for the list of Circuits including retired records in the same workzone.
Manufacturer String The company that makes the circuit.
Model String The specific type of the refrigerant circuit offered by the manufacturer.
IsMetric Boolean True means Capacity is in kilograms (kg); False means Capacity is in pounds (lb + oz). This field is set when Circuit is created and can't be modified.
MhProduct {Product entity reference} Refrigerant Product; references MHProductObject.ID.
Capacity Decimal Capacity is in pounds or kilograms depending on IsMetric.
LeakRate Decimal Current leak rate value as computed by application (it's done automatically). Value is stored as percentage
LeakThreshold Decimal Leak rate threshold. If leak rate exceeds this value, user must execute leak resolution workflow. Value is stored as percentage.
Comments String Free-text comments.
StatusId RcsCircuitStatus enumeration member Circuit status
EquipmentTypeID Byte or NULL The category of refrigerant equipment
InstallDate DateTime or NULL Install Date
LocationDescription String Physical location of the circuit.
LocationTypeID Byte or NULL Location Type
LeakDetectionCoverID Byte or NULL Automatic Leak Detection Cover
FullChargeCalcMethodID Byte or NULL Full Charge Calculation Method
HasLeakInspection Boolean Do you know when the last leak inspection was carried out on this equipment?
LeakInspectionDate DateTime or NULL Last Leak Inspection Date when HasLeakInspection is set True.
IsLeakDetectionEquipment Boolean Is this Leak Detection Equipment?
LeakDetectionDeviceTypeID Byte or NULL The type of leak detection equipment
HasEquipmentCalibration Boolean Do you know when the last calibration was carried out on this equipment?
EquipmentCalibrationDate DateTime or NULL Equipment Calibration Date
Actions [{RcsAction entity reference}, ...] Linked Rcs Actions
LeakRateLogs [{RcsLeakRateLog entity reference}, ...] Linked Rcs RcsLeakRateLogs
RcsCircuitMonitorMapping [{RcsCircuitMonitorEquipment entity reference}, ...] Circuit monitor equipment mappings where this circuit is the parent (leak detection equipment). Exposed as RcsCircuitMonitorMapping (entity type name) like Asset on RcsCircuit.
IsMothball Boolean IsMothball
ModelYear Integer or NULL Model Year
TemperatureClassificationID Byte or NULL The type of Temperature Classification
CalendarLeakRate Decimal or NULL The Calendar Leak Rate
EquipmentStatusId RcsCircuitEquipmentStatus or NULL Equipment Status
OperationalStatusId RcsCircuitOperationalStatus or NULL Operational Status
OperationalStatusDate DateTime or NULL Operational Status Date
DateOfOperation DateTime or NULL Date of operation
DetectionLimit Decimal or NULL
AlarmSetPoint Decimal or NULL
SerialNumber String
ConcentrationMonitorTypeID Byte or NULL
SensorTypeID Byte or NULL
NumberofSensors Integer or NULL
SensorManufacturer String
LocationOfSensorsInlets String
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

RcsAction

Property Name Property Value Property Description
TypeId RcsActionType enumeration member Circuit status
DtWhen DateTime or NULL Date when RCS Action is performed. Please note this field is date only, no time. For certain RCS Actions this value is entered manually by user as date only; thus it's been decided to record date only for all actions. When application needs accurate chronological order, additional sorting by ID is used.
ActorId Integer or NULL Actor who performed RCS Action. In some cases this value is entered explicitly by user.
ActorTypeId ActorType or NULL Actor who performed RCS Action. In some cases this value is entered explicitly by user.
CertNumber String Optional certification number; a proof that RCS Action was performed by certified specialist.
Product {Product entity reference} Refrigerant Product used in RCS Action, references MHProductObject.ID. This field is computed by application when Cylinder or Circuit reference is available.
Qty Decimal or NULL Amount of refrigerant involved in RCS Action in pounds or kilograms depending on IsMetric.
IsMetric Boolean True means Qty is in kilograms (kg); False means Qty is in pounds (lb + oz). This field is used and verified by application when Cylinder or Circuit reference is available.
CostValue Decimal or NULL Optional value of RCS Action. Used by RcsActionType.Purchased, RcsActionType.Refilled and RcsActionType.Disposed. Precision 2 digits; negative and zero values are allowed.
Supplier {Employee entity reference} Optional Supplier information used by some RCS Action types.
PoNumber String Optional Purchase Order Number used by some RCS Action types.
WorkOrderId Integer Work Order associated with RCS Action, references WorkOrder2Object.ID. Supported and required if RCS Action Type has vlangRcsActionTypeLookup.NeedsWO == True.
Comments String Free-text comments.
Circuit {RcsCircuit entity reference} Circuit involved in RCS Action, references rcsCircuitObject.ID. This value is supported and required if RCS Action Type has vlangRcsActionTypeLookup.NeedsCircuit == True.
CircuitNumber String External Circuit number used as CircuitID replacement for RCS Actions where vlangRcsActionTypeLookup.NeedsCircuit == True. For these actions either CircuitID or CircuitNumber must be provided.
Cylinder {RcsCylinder entity reference} Cylinder involved in RCS Action, references rcsCylinderObject.ID. Supported and required if RCS Action Type has rcsActionTypeLookup.NeedsCylinder == True (see also CylinderNumber).
CylinderNumber String External Cylinder number used as CylinderID replacement for RCS Actions RcsActionType.Added and RcsActionType.Recovered. For these actions either CylinderID or CylinderNumber must be provided.
NoLeakRate Boolean True means RCS Action doesn't affect Leak Rate. This field is used only by RcsActionType.Added.
RcsTestMethodId RcsTestMethod enumeration member Test method referencing vlangRcsTestMethod.ID. This field is used by some Circuit-based RCS Actions.
IsTestPassed Boolean Boolean flag applicable to RcsActionType.LeakTestInitial and RcsActionType.LeakTestFollow. True means test was successful.
IsContactNotified Boolean True indicates responsible party was notified about the status of the leak. This field is used by some Circuit-based RCS Actions.
CylinderSource {RcsCylinder entity reference} Cylinder from which refrigerant is transferred, references rcsCylinderObject.ID. This field is supported and required only by RcsActionType.Transferred.
MoneyId CurrencyType enumeration member Complementary value for Cost; validated for RCS Actions RcsActionType.Purchased and RcsActionType.Refilled. This field is nullable; BO will set it to NULL for unsupported RCS Action Types.
QtyCylinder Decimal or NULL Amount of refrigerant remaining in the Cylinder referenced by CylinderID after RCS Action is done. This field is computed by application when Cylinder reference is available. Value is in pounds or kilograms depending on IsMetric. Precision is 4 digits; supported range is -99999999999999.9999 - 99999999999999.9999; zero value is allowed.
QtyCylinderSource Decimal or NULL Amount of refrigerant remaining in the "source" Cylinder CylinderID after transfer occurred. This field is computed by application as part of RcsActionType.Transferred. Value is in pounds or kilograms depending on IsMetric. Precision is 4 digits; supported range is -99999999999999.9999 - 99999999999999.9999; zero value is allowed.
RcsStockTypeId RcsActionStockType enumeration member How the recovered refrigerant is going to be managed
ShippedTo String Who was the refrigerant shipped to
DtShipment DateTime or NULL Date of shipment
ReclamationCompany String Reclamation company
AmountReclaimed Decimal Amount Reclaimed
AmountDestroyed Decimal Amount Destroyed
RcsLeakCauseId RcsLeakCause enumeration member The cause of the leak occurring on the circuit
LeakCauseDescription String Leak Cause Description - additional description when Leak Cause is "Other"
IsScheduled Boolean Boolean flag for indicating whether the action is scheduled
DtDue DateTime or NULL Schedule date
ParentAction {RcsAction entity reference} Parent action object
TechName String Technician Name
CertClassId EmpCertificationClass enumeration member Refrigerant Certification Class
RcsExtensionReasonId RcsExtensionReason or NULL Repair Leak Extension Reason
LeaksFound Boolean Boolean flag for indicating LeaksFound is true || false
LeaksFoundCount Byte Count of leaks found
IsALDCalibrationSuccess Boolean Boolean flag for ALDCalibrationSuccess
EquipmentDestinationManager {Employee entity reference} EquipmentDestinationManager
EquipmentDestinationId Integer EquipmentDestinationId
RemainingCapacity Decimal RemainingCapacity of the Circuit
ParasenseId String Id of the Parasense Procedure
RefrigerantTypeOfRepairId RcsTypeOfRepair or NULL Leak Repair Type
TypeOfRepairDesc String Leak Repair Type Description
AlarmSetPoint Decimal or NULL Alarm Set Point for ALD Calibrations
DetectionLimit Decimal or NULL Detection Limit for ALD Calibrations
RcsLeakLocationId RcsLeakLocation enumeration member Leak Location - The specific location where the leak occurred.
RcsLeakLocationDetailId RcsLeakLocationDetail enumeration member Leak Location Details - Breakdown of the specific components where the leak occurred.
ServiceEventId Integer Service Event Id of the transaction.
RefrigerantHistory RefrigerantHistoryType or NULL Refrigerant History
InitialCharge Boolean Is Added transaction initial charge.
HasComponentIsolated Boolean Has Component Isolated
DtIsolation DateTime or NULL Isolation Date
DtEndIsolation DateTime or NULL Isolation End Date
RcsInspectionReasonID RcsInspectionReason enumeration member Rcs Inspection Reason ID
DtALDAlarm DateTime or NULL ALD Alarm Date
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

RcsCylinder

Property Name Property Value Property Description
BaseNumber String Base value for cylinder number. It's either provided by end user (then it's expected to be unique) or copied from Cylinder which is being replaced, in which scenario new MinorID will be used to produce a new unique Number value.
MinorId Integer Integer value used to generate new unique Cylinder number when existing Cylinder is replaced. Negative values are not allowed. MinorID may be generated by application; 0 value means "no minor ID".
Number String Number; unique for the whole list of Cylinders including retired records. This field is auto-computed by application as "[BaseNumber]" or "[BaseNumber]-[MinorID]" (for "replace" scenario).
IsMetric Boolean True means Capacity is in kilograms (kg); False means Capacity is in pounds (lb + oz). This field is set when Circuit is created and can't be modified.
MhProduct {Product entity reference} Refrigerant Product; references MHProductObject.ID.
Capacity Decimal Capacity is in pounds or kilograms depending on IsMetric. Precision is 4 digits; supported range is 0 - 99999999999999.9999; zero value is not allowed.
Qty Decimal Current quantity in pounds or kilograms depending on IsMetric.
Comments String Free-text comments.
StatusId RcsCylinderStatus enumeration member Cylinder status; references vlangRcsCylinderStatus.ID; also there is matching enumeration RcsCircuitStatus. Supported values are Active and Disposed.
MoneyId CurrencyType enumeration member Chosen currency type, references LangLookup.ID.
IsRecovery Boolean True means Cylinder is used as temporary storage for refrigerant recovered from equipment. "Recovery" cylinders tweak business logic for some transactions, such as RcsActionType.Added.
Price {MoneyValue entity reference} Refrigerant price. Precision 4 digits; negative and zero values are allowed.
Actions [{RcsAction entity reference}, ...] Linked Rcs Actions
CommunitiesBridge [{LinkCommunityAndRcsCylinder entity reference}, ...] Linked Rcs LnkCommRcsCylinders
EmployeesBridge [{LinkEmployeeAndRcsCylinder entity reference}, ...] Linked Rcs LnkEmpRcsCylinder
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkCommunityAndRcsCylinder

Property Name Property Value Property Description
CommunityId Integer Work Zone ID, references CommunityObject.ID.
CylinderId Integer Cylinder ID, references rcsCylinderObject.ID
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LinkEmployeeAndRcsCylinder

Property Name Property Value Property Description
EmployeeId Integer Employee ID, references EmployeeObject.ID
CylinderId Integer Cylinder ID, references rcsCylinderObject.ID
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

RcsLeakRateLog

Property Name Property Value Property Description
Circuit {RcsCircuit entity reference} Parent Circuit, references rcsCircuitObject.ID.
RcsAction {RcsAction entity reference} RCS Action that caused Leak Rate calculation, references rcsActionObject.ID. This value is NULL when ReasonID == RcsLeakRateReason.Capacity. Note this reference may become broken if RCS Action is deleted; and it's expected behavior.
RcsActionTypeId RcsActionType enumeration member RCS Action type, references vlangRcsActionTypeLookup.ID, there is also matching enumeration RcsActionType. Most of BO rules for RCS Action is controlled by this field. This value is NULL when ReasonID == RcsLeakRateReason.Capacity.
UtcWhen DateTime UTC timestamp indicating time when Leak Rate was calculated. BO will automatically compute this value if necessary.
ReasonId RcsLeakRateReason enumeration member Reason for computing Leak Rate based on enumeration RcsLeakRateReason. There is no matching dictionary table because this enumeration is not exposed to end user.
LeakRate Decimal Leak Rate value for Circuit as computed. Precision is 1 digit; negative values and zero are allowed; supported range is -99999999999999.9 - 99999999999999.9.
LeakRateMethodId RcsLeakRateMethod enumeration member Method for computing leak rate based on enumeration RcsLeakRateMethod.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

RcsCircuitMonitorMapping

Property Name Property Value Property Description
LeakDetectionEquipment {RcsCircuit entity reference} Leak detection equipment (parent) - references RcsCircuitObject.ID
MonitorEquipment {RcsCircuit entity reference} Monitor equipment - references RcsCircuitObject.ID
StartDate DateTime Start date when the monitor equipment is associated with the parent equipment
EndDate DateTime or NULL End date when the monitor equipment association ends (nullable)
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

BlackoutDay

Property Name Property Value Property Description
DisplayAs String Blackout day name/label.
DtStart DateTime This field contains date (i.e. no time part) indicating a start date of blackout days.
DtEnd DateTime This field contains date (i.e. no time part) indicating a end date of blackout days.
AppliesToCriticalWos Boolean True means a critical work order can be created in Blackout day.
AppliesToStandardWos Boolean True means a standard work order can be created in Blackout day.
ActorId Integer
ActorTypeId ActorType enumeration member
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

ShiftHours

Property Name Property Value Property Description
EmployeeId Integer
Employee {Employee entity reference} Employee/technician ID, references EmployeeObject.ID.
DayIdx Integer
StartTime DateTime or NULL
FinishTime DateTime or NULL
FinishDayIdx Integer or NULL
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoVisit

Property Name Property Value Property Description
WorkOrderId Integer Parent work order ID.
WorkOrder {WorkOrder entity reference} Parent work order ID.
DtWhen DateTime Date/time value indicating when the visit operation is performed. Derived from DtCheckin or DtCheckout if not explicitly set.
VerifyComments String Free-text comments provided as part of verification. Max 1024 characters. Required when VerificationId = Bad.
OtherComments String Free-text comments provided as part of visit execution (check-in/check-out) or when Visit is created manually. Max 1024 characters.
PmSequenceId Integer PM Schedule identifier (int64). For local WOs stores PM Schedule ID; for WOs received from requestor stores requestor ID (higher 4 bytes) + PM Schedule ID (lower 4 bytes).
IsBad Boolean Boolean flag computed by application. True means Visit status is automatically computed as "Bad" based on IsManual, IValidated and OValidated values.
IsManual Boolean True means Visit record was created manually by dispatcher/manager rather than via Visit Check-In/Check-Out action.
VerificationId VisitStatus enumeration member Visit verification status assigned by user. None=0, Bad=1, Good=2. Value None means Visit wasn't verified manually.
EmployeeId Integer Technician or Provider ID linked to the Visit. Inherited from WO's primary assignee when Visit is created.
TimeZone Integer Time zone inherited from parent work order when Visit is created.
DtCheckin DateTime or NULL Date/time value for Check-In event in TimeZone. NULL means Visit has no Check-In event.
IPhone String Phone number used for Check-In via IVR. Max 32 characters.
ILatitude Decimal GPS latitude of technician/provider when Check-In was executed. Range: -90 to 90.
ILongitude Decimal GPS longitude of technician/provider when Check-In was executed. Range: -180 to 180.
IValidated Boolean True means presence of technician/provider was validated for Check-In event.
IWeather String Weather conditions around Check-In event. Max 512 characters. Used only for WOs with user-defined type WOSubtype.PmWeather.
DtCheckout DateTime or NULL Date/time value for Check-Out event in TimeZone. NULL means Visit has no Check-Out event.
OPhone String Phone number used for Check-Out via IVR. Max 32 characters.
OLatitude Decimal GPS latitude of technician/provider when Check-Out was executed. Range: -90 to 90.
OLongitude Decimal GPS longitude of technician/provider when Check-Out was executed. Range: -180 to 180.
OValidated Boolean True means presence of technician/provider was validated for Check-Out event.
OWeather String Weather conditions around Check-Out event. Max 512 characters. Used only for WOs with user-defined type WOSubtype.PmWeather.
Documents [{Document entity reference}, ...] Visit attachments
Services [{WoVisitSvc entity reference}, ...] Visit services collection - defines activities performed during this Visit.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoVisitCfg

Property Name Property Value Property Description
WorkOrderId Integer Parent work order ID.
VsFrequency Integer Visits frequency - expected number of visits per week. Values 0-7; 0 means open schedule.
VsExpected Integer Expected number of visits for parent WO. Computed based on DtStart, DtEnd and VsDaySched.
VsMaxNumber Integer Maximum number of visits for WO. Values 0-999; 0 means no limit. Used only for open schedules (VsFrequency=0).
VsDaySched WeekdayMask enumeration member Weekday bitmask for scheduled visit days. Bit 0x01=Sunday, 0x02=Monday, etc.
DtStart DateTime Start of the period for WO visits. Date value linked to parent WO's time zone (inclusive).
DtEnd DateTime End of the period for WO visits. Date value linked to parent WO's time zone (not inclusive).
VsArrivalTime DateTime or NULL Arrival window start time. Time only without date part. Null means arrival window is undefined.
VsArrivalWindowMn Integer Arrival window length in minutes. Values 0-1439 (one day minus one minute).
ServiceCnt Integer Number of services for a visit to select from.
IsVisitAlert Boolean True means visit alerts are required for this WO. Inherited from PM Schedule or requestor WO.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

WoVisitSvc

Property Name Property Value Property Description
ActorId Integer Parent object ID (Visit or WorkOrder).
ActorTypeId ActorType enumeration member Parent object type (Visit or WO).
CiItem {InvoiceDictionaryItem entity reference} Invoice Dictionary Item reference for billing.
Credit Byte Percentage of value delivered by service (0-100). Default is 100.
Rate {MoneyValue entity reference} Service rate for billing.
MoneyId CurrencyType enumeration member Currency type inherited from work zone.
WonIdx Integer Auto-computed unique key identifying service across WON. Either 0 (default svc), CiItemId (local WO), or WonServiceId (WON).
WonServiceId Integer Visit service ID from Requestor (WON). Non-zero only for WON-received WOs.
WonServiceDisplayAs String Name of the visit service. Non-empty only for WON-received WOs.
IsDefaultSvc Boolean True when service is attached to Visit object with default CiItem value.
ConcurrencyId Integer Gets or sets the concurrency identifier used for optimistic locks.
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

LirOutstandingInvoiceWorkOrder

Property Name Property Value Property Description
ProviderId Integer Identifier of the provider associated with the work order.
ProviderName String
IsProviderConnected Boolean
Nte Decimal
MoneyId CurrencyType enumeration member
MoneyCode String
NteInDefaultCurrency Decimal
WorkOrderNumber String
WorkOrderSpecialty String
PropertyId Integer
PropertyName String
WorkDescription String
DaysOverdue Integer
DateTimeCompletedUtc DateTime
NumberOfNotifications Integer
VerificationRatingId WoRating or NULL
VerificationRating String
WoApState ApState or NULL
WOType WOType or NULL
Customer String
InvoiceAmount Decimal
PropertyNumber String
PropertyAddress String
ChargeCode String
ExpenseAccount String
Id Integer Gets or sets a Corrigo entity identifier.
Properties [{PropertyTreeNode object reference}, ...] List of filled properties
LimitMultipleEntitiesNumberBehaviour Boolean Return exception instead of payload if there are more record was retrieved than configured in "*option_name*" company property Used for limiting records in Integration REST API

Additional Entity Models :

MoneyValue

Property Name Property Value Property Description
CurrencyTypeId CurrencyType enumeration member
Value Decimal

TaxDetail

Property Name Property Value Property Description
JurisType JurisdictionType enumeration member
JurisName String
Rate Decimal
TaxCalculated Decimal
MoneyId Integer
TaxDate DateTime or NULL

MockConfiguration

Property Name Property Value Property Description
ProcedureTemplateStepReposition Nullable`1 or NULL

Commands :

AddChildWorkOrderRoutine return : AddChildWorkOrderResponse

Property Name Property Value Property Description
WoItemIds [Integer, ...] List of WO Item IDs which will be used as a source for creating new child WO. All items must belong to the same WO; and at least one ID value must be provided.

AiResponseRequiredWoStatisticCommand return : CommandResponse

Property Name Property Value Property Description
UserEmail String
ProcessedDays Integer or NULL

ApStatusChangeCommand return : FinancialStatusChangeResponse

Property Name Property Value Property Description
VendorInvoiceStatusId Integer New value for Vendor Invoice Status
KeepCommentIntact Boolean Boolean flag; True means routine will not alter Comment value provided by caller.
CurrentStatusId Integer Current value of WorkOrderCost.ApStatusId, optional. Together with FinancialConcurrencyID, define concurrency check logic for this action. Since this action is inherited from WoAction it also supports WO concurrency ID check based on StatusID and ConcurrencyId properties. The expected usage scenario for "Vendor Invoice Status Change" action is StatusID = APInvoiceStatus.Unknown and ConcurrencyId = 0; e.g. WO concurrency check is turned off.
FinancialConcurrencyId Integer FinancialConcurrencyID: Current value of WorkOrderCost.ConcurrencyId, optional.
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

ApSubmitPaymentCommand return : FinancialStatusChangeResponse

Property Name Property Value Property Description
PaymentAmount Decimal
CheckNumber String
CheckCutDate DateTime or NULL
VendorInvoiceStatusId Integer New value for Vendor Invoice Status
KeepCommentIntact Boolean Boolean flag; True means routine will not alter Comment value provided by caller.
CurrentStatusId Integer Current value of WorkOrderCost.ApStatusId, optional. Together with FinancialConcurrencyID, define concurrency check logic for this action. Since this action is inherited from WoAction it also supports WO concurrency ID check based on StatusID and ConcurrencyId properties. The expected usage scenario for "Vendor Invoice Status Change" action is StatusID = APInvoiceStatus.Unknown and ConcurrencyId = 0; e.g. WO concurrency check is turned off.
FinancialConcurrencyId Integer FinancialConcurrencyID: Current value of WorkOrderCost.ConcurrencyId, optional.
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

AssetMatchByTaskCodeCommand return : MatchAssetsResponse

Property Name Property Value Property Description
ParentAssetId Integer Parent asset ID, required.
AssetCategories [AssetType enumeration member, ...] Array of AssetType enumeration values. Empty array (i.e. containing zero items) is acceptable.
TaskCode String Required (zero-length and null values are not allowed)
RecordCount Integer Number of records to return (no more than X). 0 value is acceptable.

CostStatusChangeCommand return : FinancialStatusChangeResponse

Property Name Property Value Property Description
CostStatusId Integer New value for Vendor Invoice Status
KeepCommentIntact Boolean Boolean flag; True means routine will not alter Comment value provided by caller.
CurrentStatusId Integer Current value of WorkOrderCost.ApStatusId, optional. Together with FinancialConcurrencyID, define concurrency check logic for this action. Since this action is inherited from WoAction it also supports WO concurrency ID check based on StatusID and ConcurrencyId properties. The expected usage scenario for "Vendor Invoice Status Change" action is StatusID = APInvoiceStatus.Unknown and ConcurrencyId = 0; e.g. WO concurrency check is turned off.
FinancialConcurrencyId Integer FinancialConcurrencyID: Current value of WorkOrderCost.ConcurrencyId, optional.
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

CreateWoPrintoutCommand return : CreateWoPrintoutResponse

Property Name Property Value Property Description
WorkOrderId Integer ID of the Work Order.
PrintoutTemplateId Integer ID of the printout template
LanguageId Integer Scalar integer value specifying what language should be used for the printout.

GeneratePmWoCommand return : WoActionResponse

Property Name Property Value Property Description
PmScheduleId Integer
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

GetAiResponseRequiredWorkOrdersCommand return : CommandResponse

Property Name Property Value Property Description
Login String
Filters {AiResponseRequiredWorkOrdersFilters object reference}
SortBy String
SortDirection String
Take Integer or NULL
Skip Integer or NULL

GetAlertCommand return : CommandResponse

Property Name Property Value Property Description
WorkOrderId Integer

GetCompanySettingCommand return : CommandResponse

Property Name Property Value Property Description
SettingId String Required. Company setting ID.

GetCompanyWsdkUrlCommand return : GetCompanyWsdkUrlResult

Property Name Property Value Property Description
CompanyName String Gets or sets Company Name.
Protocol Protocols enumeration member Gets or sets Protocol.
ApiType ApiTypes enumeration member REST or SOAP

GetCustomerByAssetCommand return : CommandResponse

Property Name Property Value Property Description
AssetId Integer Asset ID, required
SearchCustomerInWorkZone Boolean Boolean flag, default true, indicates if the command should search for customer in WorkZone or not

GetDocDownloadUrlCommand return : CommandResponse

Property Name Property Value Property Description
DocumentIds [Integer, ...] Array of document IDs based on dmDocObject.ID.

GetInvoiceListDataCommand return : CommandResponse

Property Name Property Value Property Description
Login String
Filters {InvoiceListMcpFilters object reference}
SortBy String
SortDirection String
Take Integer or NULL
Skip Integer or NULL

GetInvoiceTileDataCommand return : CommandResponse

Property Name Property Value Property Description
Login String

GetLicensedProvidersRoutine return : GetLicensedProvidersResponse

Property Name Property Value Property Description
SpecialtyId Integer Required. This is Specialty ID. 0 is acceptable value meaning "Unspecified Specialty".
PostalCode String Required when licensing is used, otherwise ignored.
TimeStamp DateTime or NULL Optional; used by licensing module to process blackout periods.
CustomerId Integer Optional; used by licensing module to process exclusions.
RecordCount Integer Max. number of records to return.
Country String Country code for PostalCode. If empty/undefined, "US" will be used.

GetPreferredAssigneesRoutine return : GetPreferredAssigneesResponse

Property Name Property Value Property Description
SpecialtyId Integer Required. This is Specialty ID. 0 is acceptable value meaning "Unspecified Specialty".
WorkZoneId Integer Required when instance is configured to use Specialty-based dispatch list, otherwise ignored. This is Work Zone ID.
PostalCode String Required when licensing is used, otherwise ignored.
TimeStamp DateTime Optional; used by licensing module to process blackout periods.
CustomerId Integer Optional; used by licensing module to process exclusions.
RecordCount Integer Max. number of records to return.
UpdateRoundRobin Boolean Boolean flag. When True and instance is configured to use round-robin, underlying data will be modified.
Country String Country code for PostalCode: used only when instance is configured to use License-based routing. If empty/undefined, "US" will be used.

GetPricingAgentTileDataCommand return : CommandResponse

Property Name Property Value Property Description
Login String

GetPricingAgentWorkZonesSpecialtiesCommand return : CommandResponse

Property Name Property Value Property Description
Login String
WorkZonesSkip Integer or NULL
WorkZonesTake Integer or NULL
WorkZonesSortBy String
WorkZonesSortDirection String
SpecialtiesSkip Integer or NULL
SpecialtiesTake Integer or NULL
SpecialtiesSortBy String
SpecialtiesSortDirection String

GetProcedureStepsDocumentsRoutine return : GetProcedureStepsDocumentsResponse

Property Name Property Value Property Description
WorkOrderId Integer Required. ID of a Work Order to get the list of procedure steps documents

GetTimeCardCommand return : TimeCardActionResponse

Property Name Property Value Property Description
EmployeeId Integer User ID. Together with BaseDate defines TimeCard entity which will be retrieved/created.
BaseDate DateTime Date value defining time interval for Time Card. This doesn't have to be a start of the week; application will automatically determine correct time interval containing BaseDate.

InvoiceDisputeCommand return : UpdateInvoiceStateCommandResponse

Property Name Property Value Property Description
InvoiceId Integer ID of the Customer Invoice.
Timestamp DateTime or NULL Date/time value for backdating "Dispute Invoice", optional.
Comment String Optional comment.

InvoiceRecallCommand return : UpdateInvoiceStateCommandResponse

Property Name Property Value Property Description
InvoiceId Integer ID of the Customer Invoice.
Timestamp DateTime or NULL Date/time value for backdating "Dispute Invoice", optional.
Comment String Optional comment.

LirGetAllPreviewsCommand return : CommandResponse

Property Name Property Value Property Description
Email1 String

LirGetProviderContactsCommand return : CommandResponse

Property Name Property Value Property Description
Email1 String
ProviderId Integer

LirOutstandingInvoiceProviderCommand return : CommandResponse

Property Name Property Value Property Description
Filters [LirInvoiceProviderFilterExpression, ...]
Email1 String
Take Integer
Skip Integer
SortBy String
SortDirection OrderType enumeration member

LirOutstandingInvoiceProviderContactCommand return : CommandResponse

Property Name Property Value Property Description
Filters [LirInvoiceProviderFilterExpression, ...]
Email1 String
Take Integer
Skip Integer
SortBy String
SortDirection OrderType enumeration member

LirOutstandingInvoiceWoDetailsCommand return : CommandResponse

Property Name Property Value Property Description
Filters [LirInvoiceWoDetailsFilterExpression, ...]
Email1 String
Take Integer
Skip Integer
SortBy String
SortDirection OrderType enumeration member

MakeDocumentPublicCommand return : CommandResponse

Property Name Property Value Property Description
DocumentId Integer

MaterialTransactionCommitCommand return : MaterialTransactionCommitResponse

Property Name Property Value Property Description
Transaction {MaterialTransaction entity reference}

PortfolioDeleteCommand return : CommandResponse

Property Name Property Value Property Description
PortfolioId Integer Portfolio ID, required.

PostPaymentCommand return : CommandResponse

Property Name Property Value Property Description
PaymentId Integer Gets or sets an payment id.
Timestamp DateTime or NULL Gets or sets a timestamp (optional).

PostScheduleAISolutionCommand return : CommandResponse

Property Name Property Value Property Description
RequestId Guid Unique identifier that correlates this callback with the original scheduling request.
Solution {SchedulingSolution object reference} Scheduling solution data. Present when Status is "completed".
Error {DecisionEngineErrorResponse object reference} Error information. Present when Status is "failed".
Status Status enumeration member Status of the scheduling request: - completed: Successfully generated scheduling solution - failed: Request failed due to error - cancelled: Request was cancelled before completion

ProposalRejectCommand return : CommandResponse

Property Name Property Value Property Description
ProposalId Integer ID of the Proposal, required.
Comment String Optional comment.

ScheduleRcsActionCommand return : CommandResponse

Property Name Property Value Property Description
ActionTypeId RcsActionType enumeration member Id of the RcsActionType.
CircuitId Integer Id of the Circuit.
DueDate DateTime Due date.
ParentId Integer or NULL Parent id of the RcsAction.
WorkOrderId Integer or NULL Id of the Work Order.
ParasenseId String Id of the Parasense Procedure.

SendWorkOrderCommand return : SendWorkOrderResponse

Property Name Property Value Property Description
WorkOrderId Integer ID of the Work Order.
SendTo String Optional e-mail address for sending work order; used only when WO is assigned to non-connected provider.
RequestQuote Boolean True means Quote will be requested from provider.

SetWorkOrderDependencyCommand return : WoActionResponse

Property Name Property Value Property Description
MainWorkOrderId Integer Id of Work Order acting as master of the dependency
DependentWorkOrderId Integer Dependent Work Order Id. If this value is zero or null, it means existing dependency if being cleared.

SpaceCreateCommand return : SpaceCreateCommandResponse

Property Name Property Value Property Description
CustomerId Integer Parent Customer ID, required.
StartDate DateTime Start date, optional.
EndDate DateTime End date, optional.
MoveInDate DateTime Move in date, optional.
MoveOutDate DateTime Move out date, optional.
Instructions String Free-text value containing additional notes/instructions, optional.
UnitId Integer ID of the Unit associated with the Space. Zero means new Unit will be created based on NewUnitSpecifier parameter.
IfUnitAlreadyExists DuplicateUnitMode enumeration member Optional. Controls how duplicate units are treated; one of DuplicateUnitMode enumeration values. If value is not specified, application assumes DuplicateUnitMode.Ignore.
NewUnitSpecifier {NewUnitSpecifier object reference} Reference to object containing information about the new Unit. Ignored when UnitId != 0.

TimeCardActionCommand return : TimeCardActionResponse

Property Name Property Value Property Description
EmployeeId Integer User ID. Together with WeekStartDate defines which TimeCard entity will be modified
WeekStartDate DateTime Date value; must be equal to one of existing Time Card Week's start date. This parameter effectively defines reference to Time Card Week.
ActionId TimeCardAction enumeration member Defines type of the action performed; TimeCardAction enumeration.
Comment String Optional comment.

UpdateInvoiceStateCommand return : UpdateInvoiceStateCommandResponse

Property Name Property Value Property Description
InvoiceId Integer Gets or sets an invoice id.
State CiInvoiceState enumeration member Gets or sets a required state.
Timestamp DateTime or NULL Gets or sets a required timestamp (optional).
Comment String Gets or sets a comment (optional).

UpdateRefrigerantSyncSettingsCommand return : CommandResponse

Property Name Property Value Property Description
Status Boolean Gets or sets the sync status, true if the sync was successfull, otherwise false.
LastSync DateTime Gets or sets the last sync datetime.

UpdateWoInductionAndSafetyStatusCommand return : WoActionResponse

Property Name Property Value Property Description
InductionAndSafetyStatusID IsmStatus enumeration member
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

UserOrProviderSuspendCommand return : CommandResponse

Property Name Property Value Property Description
Id Integer User ID or Provider ID value.
Reactivate Boolean or NULL Nullable Boolean property controlling operation: suspend on unsuspend, optional. When value is missing, User/Provider will be suspended.

UserSignInInfoCommand return : UserSignInInfoResponse

Property Name Property Value Property Description
UserIds [Integer, ...] List of User ID values, required
SignInThresholdDate DateTime or NULL Date/time value controlling the time interval for computing number of sign-in actions. Only sign-ins performed after SignInThresholdDate will be taken into account. NULL value is allowed; it means no sign-in count is necessary.

VerifyWorkCommand return : VerifyWorkResponse

Property Name Property Value Property Description
WorkOrderId Integer ID of the Work Order.
WoRatingId WoRating enumeration member Verification rating, based on enumeration WoRating.
Comment String Optional comment.

WoAddProcedureCommand return : CommandResponse

Property Name Property Value Property Description
AssetId Integer Required. Asset that will be linked with a new procedure
ProcedureTemplateId Integer Required. Procedure template for a new procedure
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoAssignCommand return : WoActionResponse

Property Name Property Value Property Description
Assignees [Integer, ...] Employee.Ids of users for an assignment
Mode ChangeAssignmentMode enumeration member How Assignees parameter is treated. Four modes supported: Primary, AddSecondary, RemoveSecondary and Snapshot. In Snapshot mode, Assignees collection is treated as new list of assignees for WO; and first item in that list is treated as primary assignee. In all modes Assignees can be empty.
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoAutoAssignRoutine return : EmployeeResponse

Property Name Property Value Property Description
WorkOrder {WorkOrder entity reference}
Zip String This property is no longer and use; it's kept to preserve backward compatibility. Please don't use. If you are using License-based auto assignment, please provide postal code as part of Work Order street address.

WoCancelCommand return : WoActionResponse

Property Name Property Value Property Description
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoCheckInCommand return : CommandResponse

Property Name Property Value Property Description
EmployeeId Integer or NULL
Latitude Decimal or NULL
Longitude Decimal or NULL
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoCheckOutCommand return : CommandResponse

Property Name Property Value Property Description
EmployeeId Integer or NULL
Latitude Decimal or NULL
Longitude Decimal or NULL
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoClearFlagsCommand return : WoActionResponse

Property Name Property Value Property Description
FlagsToClear Integer Array of Flag IDs to set containing WoActionReason enumeration values.
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoCompleteCommand return : WoActionResponse

Property Name Property Value Property Description
RepairCodeId Integer Repair Code Id can be specified to set RepairCode.
CompletionNoteOption CompletionNoteOptions enumeration member Completion Note Option: Ignore, Replace, FillEmpty
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoCopyCommand return : WoActionResponse

Property Name Property Value Property Description
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoCreateCommand return : WoActionResponse

Property Name Property Value Property Description
WorkOrder {WorkOrder entity reference} Reference to Work Order entity, required. Integration client must provide property values as specified below.
WpTree {WpTree entity reference} Reference to Work Plan Link entity, optional. Integration client needs to provide this property only when new WO is created as part of work plan.
EmployeeId Integer Primary assignee ID; 0 means Work Order remains unassigned. This value is ignored if ComputeAssignment == True.
KeepUnassigned Boolean True means integration services will not perform auto-assignment routine.
ComputeSchedule Boolean True means "Schedule" routine will be executed. Default value is False.
ComputeAssignment Boolean True means "Auto Assignment" routine will be executed. Default value is False.
EmergencyDisabled Boolean Boolean flag. True means WO priority value will be de-escalated from emergency to highest non-emergency priority
SkipBillToLogic Boolean True means integration services will use billing configuration as specified rather than automatically compute billing settings for new WO. Matches CreateWoAction.SkipContract.
SkipProcedures Boolean Boolean flag. True means routine will not attach punch lists to new WO automatically.
SkipPriority Boolean Boolean flag. True means routine will not recalculate WO priority base on Tasks priority.
AllowNewUnassignedEmergencies Boolean True means routine will routine allows unassigned emergencies.
ExternalNumber String Optional string containing "external" WO number (provided by third-party application)
ScheduledTransactions [Integer, ...] This will be a list of Scheduled Transaction Id's
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoFlagCommand return : WoActionResponse

Property Name Property Value Property Description
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoLastModificationCommand return : WoLastModificationResponse

Property Name Property Value Property Description
WorkOrderId Integer Gets or sets an Work Order ID.

WoMessageCommand return : WoActionResponse

Property Name Property Value Property Description
SenderId Integer Message sender ID, optional.
SenderType ActorType enumeration member Message sender type ID, optional. This is scalar enumeration value matching ActorType.
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoOnHoldCommand return : WoActionResponse

Property Name Property Value Property Description
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoPauseCommand return : WoActionResponse

Property Name Property Value Property Description
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoPickUpCommand return : WoActionResponse

Property Name Property Value Property Description
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoRecallCommand return : WoActionResponse

Property Name Property Value Property Description
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoReopenCommand return : WoActionResponse

Property Name Property Value Property Description
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WorkZoneCreateCommand return : WorkZoneCommandResponse

Property Name Property Value Property Description
WorkZone {WorkZone entity reference} Reference to Work Zone entity, required.
AssetTemplateId Integer Scalar integer value equal to Asset Template ID used to create Work Zone, optional.
SkipDefaultSettings Boolean Boolean flag; True means command won't apply default Work Zone settings.

WorkZoneDefaultCommand return : WorkZoneCommandResponse

Property Name Property Value Property Description

WorkZoneDeleteCommand return : WorkZoneCommandResponse

Property Name Property Value Property Description
WorkZoneId Integer Work Zone ID, required.

WorkZoneOfflineCommand return : WorkZoneCommandResponse

Property Name Property Value Property Description
WorkZoneId Integer Work Zone ID, required.
DeactivateCustomers Boolean Boolean flag; True means all active Customers should be deactivated (i.e. deleted).

WorkZoneOnlineCommand return : WorkZoneCommandResponse

Property Name Property Value Property Description
WorkZoneId Integer Work Zone ID, required.

WoScheduleRoutine return : WoActionResponse

Property Name Property Value Property Description
WorkOrder {WorkOrder entity reference} Work Order
Options WoScheduleOptions enumeration member Flags (could be combined with bitwise OR) to turn off some WorkOrder's property changes while the command is executed.
OutputPropertySet PropertySet Output Property Set
InputPropertySet PropertySet Input Property Set

WoSetFlagsCommand return : WoActionResponse

Property Name Property Value Property Description
FlagsToSet Integer Array of Flag IDs to set containing WoActionReason enumeration values.
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoStartCommand return : WoActionResponse

Property Name Property Value Property Description
ActionDate DateTime
WorkOrderId Integer
Comment String
StatusId WOStatus enumeration member
ConcurrencyId Integer
ActionReasonId Integer

WoUpdateProcedureStepCommand return : CommandResponse

Property Name Property Value Property Description
ProcedureStepId Integer Required. ID of a procedure step to be updated
Value String Optional. New Value for the procedure step
MoneyId CurrencyType enumeration member Optional. Currency type for procedure step with data type Money
Comment String Optional. New Comment for the procedure step
FlagId Integer or NULL Optional. New Flag for the procedure step
UpdateMask ProcedureStepState enumeration member Required. A bitmask that indicates, what exactly should be updated by the command.
DataValueId Integer or NULL Optional. ID of Value, required for steps branching logic.

WoVisitCheckInCommand return : CommandResponse

Property Name Property Value Property Description
IValidated Boolean True when presence is GPS/IVR validated.
IPhone String Phone number used for Check-In via IVR.
ILatitude Decimal Check-In latitude.
ILongitude Decimal Check-In longitude.
IWeather String Weather conditions for weather-based Visit WOs.
WorkOrderId Integer Target Work Order ID.
DtWhen DateTime Timestamp in Work Order time zone.
OtherComments String Visit execution comments.
Services Integer Optional list of service indexes (WonIdx). Null means all allowed services.

WoVisitCheckOutCommand return : CommandResponse

Property Name Property Value Property Description
OValidated Boolean True when presence is GPS/IVR validated.
OPhone String Phone number used for Check-Out via IVR.
OLatitude Decimal Check-Out latitude.
OLongitude Decimal Check-Out longitude.
OWeather String Weather conditions for weather-based Visit WOs.
WorkOrderId Integer Target Work Order ID.
DtWhen DateTime Timestamp in Work Order time zone.
OtherComments String Visit execution comments.
Services Integer Optional list of service indexes (WonIdx). Null means all allowed services.

WoVisitVerifyCommand return : CommandResponse

Property Name Property Value Property Description
VisitId Integer ID of the Visit to verify, required.
VerificationId VisitStatus enumeration member Verification status to assign. Bad=1, Good=2.
VerifyComments String Verification comments. Required when VerificationId = Bad.
Services [{WoVisitServiceCredit object reference}, ...] Optional service credit overrides for Bad verification. Each entry maps a CiItemId to a credit percentage (0-100). Ignored when VerificationId = Good.

ExtendScheduledRcsActionCommand return : CommandResponse

Property Name Property Value Property Description
Id Integer Id of the RcsAction.
DueDate DateTime Due date.

CompositeCommand return : CompositeCommandResponse

Property Name Property Value Property Description
IsTransactional Boolean Gets or sets a value indicating that all commands should be executed in one transaction.
Commands [{CommandRequest object reference}, ...] Specifies a list of specific CommandRequest instances.

ConvertMoneyValuesCommand return : ConvertMoneyValuesResponse

Property Name Property Value Property Description
Values [{MoneyValue entity reference}, ...] List of money values of type MoneyValue.
TargetCurrencyTypeId CurrencyType enumeration member Currency type into which value will be converted; CurrencyType enumeration.

RestoreCommand return : OperationCommandResponse

Property Name Property Value Property Description
EntitySpecifier {EntitySpecifier object reference} Specifies an entity by identifier and entity type to be restored.

RetrieveWithCurrencyTypeCommand return : RetrieveWithCurrencyTypeResponse

Property Name Property Value Property Description
TargetCurrencyTypeId CurrencyType enumeration member Desired currency type.
ParentEntitySpecifiers [{EntitySpecifier object reference}, ...] List of entities for which data retrieval with conversion will be executed. This list may contain a mix of different parent entities (for instance, EntityType.Specialty and EntityType.Task). Each parent entity is defined by type and ID.

Responses :

AddChildWorkOrderResponse

Property Name Property Value Property Description
WorkOrder {WorkOrder entity reference} reference to new WO instance
WorkPlanLink {WpTree entity reference} Work Plan Link entity
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

AiResponseRequiredWoStatisticCommandResponse

Property Name Property Value Property Description
CountAiResponseRequired Integer
CountProcessedAiMessages Integer
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

CreateWoPrintoutResponse

Property Name Property Value Property Description
PrintoutBody Byte[] Binary contents of a PDF file
Filename String A suggestion for a filename, built using the same logic as application applies when alert attachment is built
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

CustomerResponse

Property Name Property Value Property Description
CustomerId Integer Customer Id
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

EmployeeResponse

Property Name Property Value Property Description
EmployeeId Integer
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

FinancialStatusChangeResponse

Property Name Property Value Property Description
Financial {WorkOrderCost entity reference} Reference to WorkOrderCost entity; contains up-to-date Financial Record state after action finishes.
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

GetAiResponseRequiredWorkOrdersResponse

Property Name Property Value Property Description
Items AiResponseRequiredWorkOrdersListItem[]
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

GetAlertResponse

Property Name Property Value Property Description
AlertResponse [{AlertResponse object reference}, ...]
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

GetCompanySettingResponse

Property Name Property Value Property Description
Value String String, that represents the setting value
Type SettingType enumeration member Enum SettingType that describes the type of the value
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

GetDocDownloadUrlTypeResponse

Property Name Property Value Property Description
Results [{GetDocDownloadUrl object reference}, ...]
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

GetLicensedProvidersResponse

Property Name Property Value Property Description
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

GetPreferredAssigneesResponse

Property Name Property Value Property Description
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

GetProcedureStepsDocumentsResponse

Property Name Property Value Property Description
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

InvoiceListDataResponse

Property Name Property Value Property Description
Items InvoiceListItem[]
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

InvoiceTileDataResponse

Property Name Property Value Property Description
AmountOfPendingInvoices Decimal or NULL
AmountOfApprovedInvoices Decimal or NULL
UtcDateTime DateTime
CurrencyCode String
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

LirResponseBase

Property Name Property Value Property Description
DefaultCurrencyCode String
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

LirGetAllPreviewsResponse

Property Name Property Value Property Description
TotalOfCurrentWoNTE Decimal
TotalOfInvoiceValueSubmitted Decimal
UtcDateTime DateTime
ValidUserScope Boolean
DefaultCurrencyCode String
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

LirGetProviderContactsResponse

Property Name Property Value Property Description
ProviderPhone String
ProviderEmail String
ValidUserScope Boolean
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

LoginResponse

Property Name Property Value Property Description
UserId Integer
ActorTypeId Integer
Success Boolean
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

MatchAssetsResponse

Property Name Property Value Property Description
Locations [{Location entity reference}, ...]
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

MaterialTransactionCommitResponse

Property Name Property Value Property Description
Transaction {MaterialTransaction entity reference}
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

PostScheduleAISolutionResponse

Property Name Property Value Property Description
Processed Boolean Result of the command operation. True if the operation was successful, false otherwise.
RequestId Guid Identifier of the request.
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

PricingAgentTileDataResponse

Property Name Property Value Property Description
ModuleState String
Strategy Integer
UtcDateTime DateTime
InvoiceAmountTotal Decimal
ProposalCount Integer
ActualSavingsNumber Integer
ActualSavingsAmount Decimal
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

PricingAgentWorkZonesSpecialtiesResponse

Property Name Property Value Property Description
CanManageWorkZones Boolean
CanManageSpecialties Boolean
WorkZones PricingAgentWorkZoneItem[]
Specialties PricingAgentSpecialtyItem[]
WorkZonesReturned Integer
SpecialtiesReturned Integer
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

ScheduleRcsActionResponse

Property Name Property Value Property Description
RcsAction {RcsAction entity reference} Scheduled Transaction
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

SendWorkOrderResponse

Property Name Property Value Property Description
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

SpaceCreateCommandResponse

Property Name Property Value Property Description
NewSpace {Space entity reference} New Space entity with only scalar properties initialized.
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

UpdateInvoiceStateCommandResponse

Property Name Property Value Property Description
Invoice {Invoice entity reference}
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

UpdateRefrigerantSyncSettingsCommandResponse

Property Name Property Value Property Description
Status Boolean Gets or sets the sync status. Values: true if sync succeed, otherwise false if failed.
LastSync DateTime Gets or sets a required last sync timestamp.
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

UserSignInInfoResponse

Property Name Property Value Property Description
UserSignInInfos [{UserSignInInfo object reference}, ...]
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

VerifyWorkResponse

Property Name Property Value Property Description
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

WoActionResponse

Property Name Property Value Property Description
Wo {WorkOrder entity reference} Reference to WorkOrder entity; contains up-to-date WO state after WO action finishes. Only scalar properties are returned.
UpdatedPropertySet PropertySet
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

WoProcedureStepResponse

Property Name Property Value Property Description
ProcedureStep {WoProcedureStep entity reference} ProcedureStep entity that was updated.
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

WorkZoneCommandResponse

Property Name Property Value Property Description
WorkZone {WorkZone entity reference} Reference to WorokZone entity; contains up-to-date Work Zone state after command finishes. Only scalar properties are returned.
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

WoVisitCommandResponse

Property Name Property Value Property Description
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

CommandResponse

Property Name Property Value Property Description
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

CompositeCommandResponse

Property Name Property Value Property Description
Responses [{CommandResponse object reference}, ...] Contains a list of CommandResponse for executed commands.
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

ConvertMoneyValuesResponse

Property Name Property Value Property Description
Values [{MoneyValue entity reference}, ...] List of converted MoneyValue instances in the same order they were requested
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

GetCompanyWsdkUrlResult

Property Name Property Value Property Description
Url String
CompanyName String
Protocol Protocols enumeration member
CompanyVersion String
CompanyId Integer
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

OperationCommandResponse

Property Name Property Value Property Description
EntitySpecifier {EntitySpecifier object reference} Gets or sets the entity specifier.
NestedEntitiesOperationResults [{NestedEntityOperationResult object reference}, ...] Gets or sets the collection of operation results performed on nested entities.
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

RetrieveWithCurrencyTypeResponse

Property Name Property Value Property Description
Results [{CorrigoEntityMoneyValues entity reference}, ...]
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

TimeCardActionResponse

Property Name Property Value Property Description
TimeCard {TimeCard entity reference}
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

WoLastModificationResponse

Property Name Property Value Property Description
DtLastModified DateTime
WorkOrderId Integer
ErrorInfo {ErrorInfo object reference} Gets or sets an error info. If null, no error occurred.

Additional Commands Models :

AlertResponse

Property Name Property Value Property Description
Id Integer
AlertId Integer
Content String
ContentShort String
SendCount Integer

GetDocDownloadUrl

Property Name Property Value Property Description
DocumentId Integer
Url String
FileName String

UserSignInInfo

Property Name Property Value Property Description
ID Integer
CreatedDate DateTime or NULL
LastSignInDate DateTime or NULL
SignInCount Integer

WoVisitServiceCredit

Property Name Property Value Property Description
CiItemId Integer Invoice Dictionary Item ID identifying the service.
Credit Integer Credit percentage (0-100). Use 100 for full credit. Values outside this range are rejected during validation.

EntitySpecifier

Property Name Property Value Property Description
EntityType EntityType enumeration member Gets or sets an entity type.
Id Integer or NULL Gets or sets and entity identifier.

ErrorInfo

Property Name Property Value Property Description
Number Integer or NULL Gets or sets an error number.
Description String Gets or sets an error description.
Type String Gets or sets an error type.

NewUnitSpecifier

Property Name Property Value Property Description
BuildingName String
BuildingFloorPlan String
FloorName String
FloorFloorPlan String
UnitName String
UnitFloorPlan String
StreetAddress {Address2 entity reference} Reference to Street Address entity; optional. Provided when caller wants to create Unit's street address. Used only when new Unit is created; otherwise ignored.
UnitInfo {AssetInfo entity reference} Reference to Asset Infor entity, optional. Provided when caller wants to create additional information for the Unit. Used only when new Unit is created; otherwise ignored.
SpaceName String
SpaceFloorPlan String

Enumerations :

ActorType enum

Possible enum values

  • Unknown
  • Employee
  • Occupancy
  • CorrigoNet
  • Resident
  • CommLease
  • CommLeaseSpace
  • Property
  • Portfolio
  • LeaseGroup
  • LeaseUser
  • Supplier
  • Asset
  • WO
  • Org
  • Warranty
  • WOPrintout
  • Team
  • CompanyProp
  • Landmark
  • Provider
  • ReportTimeSet
  • TenantCoi
  • Model
  • Theme
  • CustomerInvoice
  • Payment
  • MhLocation
  • MhProduct
  • PmRmTemplate
  • Document
  • WoProxy
  • Proposal
  • PlWoItem
  • Insurance
  • InvTemplate
  • ReportSubscription
  • Requestor
  • ProcTemplateStep
  • Procedure
  • MhOrder
  • AssetSystem
  • WorkTemplate
  • WtWoProxy
  • Incident
  • Visit
  • DutyType
  • Estimate
  • Quote
  • WoActionLog
  • ProcedureTemplate
  • WoRequiredDoc
  • WoSchedule
  • Rounds
  • RoundsSchedule
  • RoundsStep
  • Specialty
  • ReceiptStorageRecord
  • MhTransaction
  • MhConsumptionRequest
  • AlertSend

AlertType enum

Possible enum values

  • Unknown
  • Emergency
  • ApptReminder
  • ApptChanged
  • FlaggedTech
  • EscalationExpired
  • AssignedWo
  • BadSurevy
  • OverdueWoPrior
  • OverdueWo
  • NewWo
  • FlaggedScope
  • WoCancelled
  • WorkPlanComplete
  • WoUnassigned
  • WoOnHold
  • WoPriorityChange
  • VisitOverdue
  • ImpairmentOverdue
  • ImpairmentWellOverdue
  • TenantCoiExpires
  • QuoteReview
  • CustomerNoteAssignee
  • OnSiteLatePrior
  • BadVerify
  • CustomerNoteScope
  • CWoCreated
  • CWoPutOnHold
  • CWoCancelled
  • CWoPickedUp
  • CWoRejected
  • CApproveQuote
  • CVerifyWork
  • CWoCompleted
  • CSendWo
  • CProviderMsg
  • CCustomerEstimate
  • CVendorInvoice
  • CCost
  • CApptChange
  • CProviderUrgentMsg
  • ProposalCurrent
  • ProposalEnds
  • ProposalSkipped
  • PwdExpiration
  • AssetStatus
  • ActiveIncident
  • OpenIncident
  • IncidentUpdate
  • CpPwdExpiration
  • ProDisconnect
  • CriticalFacilitiesCurrent
  • CriticalFacilitiesEnds
  • OfflineDownloadTimeoutExpires
  • OfflineDownloadStatusIsReleased
  • IncidentDraft
  • WorkOrderRenamed
  • CriticalFacilitiesCreateIncidentProposalRequest
  • CriticalFacilitiesReviewIncidentProposalRequest
  • CriticalFacilitiesCreateIncidentApprovalRequestStatusChanged
  • CriticalFacilitiesReviewIncidentApprovalRequestStatusChanged
  • WoMessageSentAlertType
  • RoundsCreatedWithAssignment
  • RoundsReassignedProvider
  • RoundsAssignmentRemoved
  • RoundsRejected
  • RoundsCancelled
  • RoundsRecalled
  • RoundsNotAccepted
  • RoundsEwEnding
  • RoundsEwEndingProvider
  • RoundsMultipleGenerated
  • RoundsMissed
  • RoundsIncomplete
  • RoundsPaused
  • RoundsPausedProvider
  • RoundsNotAssigned
  • RoundsMassCancelled
  • ApproachingNTEAssignee
  • ApproachingNTEScope
  • EmailAttachment
  • EmailAttachmentFailure
  • LateInvoiceVendorReminder
  • VendorInvoiceApprovalReminder
  • VendorInvoiceManagerEscalation
  • VendorInvoiceSubmittedCategory

ApprovalRule enum

Possible enum values

  • Unknown
  • Always
  • AsNeeded
  • WhenMore

ApState enum

Possible enum values

  • None
  • Received
  • Paid
  • Waiting
  • Authorized
  • Exported
  • Disputed

CostState enum

Possible enum values

  • Pending
  • Submitted
  • Approved
  • Exported

AssetType enum

Possible enum values

  • Unknown
  • Regular
  • Building
  • Unit
  • Community
  • RoomArea
  • Floor
  • Utility
  • Equipment

BillToType enum

Possible enum values

  • None
  • Customer
  • WorkZone
  • Other
  • Location

BillToTypeRule enum

Possible enum values

  • None
  • LogicDisabled
  • WoDisabled

ContactAddrType enum

Possible enum values

  • Unknown
  • PrimPhone
  • PrimEmail
  • AltPhone
  • Pager
  • EmergencyEMail
  • EmergencyPhone
  • AltEmail
  • EMail1
  • EMail2
  • EMail3
  • HomePhone
  • OfficePhone
  • MobilePhone
  • WAP
  • Fax
  • Contact
  • Website
  • CssEmail
  • CssPhone
  • PaymentRemittanceEmail

CostCategory enum

Possible enum values

  • Unknown
  • Labor
  • Material
  • Misc
  • Vendor
  • SpotPurchase
  • AddCharges
  • Services
  • Shipping
  • Adjustments
  • Tax

DistanceUnit enum

Possible enum values

  • Unknown
  • Kilometer
  • Mile

EmployeeWonStatus enum

Possible enum values

  • NA
  • NotConnected
  • Suspended
  • Connected
  • Invited

ForecastGroup enum

Possible enum values

  • None
  • Waiting
  • Submitted
  • AuthOrPaid

GeoStatus enum

Possible enum values

  • None
  • Failed
  • Protected

IsmStatus enum

Possible enum values

  • NotApplicable
  • NotRequired
  • Passed
  • PassedManual
  • Waiting
  • Started

InsuranceStatus enum

Possible enum values

  • None
  • Expired
  • ExpiringSoon
  • Current

LsNoteAccess enum

Possible enum values

  • Unknown
  • None
  • View
  • AddEdit

MhLocationType enum

Possible enum values

  • Other
  • Garage
  • Basement
  • Closet
  • Warehouse
  • StoreRoom
  • Truck
  • Cylinder

MhTransactionType enum

Possible enum values

  • Other
  • Receive
  • UseInService
  • Issue
  • Adjust
  • Return
  • Transfer
  • Remove

MhUnit enum

Possible enum values

  • Unit
  • Kg
  • Lb
  • Liter
  • Gal
  • Ml
  • Oz
  • Meter
  • Ft
  • Box
  • Set
  • Package
  • Ppm

ProcedureStatus enum

Possible enum values

  • Unknown
  • Open
  • NA
  • Done
  • UnderReview

ProcedureType enum

Possible enum values

  • Regular
  • Legacy
  • WON

ProcedureStepType enum

Possible enum values

  • Unknown
  • Text
  • Field
  • Attribute
  • Document

ProposalStatus enum

Possible enum values

  • Unknown
  • Draft
  • Pending
  • Approved
  • Rejected
  • Insufficient
  • DraftWaiting
  • SubmittedWaiting
  • RejectedByCustomer
  • RejectedByServiceProvider

ProposalType enum

Possible enum values

  • Standard
  • Estimate
  • Quote
  • ApInvoice
  • Nte
  • Purchase
  • Other
  • WorkOrder
  • ProcedureTemplate
  • IncidentStart
  • IncidentCompletion
  • IncidentCompletionExtended
  • RoundsSchedule
  • FoundWork
  • ConsumptionRequest

ProviderlType enum

Possible enum values

  • Regular
  • Supplier
  • Landlord

PTEType enum

Possible enum values

  • Unknown
  • PTE
  • Appointment
  • CallFirst
  • NotApplicable

PortfolioType enum

Possible enum values

  • Unknown
  • Grouping
  • Primary

QuoteStatus enum

Possible enum values

  • Unknown
  • NotSubmitted
  • Requested
  • WaitingForApproval
  • Approved
  • Rejected
  • InProposal
  • Recalled

ExcludeCoi enum

Possible enum values

  • InheritGlobalSettings
  • No
  • ExcludeAndBlock
  • ExcludeAndWarn

RcsActionType enum

Possible enum values

  • Unknown
  • Purchased
  • Disposed
  • Refilled
  • CylinderRelease
  • CircuitRelease
  • Added
  • Recovered
  • Tested
  • Transferred
  • LeakIdentified
  • LeakRepaired
  • LeakTestFollow
  • Created
  • CircuitEdit
  • Retired
  • LeakTestInitial
  • Adjusted
  • CylinderEdit
  • LeakInspected
  • ALDCalibrated
  • Retrofitted
  • Activated
  • ServicedOrLeakRepaired

RcsActionStockType enum

Possible enum values

  • Unknown
  • SupplierStock
  • OwnerStock
  • External

RcsInspectionReason enum

Possible enum values

  • Unknown
  • PlannedMaintenance
  • UnplannedMaintenance
  • AutomaticLeakDetectionAlarm
  • Other

RcsLeakCause enum

Possible enum values

  • Unknown
  • Corrosion
  • JointFailure
  • NormalWear
  • RubOut
  • Rupture
  • SealFailure
  • Vibration
  • Abuse
  • Warranty
  • MechanicalFailure
  • Catastrophe
  • Other

RcsLeakLocation enum

Possible enum values

  • Unknown
  • Compressor
  • DischargeLine
  • Condenser
  • Receiver
  • LiquidLine
  • Evaporator
  • SuctionLine
  • HeatRecovery
  • Piping
  • Purge
  • Valve
  • RuptureDisc
  • Other

RcsLeakLocationDetail enum

Possible enum values

  • Unknown
  • BodyOrTerminalLugs
  • Fittings
  • FlangesOrCouplings
  • HeadGasket
  • OilFloat
  • OilSeparatorOrOilLine
  • PressureControlTransducer
  • Schrader
  • ShaftSeal
  • VibrationEliminator
  • LiquidInjectionValve
  • CompressorRepairNotOtherwiseListed
  • AmbientValve
  • BallValve
  • CheckValve
  • Header
  • HotReclaimCoil
  • HotGasBypass
  • Muffler
  • SchraderDisChargeLine
  • Piping
  • OilSeparatorOrRes
  • PressureRegulatingValve
  • PressureControlTransducerDischargeLine
  • DischargeLineRepairNotOtherwiseListed
  • BallValveCondensor
  • CondenserCoil
  • HeaderOrPiping
  • SchraderCondensor
  • SplittingValve
  • TubeBundle
  • PressureControlTransducerCondensor
  • CondenserRepairNotOtherwiseListed
  • KingValve
  • LevelIndicatorOrAlarm
  • PressureReliefValve
  • ReceiverRepairNotOtherwiseListed
  • BallValveLiquidLine
  • DifferentialValve
  • Drier
  • HeaderOrPipingLiquidLine
  • Pump
  • SchraderLiquidLine
  • SightGlass
  • SolenoidValve
  • SubCooler
  • PressureControlTransducerLiquidLine
  • LiquidLineRepairNotOtherwiseListed
  • BallValveEvaporator
  • Coil
  • Distributor
  • PipingEvaporator
  • SchraderEvaporator
  • ExpansionDevice
  • SecondaryHeatExchanger
  • EvaporatorRepairNotOtherwiseListed
  • Accumulator
  • CPR
  • EPR
  • FilterShell
  • SchraderSuctionLine
  • BallValveSuctionLine
  • PipingOrHeader
  • PressureControlTransducerSuctionLine
  • SuctionLineRepairNotOtherwiseListed
  • Valve
  • CapillaryTube
  • JointFlare
  • JointSoldered
  • JointThreaded
  • JointWelded
  • Other
  • PipeWear
  • SolenoidValveForPurge
  • CondensingUnit
  • Filter
  • IsolationValves
  • RegenerationTank
  • SystemPiping
  • TankOrExchanger
  • PurgeRepairNotOtherwiseListed
  • ValveService
  • None
  • MustExplain
  • NoLeakIdentified
  • NothingAdded
  • OtherLocationDetail
  • StartUpOrNewSystem

RcsCircuitStatus enum

Possible enum values

  • Active
  • Retired
  • Retrofitted

RcsCylinderStatus enum

Possible enum values

  • Active
  • Disposed

RcsLeakRateMethod enum

Possible enum values

  • Annualized
  • RollingAverage

RcsLeakRateReason enum

Possible enum values

  • Unknown
  • Capacity
  • Added
  • Included
  • Deleted
  • Excluded
  • TwelveMonthsLeakRateReset

RcsTestMethod enum

Possible enum values

  • Unknown
  • NotTested
  • Pressurizing
  • Electronic
  • DeepVacuum
  • SoapBubbles
  • Other
  • CalibratedLeakDetectionDevice
  • DyeInject
  • HalideDetector
  • OilResidue
  • ApprovedAlternate

BackupRouting enum

Possible enum values

  • Unassigned
  • OnCall
  • Default

SchedInterval enum

Possible enum values

  • Unknown
  • Day
  • Week
  • Month
  • Quarter
  • Year
  • Custom
  • Weather
  • WoComplete
  • RequiredDocumentEnd

TimeCardAction enum

Possible enum values

  • Uknown
  • Flag
  • Submit
  • Approve
  • Export
  • ClearFlag
  • UnSubmit
  • UnApprove
  • UnExport
  • ReadyForExport
  • NotReadyForExport

TimeCardStatus enum

Possible enum values

  • Unknown
  • Pending
  • Submitted
  • Approved
  • Exported
  • ReadyForExport

TimeCardType enum

Possible enum values

  • Uknown
  • Clock
  • Manual
  • WoLabor
  • Allowance

TurnStatus enum

Possible enum values

  • Pending
  • Failed
  • Done

WOActionType enum

Possible enum values

  • Unknown
  • Create
  • PickUp
  • Start
  • OnHold
  • Complete
  • Cancel
  • Reopen
  • Assign
  • Attention
  • APInvStatus
  • Archived
  • Restored
  • Stop
  • AccessChanged
  • Billed
  • DueDateChanged
  • Note
  • Message
  • QuoteRequested
  • CostStatus
  • BillingRuleChanged
  • OwnerChanged
  • Signature
  • ApprovalStart
  • ApprovalEnd
  • ApGlAccountChanged
  • EstimateRejected
  • EstimateApproved
  • ItemAddRemove
  • WarrantyFlagChanged
  • AutoWarranty
  • OnSiteByChanged
  • AckByChanged
  • CustomerChanged
  • EstimateSubmitted
  • WonWoSend
  • WonWoRecall
  • WonWoUpdate
  • WonPaymentSend
  • Verified
  • CustomerNteChanged
  • PriorityChanged
  • SchedStartChanged
  • VendorNteChanged
  • WonDocAttach
  • QuoteSubmitted
  • FlagCleared
  • QuoteRejected
  • QuoteApproved
  • VisitDeleted
  • ApInvoiceCleared
  • ProcedureAddRemove
  • ApInvoiceTaxUpdate
  • IsmStatusChanged
  • Moved
  • ReqDocUploaded
  • ReqDocFileRemoved
  • ReqDocStatusChanged
  • ReqDocUrgentActionsPresent
  • ReqDocUrgentActionsRemoved
  • MessageReceived
  • ProcedureUnderReview
  • ProcedureReviewed
  • LockForOffline
  • UnlockAfterOffline
  • QuoteRecalled
  • EstimateRecalled
  • IncidentReportCreated
  • CriticalWoUnapproved
  • ScheduleSegmentModified
  • WoItemModified
  • ChildWOReposition
  • WoProcedureReposition
  • RefrigerantTransaction
  • TypeChanged
  • AiRecommendationVendorInvoice
  • ApprovalBypassed

WOActionProperty enum

Possible enum values

  • Unknown
  • FlagId
  • SignedBy
  • SignedEmail
  • CostStatusId
  • CostStatus
  • Rating
  • ItemAdded
  • ItemRemoved
  • AssignmentRemoved
  • AssignmentAdded
  • InvoiceId
  • ApInvoiceId
  • ApInvoiceName
  • ByContactId
  • ScanType
  • CustomerAdded
  • CustomerRemoved
  • TriggerEventId
  • PrevWoStatus
  • MsgAddressedTo
  • MsgAddress
  • ApptWindowStart
  • ApptWindowEnd
  • UiSubType
  • ProviderNotCompliant
  • IntValues
  • RequestorWorkZoneId
  • RequestorCustomerId
  • InitialReasonID
  • RequestorWorkZoneNumber
  • RequestorWorkZoneName
  • WoItemChangedFrom
  • WoItemChangedTo
  • WoItemDescrChangedFrom
  • WoItemDescrChangedTo
  • WoRepositionNewNumber
  • WoRepositionOldNumber
  • MsgReceivedFrom
  • MsgRecipients
  • MsgResponseReceivedFrom
  • MsgResponseAiLevel

WarrantyStatus enum

Possible enum values

  • None
  • Expired
  • Active

WoCostExclusion enum

Possible enum values

  • None
  • Item
  • Category
  • Min

WoCostLineType enum

Possible enum values

  • Unknown
  • Cost
  • Vendor
  • ServiceFee

WONoteType enum

Possible enum values

  • Unknown
  • Completion
  • Public
  • Private

WOStatus enum

Possible enum values

  • Unknown
  • Open
  • Paused
  • Cancelled
  • New
  • OnHold
  • InProgress
  • Completed

WOType enum

Possible enum values

  • Unknown
  • Basic
  • PMRM
  • Turn
  • Request

VisitStatus enum

Possible enum values

  • None
  • Bad
  • Good

MhOrderStatus enum

Possible enum values

  • Unknown
  • Pending
  • OnOrder
  • Shipped
  • Received
  • Partial
  • Cancelled

CfSharingMode enum

Possible enum values

  • None
  • ReadOnly
  • ReadWrite

LaborCodeType enum

Possible enum values

  • Unknown
  • Time
  • Allowance

ProcedureStepState enum

Possible enum values

  • None
  • Comment
  • Flag
  • Value

CriticalFacilitiesSettingValues enum

Possible enum values

  • No
  • Yes
  • Inherit

PriceListIntegrationStatus enum

Possible enum values

  • Disabled
  • Enabled

ProcedureStepConditionType enum

Possible enum values

  • Unknown
  • Regular
  • Parent
  • Conditional

EmpCertificationClass enum

Possible enum values

  • None
  • Class1
  • Class1AndClass2
  • Class1AndClass2AndClass3
  • Class1AndClass3
  • Class2
  • Class2AndClass3
  • Class3
  • Universal

CfType enum

Possible enum values

  • Unknown
  • String
  • Integer
  • Decimal
  • Money
  • Phone
  • Date
  • Time
  • Boolean
  • Url
  • Text
  • StringAutocomplete
  • BooleanWithNA

CurrencyType enum

Possible enum values

  • Unknown
  • SAR
  • BGN
  • TWD
  • CZK
  • DKK
  • EUR
  • USD
  • ILS
  • HUF
  • JPY
  • KRW
  • PLN
  • BRL
  • RON
  • RUB
  • HRK
  • SEK
  • THB
  • TRY
  • PKR
  • IDR
  • VND
  • AMD
  • MKD
  • ZAR
  • INR
  • MYR
  • KZT
  • KES
  • KHR
  • MMK
  • LKR
  • PHP
  • NGN
  • CNY
  • CHF
  • GBP
  • MXN
  • NOK
  • BND
  • BDT
  • EGP
  • HKD
  • AUD
  • SGD
  • CAD
  • DZD
  • MOP
  • NZD
  • CRC
  • BAM
  • MAD
  • TND
  • OMR
  • VES
  • COP
  • PEN
  • JOD
  • ARS
  • LBP
  • KWD
  • CLP
  • AED
  • UYU
  • BHD
  • QAR
  • RSD
  • AZN
  • UZS
  • VUV
  • FJD
  • PGK
  • TOP
  • CFP
  • SBD
  • WST
  • MUR
  • BMD

DuplicateUnitMode enum

Possible enum values

  • Unknown
  • Fail
  • Reuse
  • Ignore

PriceListType enum

Possible enum values

  • Customer
  • Vendor

LeaseContactType enum

Possible enum values

  • Unknown
  • Alternate
  • Emergency
  • Primary

LeasingSpaceStatus enum

Possible enum values

  • Unknown
  • Historical
  • Current
  • OnNotice
  • Pending

BillingRule enum

Possible enum values

  • Unknown
  • VendorAndServiceFee
  • Contract
  • NotBilled
  • ServiceFee
  • All
  • CostsAndFees
  • ApprovedEstimate
  • CustomerInvoiceImport

DocumentStorageType enum

Possible enum values

  • Local
  • URL
  • Cloud
  • WonDocument
  • WonNote
  • CloudShared

StreetAddrType enum

Possible enum values

  • Unknown
  • Alt
  • Primary
  • Home

WeekdayMask enum

Possible enum values

  • None
  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday

PrintoutStatus enum

Possible enum values

  • NotValidated
  • Valid
  • Invalid

WorkOrderStatus enum

Possible enum values

  • Unknown
  • Open
  • Paused
  • Cancelled
  • New
  • OnHold
  • InProgress
  • Completed

SettingType enum

Possible enum values

  • FreeText
  • Integer
  • Currency
  • Numeric
  • Boolean
  • Email
  • Url
  • Xml
  • Json

WoScheduleOptions enum

Possible enum values

  • None
  • SkipWarranty
  • SkipScheduling
  • SkipFinancial
  • SkipPTE
  • SkipDueDate
  • SkipOnSiteBy
  • SkipAcknowledgeBy

UIType enum

Possible enum values

  • Unknown
  • Corp
  • CallCenter
  • Wireless
  • Resident
  • Monitor
  • System
  • IVR
  • Offline
  • IntegrationWS
  • WON
  • WonRequestor
  • CustomerPortalApp
  • JetApp
  • ResponseByEmail
  • DigitalRoundsApp
  • CorrigoWebRestApi
  • OTHER

BillStatus enum

Possible enum values

  • NotBilled
  • ReadyToBeBilled
  • Billed
  • ReadyToBeBilled_Billed
  • BilledAndModified
  • ReadyToBeBilled_BilledAndModified
  • Billed_BilledAndModified
  • ReadyToBeBilled_Billed_BilledAndModified

EntityType enum

Possible enum values

  • TaxCode
  • InvoiceDictionaryItem
  • BillingAccount
  • WorkOrder
  • Location
  • Address
  • Customer
  • Invoice
  • InvoiceLine
  • CorporateEntity
  • GLAccount
  • Payment
  • PaymentItem
  • Employee
  • WorkZone
  • Space
  • Task
  • Disposition
  • WoItem
  • CustomFieldDescriptor
  • CustomField
  • Organization
  • Contact
  • TimePeriod
  • Specialty
  • WorkOrderType
  • CustomerNoteType
  • RepairCode
  • AttributeDescriptor
  • WoActionReasonLookup
  • WoPriority
  • WoLastAction
  • WoNote
  • Actor
  • ContactAddress
  • Address2
  • ContactInfo
  • CustomField2
  • Note
  • WorkOrderCost
  • WoAssignment
  • WoOnSite
  • WoActionLog
  • WoVerification
  • WoActionLogProp
  • FinancialItem
  • WoQuote
  • WoEquipment
  • Blob
  • DocumentType
  • Document
  • Product
  • LaborCode
  • WpTree
  • WoEstimate
  • ToDoItem
  • LinkCustomerAndGroup
  • LinkContactAndGroup
  • AssetInfo
  • PmSchedule
  • PmItem
  • Contract
  • TaxRegion
  • TaxRegionItem
  • PriceList
  • PriceListItem
  • ChargeCodeLookup
  • CustomFieldOption
  • Model
  • LinkUserAndSpecialty
  • LinkUserAndCustomerGroup
  • LinkUserAndWorkZone
  • LinkUserAndPortfolio
  • LinkUserAndTeam
  • UserPayRate
  • UserCertification
  • LinkUserAndStockLocation
  • LinkProviderPriceList
  • LinkProviderAndService
  • Role
  • AlertScope
  • AlertSubscription
  • AssetTree
  • AttributeOption
  • Team
  • LinkTeamAndWorkZone
  • LinkPortfolioAndWorkZone
  • BusinessHours
  • Holiday
  • SpecDispatchRule
  • EscalationRule
  • OnCallRule
  • Responsibility
  • Warranty
  • AssetAttribute
  • SpecialtyMoneyValues
  • ContactMoneyValues
  • TaskMoneyValues
  • UserPayRateMoneyValues
  • RoleMoneyValues
  • Portfolio
  • AssetTemplate
  • AssetSystem
  • ProductCategory
  • LinkProductAndSupplier
  • ProductMoneyValues
  • ApInvoiceStatus
  • TimeCardWeek
  • TimeCard
  • TimeCardItem
  • ProviderCoi
  • ResponsibilityType
  • ToDoType
  • ApprovalTemplateStep
  • ApprovalTemplate
  • ProcedureTemplateStep
  • ProcedureFlagReason
  • ProcedureTemplate
  • WoProcedureStep
  • WoProcedure
  • StockLocation
  • ReplenishmentOrder
  • ReplenishmentOrderItem
  • ApprovalScope
  • CustomFieldAutocompleteOption
  • TimeOff
  • SlaValuesOverride
  • Turn
  • LinkModelAndAttribute
  • BillToOption
  • PrintoutTemplate
  • InvoiceLog
  • QuoteOrEstimateItem
  • MaterialTransaction
  • MaterialTransactionItem
  • StockLocationInventoryDetails
  • InternalCostStatus
  • WoFlag
  • ProcedureCategory
  • LinkProcedureCategoryAndTemplate
  • LinkProductAndQtyAttribute
  • RequiredDocCategory
  • WorkTemplate
  • Proposal
  • WorkOrderCostCategory
  • WoSchedule
  • RcsCircuit
  • RcsAction
  • RcsCylinder
  • LinkCommunityAndRcsCylinder
  • LinkEmployeeAndRcsCylinder
  • RcsLeakRateLog
  • RcsCircuitMonitorMapping
  • BlackoutDay
  • ShiftHours
  • WoVisit
  • WoVisitCfg
  • WoVisitSvc
  • LirOutstandingInvoiceWorkOrder

Protocols enum

Possible enum values

  • HTTP
  • HTTPS

ApiTypes enum

Possible enum values

  • SOAP
  • REST

OrderType enum

Possible enum values

  • Ascending
  • Descending

JurisdictionType enum

Possible enum values

  • Country
  • State
  • County
  • City
  • Special

TaxValidationStatus enum

Possible enum values

  • Unknown
  • None
  • Success
  • Failure
  • Provider

ChangeAssignmentMode enum

Possible enum values

  • Primary
  • AddSecondary
  • RemoveSecondary
  • Snapshot

CompletionNoteOptions enum

Possible enum values

  • Ignore
  • Replace
  • FillEmpty
  • Append

DraftProcessStep enum

Possible enum values

  • NA
  • Pending
  • ReadyToPost
  • FailedTax
  • FailedPost
  • Disputed
  • Recalled

CiActionType enum

Possible enum values

  • Created
  • TaxComputed
  • Posted
  • Paid
  • PaymentSubmitted
  • Disputed
  • Approved
  • DocumentAttached
  • Recalled
  • ManuallySent
  • Exported
  • RollbackExported

CiInvoiceState enum

Possible enum values

  • Draft
  • Posted
  • Credit
  • CreditUsed
  • Paid
  • PaidInFull
  • Approved
  • Exported

CiItemType enum

Possible enum values

  • WorkOrder
  • GroupHeader
  • GroupChild
  • None

PaymentMethod enum

Possible enum values

  • Check
  • Cash
  • CreditCard
  • EFT
  • AccountCredit

PaymentState enum

Possible enum values

  • Draft
  • Credit
  • Posted

RateType enum

Possible enum values

  • Fixed
  • Amount
  • Percentage

VendorType enum

Possible enum values

  • Editable
  • NonEditable
  • Hidden
  • UseVendorPrLst

WoRating enum

Possible enum values

  • Unknown
  • NotVerified
  • Negative
  • Neutral
  • Positive
  • NotCompleted

OnSiteValidationResult enum

Possible enum values

  • Unknown
  • Invalid
  • Unverified
  • Valid

OnSiteValidationType enum

Possible enum values

  • Unknown
  • Barcode
  • Gps
  • Ivr
  • Api

WoEquipmentType enum

Possible enum values

  • Unknown
  • New
  • Known
  • NotRelated

Status enum

Possible enum values

  • Submitted
  • Queued
  • Running
  • Completed
  • Failed
  • Cancelled

WoCostPriceSource enum

Possible enum values

  • Unknown
  • Manual
  • Integration
​