Customer

Property NameProperty ValueProperty Description
DisplayAsStringGets a display as value. Max Length=64. Is required.
NameStringCustomer's name. Max Length=64. Is required.
WorkZoneWorkZone entity referenceCommunity, the Work Zone to which Customer belongs. Is required.
DbaStringGets a DBA (Doing business as) value. Max Length=64. Is required.
InstructionsStringService instructions to relay to team members who are visiting this customer, HTML content supported. Max Length=3072.
TenantCodeStringGets a tenant code - unique number, usually used to map customer to external system. Max Length=64. Is required.
TaxExemptBooleanGets 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.
SpacesSpace entity referenceSpaces. Space (sometimes called Location) is occupancy record connecting Customer and Unit. Space means that Customer occupies particular Unit Asset.
ContactsContact entity referenceContacts are persons who are working for Customer and who actively participate in Work Order lifecycle. Is required.
CustomFieldsCustomField2 entity referenceCustom Fields
NotesNote entity referenceNotes
AddressesAddress entity referenceZero or one Street Address. Is required.
ContractContract entity referenceDefault 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.
GroupsBridgeCustomerAndGroup entity referenceCustomer Groups. Is required.
ApprovalScopesApprovalScope entity reference
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WorkZone

DisplayAsString
AssetLocation entity reference
TimeZoneInteger
LanguageIdInteger
WoNumberPrefixString
EntityString
SchedulingWindowInteger
NoIncompleteProcedureBoolean
AccessOptionsMaskInteger
NumberString
AdvanceNoticeInteger
TaxRegionTaxRegion entity reference
WoNumberDigitsInteger
RoundApptTimeToInteger
WorkPlanAutoCancelBoolean
WorkPlanChildResolutionBoolean
WorkPlanAutoDependencyBoolean
CpThemeIdInteger
DefaultAccessPTEType enum
AutoAssignEnabledBoolean
BackupRoutingIdBackupRouting enum
BillingAccountBillingAccount enum
ContractContract entity reference
NoIncompleteItemBoolean
UiShowProvidersFirstBoolean
CurrencyTypeIdCurrencyType enum
IsOfflineBoolean
ContactAddressesContactInfo entity reference
CustomFieldsCustomField2 entity reference
PortfoliosLinkPortfolioAndWorkZone entity reference
SlaValuesSlaValuesOverride entity reference
TeamsLinkTeamAndWorkZone entity reference
BizHoursBusinessHours entity reference
EscalationRulesEscalationRule entity reference
SpecDispatchRulesSpecDispatchRule entity reference
OnCallRulesOnCallRules entity reference
ResponsibilitiesResponsibilitiy entity reference
UseBizHoursBoolean
UseHolidaysBoolean
UseOnCallBoolean
UseEscalationBoolean
DefaultBillToLogicInteger
TurnKickOffAutoBoolean
TurnKickOffLagDaysInteger
TurnKickOffOnDaysByte
EarliestSlotInteger
LatestSlotInteger
SlotsCountInteger
IsPrecalculatedScheduleBoolean
AllowTimePreferenceBoolean
TurnTemplateIdInteger
IsmSpecGroupIdInteger
IsmUrlString
ExcludeNonCompliantProvidersExcludeCoi enum
IsNteAutoBoolean or NULLIsNteAuto
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

TaxCode

Property NameProperty ValueProperty Description
DisplayAsStringDisplayable name.
ExtIdStringGets or sets a external ID (used to communicate with third-party tax service)
DescrStringGets or sets a description, this field is optional
CountryStringGets or sets a country, this field is optional
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WorkOrder

Property NameProperty ValueProperty Description
NumberStringGets a work order number. Automatically generated if not supplied automatically. Max Length=16
TypeCategoryWoType enumType: Unknown, Basic, PMRM(Preventive Maintenance/Routine Maintenance), Turn, Request. It determines behavior of the work order during its lifecycle. Is required.
WorkOrderCostWorkOrderCost entity referenceWO Invoice. Financial Record represents Work Order's data related to financial side of the workflow: costs tracking, vendor invoice, service fees etc.
PriorityWoPriority entity referenceIt indicates the urgency level of the work order.
StatusIdWorkOrderStatus enumStatus: Unknown, Open, Paused, Cancelled, Closed, Attention, New, OnHold, InProgress, Completed
RequestorContactContact entity referenceRequestor contact data
AccessPTEType enumAccess: Unknown, PTE, Appointment, CallFirst, NotApplicable
MainAssetLocation entity referenceAsset representing main WO location
ShortLocationStringShortened asset inventory location for display purposes. Max Length=128
TaskRefinementStringContains work description for the Work Order. This value is automatically generated or entered by user manually. Max Length=512
WorkZoneWorkZone entity referenceNonUpdatable. Specifies an area in which service is provided
EmployeeEmployee entity referenceNonUpdatable. Primary technician responsible for executing of the work order
DurationIntegerExpected duration for the work related to this work order in minutes.
VendorNteMoneyValue entity referenceNTE (Not to Exceed) for vendor invoice.
SpecialtySpecialty entity referenceSpecifies what type of work needs to be done for this work order
PoNumberStringPurchase Order Number. Max Length=50
SubTypeWorkOrderType entity referenceWork order custom type. Each custom type corresponds to one of the base work order type. References table [vlangWOTypeLookup]. Is required.
RepairCodeRepairCode entityRepair 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.
CustomerCustomer referenceCustomer. Is required.
ContactNameStringContact name. Max Length=256
ContactNameStringContact name. Max Length=256
WonIdIntegerWON (Work Order Network) Id.
IsWarrantyBoolean"True" means WO might be covered by provider’s warranty.
FlagWOActionReasonLookup referenceAction Reason. References table [WOActionReasonLookup]
FlagIdIntegerAction Reason ID.
TimeZoneIntegerTime Zone
CurrencyTypeIdCurrencyType enum
LastActionDateDateTimeLast Action Date
DtCreatedDateTimeDate the work order was created. If not specified will be Now().
DtScheduledStartDateTime or NULLWork Order scheduled start time
DtDueDateTime or NULLLocal 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
DtAcknowledgeByDateTime or NULLLocal time indicating moment by which WO needs to be “acknowledged”, i.e. picked up; NULL means value is undefined.
AcknowledgeByUtcDateTime or NULLUTC time indicating moment by which WO needs to be “acknowledged”, i.e. picked up; NULL means value is undefined.
LastActionDateUtcDateTimeLast Action Date Utc
CreatedDateUtcDateTimeDate Utc the work order was created. If not specified will be UtcNow().
ScheduledStartUtcDateTime or NULLWork Order scheduled Utc start time. If not specified will be UtcNow().
DueDateUtcDateTime or NULLUtc time indicating moment when WO becomes overdue
DtOnSiteByDateTime or NULLLocal 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.
DtUtcOnSiteByDateTime or NULLUtc time indicating moment by which WO needs to be "responded to", i.e. started
LastActionWoLastAction referenceLast Action. WO Shadow record.
AddressAddress2 referenceAddress
ItemsWoItem referenceWork order tasks.
EquipmentWorkedOnWoEquipment referenceEquipment
NotesWoNote referenceNotes
CompletionNoteWoNote referenceCompletion Note
ContactAddressContactInfo referenceContact Address. Is required.
AssignmentsWoAssignment referenceAssignments
ProceduresWoProcedure referencePunch List Items
DocumentsDocument referenceDocuments
CustomFieldsCustomField2 referenceCustom Fields
VerificationsWoVerification referenceVerifications. (WO Ratings)
QuoteWoQuote referenceQuote
CheckInOutsWoOnsite referenceCheck In/Outs Log
ActionLogRecordsWoActionLog referenceAction Logs
EstimateWoEstimate referenceCustomer Estimate
OwnerEmployee referenceWO Owner
InductionAndSafetyStatusIDIsmStatus enum
FlagsWoFlag reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

InvoiceDictionaryItem

Property NameProperty ValueProperty Description
DescrStringGets or sets a description, this field is optional
TaxCodeTaxCode referenceGets or sets a tax code object
CostCategoryCostCategory enumGest or sets a cost category
GlExpenseStringGets or sets GL expense code, this field is optional
GlIncomeStringGets or sets GL expense code, this field is optional
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
DisplayAsStringGets or sets the display as CorrigoNet entity value.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerInteger

BillingAccount

Property NameProperty ValueProperty Description
DisplayAsString
CpThemeIdInteger
IsBillAcctBoolean
NumberString
PaymentTermsString
PaymentNumberOfDaysInteger
PaymentInstrustionsString
IsCreditHoldBoolean
AccrualMarginInteger
SalesRepString
IsTaxExemptBoolean
CorpEntityCorporateEntity reference
BalanceDecimal
PayDayTypeByte
PayDayNumberByte
IsSelfSelectBoolean
CurrencyTypeIdCurrencyType enum
UsersLinkUserAndCustomerGroup reference
CustomersLinkCustomerAndGroup reference
ContactsLinkContactAndGroup reference
CustomFieldsCustomField2 reference
AddressAddress2 reference
NotesNote reference
SynchronizeNteBoolean
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Location

Property NameProperty ValueProperty Description
NameStringGets a location name. Max Length=64. Is required.
AddressAddress2 referenceGets a location address. Is required.
ModelIdIntegerModel Id. Is required.
OrphanBooleanTrue means Asset is orphaned. Is required.
TypeIdAssetType enumAsset Category: Unknown, Regular, Building, Unit, Community, RoomArea, Floor, Utility, Equipment. Is required.
ParentIdInteger“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.
RootIdInteger“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.
IsTemplateBoolean“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.
InfoAssetInfo referenceAsset additional info.
DocumentsDocument referenceAsset documents: links and/or files.
IsOfflineBoolean“True” when asset is offline.
IsLockedBoolean“True” when asset is locked.
AttributesAssetAttibute reference
IdIntegerGets or sets a Corrigo entity identifier.

Address

Property NameProperty ValueProperty Description
StreetStringGets a street
CityStringGets a city
StateStringGets a state
ZipStringGets a zip code
Street2StringGets a street2
ActorTypeIdIntegerGets a actor type id
TypeIdCharGets a address type id
ActorIdIntegerGets a actor id
LatitudeDoubleGets a latitude
LongitudeDoubleGets a longitude
CountryStringGets a country
IdIntegerGets or sets a Corrigo entity identifier.

Invoice

Property NameProperty ValueProperty Description
CurrencyTypeIdCurrencyType enum
TimeSetIdIntegerGets a time period ID
PeriodTimePeriod reference
GroupBillingAccount referenceGets a billing account object
StateCiInvoiceState enumGets a invoice state; supported values are draft, posted, paid, paid in full, credit, credit used.
PoNumberStringGets an optional field used for customer reference
DtDueDateTime or NULLGets an invoice due date computed when invoice is posted; initially empty
GlAccountStringGets a GL account number
CommentsStringGets a comments
AmtBaseMoneyValue entity referenceGets an invoice subtotal before tax
AmtTaxMoneyValue entity referenceGets an invoice total tax amount
AmtTotalMoneyValue entity referenceGets an invoice total amount (base + tax)
IsMultilineBooleanGets a value indicating whether this invoice consists of more than one line item
TaxTransactionIdStringGets a tax transaction ID (non-empty value means tax was computed)
IsTaxDirtyBooleanGets a value indicating whether invoice content was changed since tax was computed.
LineItemsInvoiceLine entity referenceGets a line items collection.
ExtNumberStringGets or sets an external number
DtPostedDateTime or NULLDate of "posted" action; a.k.a. Invoice Date
IsManuallySentBoolean
DraftProcessStepIdDraftProcessStep enumSub-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”).
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

InvoiceLine

Property NameProperty ValueProperty Description
CurrencyTypeIdCurrencyType enum
InvoiceItemInvoiceDictionaryItem entity referenceInvoice dictionary item object
WorkOrderWorkOrder entity referenceGets a work order object
LocationLocation entity referenceLocation object
CustomerCustomer entity referenceGets a customer object
TypeCiItemType enumGets a type of the relationship with WO; supported values are single WO, group header, group child, none
DtServiceDateTime or NULLDate of service; supported for items associated with WOs
DescrStringDescription
QtyDecimalQuantity, precision is up to 5 digits
RateMoneyValue entity referenceRate
TaxRateDecimalGets a tax rate, precision is up to 5 digits
AmtTaxMoneyValue entity referenceGets a tax amount (computed by tax software)
AmtTotalMoneyValue entity referenceGets a total amount
TaxCodeStringGet or set tax code.
TaxCodeReferenceTaxCode entity referenceGet or set tax code reference.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

CorporateEntity

Property NameProperty ValueProperty Description
DisplayAsStringGets or sets a display as value
NumberStringGets or sets a number
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

GLAccount

Property NameProperty ValueProperty Description
DisplayAsStringGets or sets a display as value.
DescrStringGets or sets a description, this field is optional.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Payment

Property NameProperty ValueProperty Description
CurrencyTypeIdCurrencyType enum
GroupBillingAccount referenceGets or sets a billing account object
NumberStringGets a payment number; initially empty, generated by Post action.
StatePaymentState enumGets a payment state; Supported values are draft, posted, posted-credit.
CommentsStringGets or sets comments, optional.
MethodPaymentMethod enumGets or sets a payment method; Supported values are check (default), cash, credit card, EFT, account credit.
ReferenceStringGets o sets reference or check number, optional.
DtStampDateTimeGets or sets a payment date (set by user explicitly), required.
AmtPaymentMoneyValue entity referenceGets or sets amount that came from customer (credits not included), cannot be negative.
AmtBalanceMoneyValue entity reference
DtPostedDateTime or NULLGets a remaining balance, cannot be negative. Calculated automatically as payment amount plus used credits minus amounts applied to invoices.
TimeSetIdIntegerGets or sets a time period ID
ItemsPaymentItem entity referenceGets or sets an items collection.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

PaymentItem

Property NameProperty ValueProperty Description
CurrencyTypeIdCurrencyType enum
ObjectTypeIdActorType enumGets 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).
ObjectIdIntegerGets or sets reference to object which record is based upon, either invoice/credit memo or payment. Required.
IsCreditBooleanGets or sets a value indicating whether this record stores credit used (true - credit otherwise debit).
AmtBalanceMoneyValue entity referenceGets an object's (credit memo/invoice or payment) remaining balance BEFORE payment was posted. Optional. Zero for draft payments.
AmtUsedMoneyValue entity referenceGets 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.
RefInvoiceInvoice entity referenceGets an invoice on which payment is based. Based on and
RefPaymentPayment entity referenceGets a payment on which payment is based. Based on and
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Employee

Property NameProperty ValueProperty Description
FirstNameStringFirst name. Max Length=80. Is required.
LastNameStringLast name. Max Length=176. Is required.
DisplayAsStringDisplayable name. Max Length=256. Is required.
RoleRole entity referenceRole. Is required.
AccessToAllWorkZonesBooleanTrue 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.
LanguageIdIntegerPreferred language
ActorTypeIdActorType enumShould be ActorType.Employee. Is required.
UsernameStringUser ID. Max Length=256. Is required.
DtPwdChangeDateTimeDate (no time part) when password was set/changed last time; based on server time. This value is used by code enforcing password policies.
ProviderInvitedOnDateTime or NULLDate (no time part) when Provider was invited to WON (Work Order Network) last time. This field is not used by Technicians.
InstructionsStringSpecial instructions. Max Length=3072.
WonMemberIdIntegerWON (Work Order Network) member ID; non-zero indicates connected Providers. This field is not used by Technicians.
WonLocationIdIntegerWON (Work Order Network) location ID;
WonServiceRadiusIntegerService radius in miles or kilometers, depending on WonRadiusType value. Is required.
IsElectronicPaymentBooleanTrue means Provider prefers electronic payments. This field is not used by Technicians.
ProviderStatusIdEmployeeWonStatus enumWON (Work Order Network) status. This field is computed automatically in response to modifications for certain fields.
LabelIdIntegerUser-defined Provider label. This field is not used by Technicians.
FreeTextAllowedBooleanTrue 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.
RadiusUnitDistanceUnit enumStores units for service radius. Supported values are kilometers and miles.
PasswordStringUser’s password for login. Max Length=64. Is required.
NumberStringNumber (often used as integration key). Max Length=64.
JobTitleStringJob Title. Max Length=256.
FederalIdStringFederal ID#. Used for tax purposes. Max Length=64.
ExternalIdStringUsed by Providers. Max Length=64.
ForcePasswordResetBooleanTrue means Technician must reset his password upon login. This field is not used by Providers.
TaxWarnOnlyBooleanTax Warn Only
DefaultPriceListPriceList entity referenceDefault Price List
PriceListsLinkProviderPriceList entity referencePrice Lists
CustomFieldsCustomField2 referenceCustom Fields
OrganizationOrganization referenceOrganization Bridge
BillAtZeroBooleanBill At Zero
IsSupplierBooleanIs Supplier [Obsolete("Disabled for writing since 9.6su1")]
ProviderTypeIdProviderType enumProviderTypeId (tied with Is Supplier for backward compatibility)
ContactAddressesContactInfo reference](#contactinfo)Contact Addresses
AddressAddress2 referenceAddress
TeamsLinkUserAndTeam referenceTeams
WorkZonesLinkUserAndWorkZone referenceWork Zones
PortfoliosLinkUserAndPortfolio referencePortfolios
CustomerGroupsLinkUserAndCustomerGroup referenceCustomer Groups
SpecialtiesLinkUserAndSpecialty referenceSpecialties
PayRatesUserPayRate referencePay Rates
StockLocationsLinkUserAndStocklocation referenceStock Locations
ServicesLinkProviderAndService referenceServices
AlertSubscriptionsAlertSubscription referenceAlert Subscriptions
TaxExemptBooleanTaxExempt
LimitAssignmentByPortfolioIdInteger
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Space

Property NameProperty ValueProperty Description
CustomerIdIntegerCustomer Id. Is required.
AssetLocation referenceUnit Asset occupied by Customer. Is required.
StartDateDateTime or NULLStart date of lease. Is required.
EndDateDateTime or NULLEnd date of lease. Is required.
MoveOutDateDateTime or NULLDate of expected or actual Move Out date. Is required.
WorkZoneWorkZone referenceSpace work zone - taken from customer. Is required.
StatusIdLeasingSpaceStatus enumUnknown, Historical, Current, OnNotice, Pending. Is required.
AddressesAddress2 referenceOne address from unit asset(Asset). Is required.
InstructionsStringSpace instructions. Max Length=256.
MoveInDateDateTime or NULLMove in date.
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Task

Property NameProperty ValueProperty Description
ModelIdIntegerAsset model which supports this task. Is required.
DisplayAsStringTask name for UI. Max Length=400. Is required.
PreventiveBoolean"True" for preventative task. Is required.
CorrectiveBoolean"True" for corrective task. Is required.
DefaultBoolean"True" if this is default Asset’s(its Model’s) task in work order. Is required.
SymptomBoolean"True" for symptom task. Is required.
RoutineBoolean"True" for routine task. Is required.
CompletionTimeIntegerTime to complete task in minutes, supported values 0-599999. Is required.
SpecialtySpecialty referenceSpecialty that is needed to resolve that task - used for work order employee assignment.
ProcedureTemplateProcedureTemplate reference
PriorityWoPriority referencePriority associated with Task - set to work order priority when created. Is required.
SelfHelpTypeTaskSelfHelpType or NULLInstructions format: Html, Hyperlink, YouTube
InstructionsStringSet of instructions for a task. Max Length=Nvarchar(max)
SelfHelpContentStringLinks to auxilary information in different format. Max Length=2048
PeopleRequiredIntegerNumber of employees required.
SkillLevelIntegerNecessary skill level.
GlAccountStringGL Account number. Max Length=32
NumberStringExternal number. Might be provided by integration; also used by WON (Work Order Network). Max Length=64
CurrenciesTaskMoneyValues referenceMoney values
ChargeCodeChargeCodeLookUp referenceChargeCode
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Disposition

Property NameProperty ValueProperty Description
DisplayAsString
IsCompletedBoolean
IsCancelledBoolean
OnCreateBoolean
OnCompleteBoolean
OnCancelBoolean
IsRemovedBoolean
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WoItem

Property NameProperty ValueProperty Description
WorkOrderIdIntegerParent Work Order Id. Is required.
SortOrderIdxIntegerOrder 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.
DispositionDisposition referenceAllows to define a point of WorkOrder workflow at which the item is to be processed (e.g. on WorkOrder status changed to Completed).
AssetLocationStringFree-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.
AssetLocation referenceAsset to work with. Is required.
TaskTask referenceThe task to be done in frame of the item. Is required.
CommentStringPlain text to clarify the items purpose. Max Length=3096.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

CustomFieldDescriptor

Property NameProperty ValueProperty Description
ActorTypeIdActorType referenceCustom field object type and field type. Is required.
LengthIntegerField length. Max value string length (if string type)
TypeCfType enumField type : Unknown, String, Integer, Decimal, Money, Phone, Date, Time, Boolean, Url. Is required.
SharedWithProviderCfSharingMode enumShared mode with provider Exposed as scalar CfSharingMode enumeration value.
SharedByRequestorCfSharingMode enumShared mode by requestor Exposed as scalar CfSharingMode enumeration value. Read-only
CpnRequestorIdIntegerCPN Requestor ID Read-only
NameStringCustom field name. Max Length=64. Is required.
OptionsCustomFieldOption referenceA list of values that can be set in custom field - null for strings
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

CustomField

Property NameProperty ValueProperty Description
DescriptorCustomFieldDiscriptor referenceGets custom field metadata
ObjectIdIntegerObject ID
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Organization

Property NameProperty ValueProperty Description
DisplayAsString
NumberString
CustomFieldsCustomField2 reference
NotesNote reference
ContactAddressesContactInfo reference
AddressAddress2 reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Contact

Property NameProperty ValueProperty Description
DisplayAsStringGets or sets a display as value. Max Length=256. Is required.
FirstNameStringFirst Name. Max Length=50
LastNameStringLast Name. Max Length=50. Is required.
TypeIdLeaseContactType enumType: Unknown, Alternate, Emergency, Primary
CustomerIdIntegerCustomer Id.
CanViewAnyRequestBooleanFlag to determine level of access. “True” allows authorization for other’s expense. No is only for contact’s own expenses. Default is “False”.
CanCreateRequestBooleanAllow Request Creation. Default is "True".
PriorityThresholdIntegerPriority threshold.
CustomFieldsCustomField2 referenceCustom Fields.
ContactAddressesContactInfo referencePhone, Email, other can be defined here.
GroupsBridgeLinkContactAndGroup referenceContact/Customer Group Bridge records.
UsernameStringIf 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.
NumberStringNumber which can be used as a unique identifier for integration purposes. Max Length=64. Is required.
MustResetPasswordBooleanTrue in case user has to change password.
NoAlertEmailsBooleanDisable alert emails.
CommentStringComments. Max Length=256. Is required.
UnlimitedRequestBooleanTrue means Contact has unlimited request authority.
UnlimitedAuthorizationBooleanTrue means Contact has unlimited authorization authority.
SupervisorIdInteger
LanguageIdInteger
CustomerNoteAccessIdLsNoteAccess enumContact’s access level to Customer Notes.
NoPwdExpirationAlertBoolean
CurrenciesContactMoneyValues referenceMoney values
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

TimePeriod

Property NameProperty ValueProperty Description
DisplayAsString
StartDateDateTime
EndDateDateTime
dtStartDateTime or NULL
dtEndDateTime or NULL
IsFinancialBoolean
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
IsTimeBoolean
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Specialty

Property NameProperty ValueProperty Description
DisplayAsStringThe name of the Specialty. Max Length=40. Is required.
WONServiceIdIntegerRelated to WON (Work Order Network) Service
InstructionsStringService instructions to relay to team members; HTML content supported. Max Length=3072.
TaxCodeTaxCode referenceLabor Tax Code.
CurrenciesSpecialtyMoneyValues referenceMoney values
IsNteAutoBoolean or NULLIsNteAuto
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WorkOrderType

Property NameProperty ValueProperty Description
DisplayAsString
TypeIdWoType enum
AbbrString
IsDefSRBoolean
IsDefBasicBoolean
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

CustomerNoteType

Property NameProperty ValueProperty Description
DisplayAsString
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

RepairCode

Property NameProperty ValueProperty Description
DisplayAsStringName of the object. Is shown on UI. Max Length=64. Is required.
ParentIdIntegerReferences parent Category; null indicates Category records. Is required.
CodesRepairCode referenceChild Repair Codes. Always empty for Repair Code with ParentID equals to NULL.
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

AttributeDescriptor

Property NameProperty ValueProperty Description
TypeCfType enum
NameString
IsHistoryBoolean
DisplayInWorkOrderBoolean
OptionsAttibuteOption reference
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WoActionReasonLookup

Property NameProperty ValueProperty Description
DisplayAsStringHow the reason is represented in UI. Max Length=128
ActionIdWoActionType enumEnumeration which describes an action had been taken over the WorkOrder.
ReasonIdByteLink to reason object, unique within WO Action.
HideBooleanFlag to decide whether the object is shown on UI.
DescrStringComment for the action reason. Max Length=256
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WoPriority

Property NameProperty ValueProperty Description
DisplayAsStringLabel, unique value. Max Length=40. Is required.
IsEmergencyBooleanEscalate. Is required.
AcknowledgeInMinutesInteger"Acknowledge In" SLA value. Required.
RespondInMinutesIntegerResponse hrs. Is required.
DueInMinutesIntegerComplete hrs. Is required.
IdIntegerGets or sets a Corrigo entity identifier.

WoLastAction

Property NameProperty ValueProperty Description
IdIntegerInternal Id
WorkOrderIdIntegerNOTE: It's used as ID
LastActionWoActionLog referenceReference to last status-changing action for WO, WOActionLog2Object.ID.
EmergencyReasonWoActionReasonLookUp referenceReason for escalating WO to Emergency when creating new WO from Customer Portal. References WOActionReasonLookup.(ActionID = WOActionType.PriorityChanged, ReasonID).
ReasonWoActionReasonLookUp reference](#woactionreasonlookup)Reason matching current WO status. Only On Hold and Cancelled statuses support and require reasons; for other statuses this field is null/empty.
BillStatusBillStatus enumWO 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.
InvoiceInvoice reference](#invoice)Customer Invoice associated with WO; references ciInvoiceObject.ID.
BilledTotalMoneyValue reference](#moneyvalue)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).
XNumberString“External” WO number provided by third-party application. Used by integration. Max Length=256

WoNote

Property NameProperty ValueProperty Description
CreatedDateDateTimeNote creation date and time in work zone time. Is required.
BodyStringNote text. Max Length=6144. Is required.
WorkOrderIdIntegerWork Order Id. Is required.
NoteTypeIdWONoteType enumType: Unknown, Completion, Public, Private. Is required.
CreatedByActor reference](#actor)Represents the user, provider or other part that created that note.
IdIntegerGets or sets a Corrigo entity identifier.

Actor

Property NameProperty ValueProperty Description
IdIntegerGets or sets a Corrigo entity identifier.
TypeIdActorType enumEnumeration which defines type of object the Actor is (e.g. Employee)
DisplayAsStringHow an object is represented on UI. Max Length=256

ContactAddress

Property NameProperty ValueProperty Description
TypeIdContactAddrType enum
AddressString
IsDefaultBoolean
IsAlertBoolean
IsLockedBoolean
IsReportBoolean
IdIntegerGets or sets a Corrigo entity identifier.

Address2

Property NameProperty ValueProperty Description
ActorTypeIdActorType enumActor Type of the parent object. Is required.
ActorIdIntegerID of the parent object. Is required.
TypeIdStreeAddrType enumType of the address (CLookup records of type 'SADT'). Unknown, Primary or Home. Is required.
StreetStringStreet name. Max Length=128. Is required.
Street2StringStreet name (extension). Max Length=128
CityStringCity name. Max Length=40
StateStringState abbreviation. Max Length=2
ZipStringZIP code. Max Length=10
CountryStringCountry abbreviation. Max Length=2
GeoStatusIdGeoStatus enumGeocoding status matching enumeration GeoStatus.
LatitudeDoubleLocation’s latitude
LongitudeDoubleLocation’s longitude
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ContactInfo

Property NameProperty ValueProperty Description
ActorTypeIdActorType enumActor Type of the parent object : Customer, Employee, etc. Is required.
AddrTypeIdContactAddrType enumContact Address Type Id. Is required.
AddressStringContact address value. Max Length=512 Is required.
IsAlertBooleanTrue means this contact address is suitable for sending alerts.
IsReportBooleanTrue means this contact address is suitable for sending report subscriptions.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.
ActorIdIntegerID of the parent object. Is required.

CustomField2

Property NameProperty ValueProperty Description
DescriptorCustomFieldDescriptor referenceGets custom field metadata. Is required.
ObjectIdIntegerParent Object ID. Is required.
ObjectTypeIdActorType enumParent Object Type ID. Is required.
ValueStringGets Custom Field value. Max Length=1024. Is required.
CurrencyTypeIdCurrencyType enumRequired for Custom Fields where data type is Currency (DataType.Money); otherwise ignored. Modifications for existing records are not allowed.
IdIntegerGets or sets a Corrigo entity identifier.

Note

Property NameProperty ValueProperty Description
ActorIdIntegerParent Object ID
ActorTypeIdActorType enumParent Object Type ID
NoteTypeLookupCustomerNoteType referenceNote type
IsResolvedBooleanTrue means Note was “resolved”
CreatedAtDateTimeLocal date/time when Note was created
CreatedByActor referenceActor who created the Note
UpdatedAtDateTime or NULLLocal date/time when Note was created
UpdatedByActor referenceActor who last modified the Note
NoteTextStringCustomer note text
IdIntegerGets or sets a Corrigo entity identifier.

WorkOrderCost

Property NameProperty ValueProperty Description
IdIntegerInternal Id
CurrencyTypeIdCurrencyType enumCurrency type inherited from WO
BillToTypeBillToType enumEnumeration 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.
BillToOptionBillToOption referenceThis field defines type of entity which will be billed for this WO, or lack thereof.
CostsTotalMoneyValue referenceTotal amount of Costs associated with WO. Zero value is allowed.
ApStateIdApState enumAP State matching current Vendor Invoice status.
ApStatusIdIntegerVendor Invoice status
JobCodeStringJob Code; this field has no associated business logic and set manually by user. Max Length=32
ContractContract referenceContract associated with WO; references WOCostDefaultObject.ID.
AuthorizationCodeStringAuthorization code for Vendor Invoice; set by user when Vendor Invoice status is set to predefined status “Authorized”. Max Length=32
CheckNumberStringCheck number; set by user when Vendor Invoice status is set to predefined status “Paid”. Max Length=64
PaymentAmountMoneyValue referenceAmount paid to vendor; set by user when Vendor Invoice status is set to predefined status “Paid”.
PaymentNotesStringPayment Notes. Max Length=3072
CheckCutDateDateTime or NULLPayment date; set by user when Vendor Invoice status is set to predefined status “Paid”. Value is date only, no time part.
CheckClearDateDateTime or NULLDate when check to vendor was cleared. There is no business logic for this field. Value is date only, no time part.
GlAccountStringGL Account number matching GLAccountObject.DisplayAs. Max Length=32
NumberStringVendor Invoice Number. This value is set either manually or by WON provider when invoice is submitted. Max Length=32
VendorInvoiceDateDateTime or NULLVendor invoice submission date provided received from 6.x. Value is date only, no time part.
VendorInvoiceReceivedDateDateTime or NULLActual vendor invoice submission date (automatically set when invoice is received from 6.x). Value is date only, no time part.
VendorInvoiceTotalMoneyValue referenceVendor Invoice total amount. Zero value is allowed.
IsPreBilledBooleanTrue 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.
ExpensesTotalMoneyValue referenceTotal amount of costs plus Vendor Invoice total. This represents total amount of expenses associated with WO. Zero value is allowed.
BillingRuleBillingRule enumEnumeration of values: Unknown, VendorAndServiceFee, Contract, NotBilled, ServiceFee, All, CostsAndFees.
TaxStatusTaxValidationStatus enumEnumeration of values: Unknown, None, Success, Failure, Provider
CustomerNteMoneyValue referenceCustomer NTE (not to exceed).
ItemsFinancialItem referenceFinancial Items
TaxValidationNoteBlob referenceTax Validation Note
TaxDetailsTaxDetail referenceTax Details based on Tax Validation Note
ServiceFeesTotalMoneyValue referenceTotal amount of service fees. Precision 2 digits; negative and zero values are allowed. This value is computed by BO.
CostStatusIdIntegerCost status; references vlangARBillStatusLookup.ID.
CostStateCostState enumEnumeration of values: Pending, Submitted, Approved, Exported Cost State matching current Cost status; references vlangCostState.ID and matches enumeration CostState. Is required.
ChargeCodeChargeCodeLookUp referenceCustom 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.
BillingAccountBillingAccount referenceBilling Account associated with WO; references lsGroupObject.ID and must match record with IsBillAcct == True.
ExternalIdStringExternal ID; used by integration clients. Max Length=64
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.

WoAssignment

Property NameProperty ValueProperty Description
WorkOrderIdIntegerAssignment work order id. Is required.
IsPrimaryBooleanTrue means primary assignment; in this case Actor_ID value matches WorkOrder2Object.Owner_EmployeeID.
EmployeeIdIntegerId of an Employee the WorkOrder assigned to. Is required.
IdIntegerGets or sets a Corrigo entity identifier.

WoOnSite

Property NameProperty ValueProperty Description
WorkOrderIdInteger
EmployeeIdInteger
TimeZoneInteger
DtCheckInDateTime
InCheckTypeIdOnSiteValidationType enum
InValidationValueString
InLatitudeDecimal
InLongitudeDecimal
InInvItemIdInteger
InDistanceDecimal
InStatusIdOnSiteValidationResult enum
DtCheckOutDateTime or NULL
OutCheckTypeIdOnSiteValidationType enum
OutValidationValueString
OutLatitudeDecimal
OutLongitudeDecimal
OutInvItemIdInteger
OutDistanceDecimal
OutStatusIdOnSiteValidationResult enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WoActionLog

Property NameProperty ValueProperty Description
WorkOrderIdIntegerWork Order Id
TypeIdWOActionType enumType of the action.
ActorActor referenceLink to actor who performed this action.
ActionDateDateTimeLocal timestamp of the action
CommentStringComment. Max Length=3072
ActionReasonIdIntegerLink to Action Reason
IsBackDateBooleanTrue 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.
UiTypeIdUiType enumChange was made from: Unknown, Corp, CallCenter, Wireless, Resident, Monitor, System, IVR, Offline, IntegrationWS, WON, OTHER. Indicates CorrigoNet interface/application where action was recorded;
TimeZoneIntegerTime zone ID inherited from Work Order.
SystemDateUtcDateTimeUTC timestamp of the action. This value is computed by application rather than provided by user.
ObjectIdIntegerAction-specific value referencing object (typically, WO child) linked to this action record. Supported only for some action types.
PropertiesWoActionLogProp referenceAdditional action information records.
IdIntegerGets or sets a Corrigo entity identifier.

WoVerification

Property NameProperty ValueProperty Description
IdxInteger
WorkOrderIdIntegerWorkOrder ID
WoRatingIdWoRating enum
CommentString
EditedDateDateTime
ActorActor reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WoActionLogProp

Property NameProperty ValueProperty Description
WoActionLogIdIntegerReference to parent Action Log record, WOActionLog2Object.ID.
ValueIntInteger or NULLField 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.
ValueStrStringField 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.
TypeIdWOActionProperty enumProperty type (enumeration member); references WOALPropertyLookup.ID.
IdIntegerGets or sets a Corrigo entity identifier.

FinancialItem

Property NameProperty ValueProperty Description
WoIdInteger
CurrencyTypeIdCurrencyType enumCurrency type inherited from WO
CommentString
AmountMoneyValue entity reference
CostCategoryIdCostCategory enum
RateMoneyValue entity reference
StartDateDateTime or NULL
DurationInteger
InvoiceItemInvoiceDictionaryItem entity reference
ExcludeBooleanThis property is not mapped. It’s supported for backward compatibility.
RuleModificationWoCostExclusion enum
ProductProduct entity reference
EmployeeEmployee entity reference
QuantityDecimal
LaborCodeLaborCode entity reference
TypeIdWoCostLineType enum
TaxAmountMoneyValue entity reference
WithholdingTaxRateDecimal
WithholdingTaxRateUndefinedBoolean
StockLocationStockLocation entity reference
TaxCodeReferenceTaxCode entity reference
NonBillableBoolean or NULL
MerchantNameString
CheckForNonBillableBooleanThis is a not-mapped property. It is required to indicate that NonBillable property should be calculated
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WoQuote

Property NameProperty ValueProperty Description
WoIdInteger
CurrencyTypeIdCurrencyType enumCurrency type inherited from WO
AmountMoneyValue entity reference
DescriptionString
ReasonString
StatusIdQuoteStatus enum
IsMultilineBoolean
ItemsQuoteEstimateItem entity reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WoEquipment

Property NameProperty ValueProperty Description
WoIdIntegerWork Order Id. Is required.
AssetLocation entity referenceAsset of type equipment. This asset must reside under some of spaces used in work order.
CommentStringComments provided from user; zero-length value is accepted. Max Length=1024
RefrigerantUsedBooleanA three-state Boolean flag (NULL means “no value”) indicating refrigerant was used when work for particular equipment was done.
TypeWoEquipmentType enumType: Unknown, New, Known, NotRelated. Is required.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Blob

Property NameProperty ValueProperty Description
IdIntegerInternal Id
ActorIdIntegerEntity that owns this blob - work order id or other. Is required.
ActorTypeIdActorType enumeration memberWork Order or other. Is required.
BodyByteFile content. Is required.
FileNameStringFile name
TypeIdCharFile type identifier

DocumentType

Property NameProperty ValueProperty Description
DescriptionString
DisplayAsString
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Document

Property NameProperty ValueProperty Description
ActorIdIntegerId of document owner. Is required.
ActorTypeIdActorType enumActor Type of the parent object. Work Order, Inventory Asset. Is required.
DescriptionStringDescription. Max Length=512. Is required.
TitleStringTitle. Max Length=80. Is required.
DocTypeDocumentType entity referenceDocument Type. Is required.
EndDateDateTime or NULLDefines end of document's lifetime.
StartDateDateTimeDefines start of document's lifetime.
UpdatedDateDateTimeUpdated Date.
ExtensionIdIntegerExtension Id
IsSharedBooleanTrue when is shared.
IsPublicBooleanTrue when is public.
StorageTypeIdDocumentStorageType enumStorage Type Id. Cannot be updated for existing document.
DocUrlStringUrl
MimeTypeStringMime Type. Is required.
UpdatedByActor entity referenceUpdated By
WonIdIntegerWON (Work Order Network) Id
WonMemberIdIntegerWON (Work Order Network) member ID
BlobBlob entity referenceFile object is a content of the file stored in BLOB
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Product

Property NameProperty ValueProperty Description
InvoiceItemInvoiceDictionaryItem entity referenceCiDict
DisplayAsStringDisplayAs
PartNameStringDisplayAs
DescriptionStringDescr
DiscontinuedBooleanDiscontinued
UnitOfMeasureIdMhUnit enumUnitId
CommentsStringComments
ManufacturerStringManufacturer
PartNumberStringPartNumber
ScanCodeStringScanCode
CategoryProductCategory entity referenceType
SuppliersLinkProductAndSupplier entity referenceSuppliersBridge
CustomFieldsCustomField2 entity referenceCustomFields
CurrenciesProductMoneyValues entity referenceMoney values
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

LaborCode

Property NameProperty ValueProperty Description
InvoiceItemInvoiceDictionaryItem entity reference
DescriptionString
DisplayAsString
IsDefaultBoolean
ShowForWoBoolean
IsTimeCardBoolean
IsProductiveBoolean
IsPaidBoolean
IsShortcutBoolean
IsDefTimeCardBoolean
ExternalCodeString
TypeIdLaborCodeType enum
RateDecimal
CurrencyTypeIdCurrencyType enum
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WpTree

Property NameProperty ValueProperty Description
ChildWoIdInteger
DependOnWorkOrderWorkOrder entity reference
LevelInteger
NumberInteger
ParentWorkOrderWorkOrder entity reference
RootWorkOrderWorkOrder entity reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WoEstimate

Property NameProperty ValueProperty Description
WorkOrderIdIntegerEstimate work order id. Is required.
CurrencyTypeIdCurrencyType enumCurrency type inherited from WO
AmountMoneyValue entity referenceRequested NTE (Not to Exceed) amount. Negative values are not allowed; zero value might be blocked by pre-commit check.
CommentStringWhen new NTE (Not to Exceed) is requested - contains request comment. After request was approved it contains response from customer. Max Length=2048
StatusIdQuoteStatus enumUnknown, NotSubmitted (obsolete state), Requested, WaitingForApproval, Approved,Rejected, InProposal (reserved). Is required.
ReasonStringContains response from customer after reject. Max Length=256
ContactIdIntegerId of the contact that approves or rejects estimate. Required for approved and rejected state when ContactName is not defined.
ContactNameStringContact that approved or rejected comment. Required for approved and rejected state when ContactId is not defined. Max Length=256
IsMultilineBoolean
ItemsQuoteOrEstimateItem entity reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ToDoItem

Property NameProperty ValueProperty Description
ActorIdIntegerStandard link to parent object along with ActorTypeID
ActorTypeIdActorType enumStandard link to parent object along with ActorId
DtUtcDueDateTime or NULLDue date
DoneBooleanTrue means item is done/completed
DescriptionStringDescription, required.
CommentsString
EmployeeIdIntegerAssigned Employee; references EmployeeObject.ID, optional.
CreatedEmployeeIdIntegerEmployee who created item, references EmployeeObject.ID. This field equals to NULL if item was created as part of WO creation or escalation workflow.
CompletedEmployeeIdIntegerWhen item is done, this field may contain ID of the Employee who completed item. References EmployeeObject.ID.
DtUtcCompletedDateTime or NULLWhen item is done, this field contains UTC timestamp of the completion event.
TypeToDoType entity reference
IdIntegerGets or sets a Corrigo entity identifier.

LinkCustomerAndGroup

Property NameProperty ValueProperty Description
CustomerIdInteger
CustomerGroupIdInteger
IsBillingAccountBoolean
IsParentRemovedBoolean
IdIntegerGets or sets a Corrigo entity identifier.

LinkContactAndGroup

Property NameProperty ValueProperty Description
ContactIdInteger
CustomerGroupIdInteger
IsBillingContactBoolean
IdIntegerGets or sets a Corrigo entity identifier.

AssetInfo

Property NameProperty ValueProperty Description
IdIntegerInternal Asset Info Id.
AssetIdIntegerAsset id. Is required.
CommunityIdIntegerWork zone id. Is required.
SerialNumberStringAsset serial number. Max Length=50.
TagIdStringAsset serial number. Max Length=892.
CheckPhoneStringPhone. Max Length=256.
AssetSystemAssetSystem entity referenceReference to AssetSystem

Contract

Property NameProperty ValueProperty Description
DisplayAsString
IdIntegerGets or sets a Corrigo entity identifier.

TaxRegion

Property NameProperty ValueProperty Description
ItemsTaxRegionItem entity reference
DisplayAsString
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

TaxRegionItem

Property NameProperty ValueProperty Description
TaxRegionIdInteger
TaxCodeTaxCode entity reference
TaxRateDecimal
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

PriceList

Property NameProperty ValueProperty Description
CurrencyTypeIdCurrencyType enumCurrency type (independent context).
DisplayAsString
TypeIdPriceListType enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

PriceListItem

Property NameProperty ValueProperty Description
CurrencyTypeIdCurrencyType enumCurrency type inherited from parent price list.
VendorRateMoneyValue entity reference
DescriptionString
RateTypeRateType enum
VendorTypeVendorType enum
PriceListIdInteger
RateMoneyValue entity reference
InvoiceItemInvoiceDictionaryItem entity reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ChargeCodeLookup

Property NameProperty ValueProperty Description
CodeString
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
DisplayAsStringGets or sets the display as CorrigoNet entity value.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

CustomFieldOption

Property NameProperty ValueProperty Description
ParentIdInteger
IdxInteger
ValueString
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Model

Property NameProperty ValueProperty Description
DisplayAsString
DescriptionString
AssetCategoryIdAssetType enum
PublicBoolean
SubComponentIdxChar
GlAccountString
InstructionsString
TasksTask entity reference
AttributeDescriptorsLinkModelAndAttribute entity reference
NumberString
AllowAnonymousRequestsBoolean
ChargeCodeChargeCodeLookUp entity referenceChargeCode
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

LinkUserAndSpecialty

Property NameProperty ValueProperty Description
UserIdInteger
SpecialtyIdInteger
IdIntegerGets or sets a Corrigo entity identifier.

LinkUserAndCustomerGroup

Property NameProperty ValueProperty Description
UserIdInteger
CustomerGroupIdInteger
IdIntegerGets or sets a Corrigo entity identifier.

LinkUserAndWorkZone

Property NameProperty ValueProperty Description
UserIdInteger
WorkZoneIdInteger
IdIntegerGets or sets a Corrigo entity identifier.

LinkUserAndPortfolio

Property NameProperty ValueProperty Description
UserIdInteger
PortfolioIdInteger
IdIntegerGets or sets a Corrigo entity identifier.

LinkUserAndTeam

Property NameProperty ValueProperty Description
UserIdInteger
TeamIdInteger
IdIntegerGets or sets a Corrigo entity identifier.

UserPayRate

Property NameProperty ValueProperty Description
LaborCodeIdInteger
UserIdInteger
IsDefaultBoolean
CurrenciesUserPayRateMoneyValues entity reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

LinkUserAndStockLocation

Property NameProperty ValueProperty Description
UserIdInteger
StockLocationIdInteger
FullAccessInteger
IdIntegerGets or sets a Corrigo entity identifier.

LinkProviderPriceList

Property NameProperty ValueProperty Description
ProviderIdInteger
PortfolioIdInteger
PriceListIdInteger
IdxInteger
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

LinkProviderAndService

Property NameProperty ValueProperty Description
ProviderIdInteger
ServiceIdInteger
IdIntegerGets or sets a Corrigo entity identifier.

Role

Property NameProperty ValueProperty Description
DisplayAsString
RankInteger
UnlimitedNteBoolean
SsoLoginOnlyBoolean
CurrenciesRoleMoneyValues entity reference
IsIsmRequiredBoolean
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

AlertScope

Property NameProperty ValueProperty Description
UserIdInteger
AlertTypeIdAlertType enum
ScopeIdInteger
ScopeTypeIdActorType enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

AlertSubscription

Property NameProperty ValueProperty Description
IdInteger
UserIdInteger
AlertTypeIdAlertType enum
FullScopeSubscriptionBoolean
SubscriptionScopeAlertScope entity reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.

AssetTree

Property NameProperty ValueProperty Description
IdIntegerInternal Id
ParentIdIntegerParent Id of (Asset)
ChildIdIntegerChild Id of (Asset)
ChildLocation entity referenceChild (Asset)
DistanceByteTells how deep Child asset is situated relative to Parent(ParentId)

AttributeOption

Property NameProperty ValueProperty Description
ParentIdInteger
IdxInteger
ValueString
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Team

Property NameProperty ValueProperty Description
DisplayAsString
WorkZonesLinkTeamAndWorkZone entity reference
EmployeesLinkUserAndTeam entity reference
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

LinkTeamAndWorkZone

Property NameProperty ValueProperty Description
TeamIdInteger
WorkZoneIdInteger
IsDefaultBoolean
IdIntegerGets or sets a Corrigo entity identifier.

LinkPortfolioAndWorkZone

Property NameProperty ValueProperty Description
WorkZoneIdInteger
PortfolioIdInteger
IsPrimaryBoolean
IdIntegerGets or sets a Corrigo entity identifier.

BusinessHours

Property NameProperty ValueProperty Description
DayIdxDayOfWeekInteger
FinishTimeDateTime or NULL
StartTimeDateTime or NULL
ActorIdInteger
ActorTypeIdActorType enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Holiday

Property NameProperty ValueProperty Description
DisplayAsString
DtHolidayDateTime
ActorIdInteger
ActorTypeIdActorType enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

SpecDispatchRule

Property NameProperty ValueProperty Description
SpecialtyIdInteger
IndexInteger
UserIdInteger
ActorIdInteger
ActorTypeIdActorType enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

EscalationRule

Property NameProperty ValueProperty Description
UserIdInteger
NotifyAfterInteger
ActorIdInteger
ActorTypeIdActorType enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

OnCallRule

Property NameProperty ValueProperty Description
DayOfWeekInteger
BizHoursUserIdInteger
AfterHoursUserIdInteger
ActorIdInteger
ActoryTypeIdActorType enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Responsibility

Property NameProperty ValueProperty Description
UserIdInteger
AssigneeIdInteger
AssigneeTypeIdActorType enum
ResponsibilityTypeResponsibilityType entity reference
ActorIdInteger
ActorTypeIdActorType enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Warranty

Property NameProperty ValueProperty Description
DisplayAsString
AdditionalInfoString
IsTemplateBoolean
OrganizationOrganization entity reference
StatusIdWarrantyStatus enum
PrimaryContactString
TemplateIdInteger
WorkOrderWorkOrder entity reference
StartDateDateTime or NULL
EndDateDateTime or NULL
AutoCoverageInteger
LaborCoverageTypeIdSchedInterval enum
LaborCoverageLengthInteger
PartsCoverageTypeIdSchedInterval enum
PartsCoverageLengthInteger
OtherCoverageTypeIdSchedInterval enum
OtherCoveragerLengthInteger
WarrantorTypeIdActorType enum
WarrantorIdInteger
CommentString
AssetLocation entity reference
TimeZoneInteger
WorkZoneWorkZone entity reference
ContactAddressesContactInfo entity reference
IsManufacturerBoolean
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

AssetAttribute

Property NameProperty ValueProperty Description
DescriptorAttributeDescriptor entity reference
AssetIdInteger
TopAssetIdIntegerThis field is auto-computed by application.
CurrencyTypeIdCurrencyType enumRequired for Asset Attributes where data type is Currency (DataType.Money); otherwise ignored.
ValueString
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

SpecialtyMoneyValues

Property NameProperty ValueProperty Description
NteDecimal or NULLNot to Exceed : approval must not be higher than this value.
AvgCostVendorDecimal or NULLVendor Average Cost.
AvgCostTechDecimal or NULLTechnician Average Cost.
AvgCostAllDecimal or NULLTotal Average Cost.
CurrencyTypeIdCurrencyType enumCurrency type
ParentIdIntegerParent Id
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ContactMoneyValues

Property NameProperty ValueProperty Description
AuthorizationLimitDecimal or NULLAuthorization Limit
RequestLimitDecimal or NULLRequest Limit.
NotificationThresholdDecimal or NULLNotification threshold. Money.
CurrencyTypeIdCurrencyType enumCurrency type
ParentIdIntegerParent Id
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

TaskMoneyValues

Property NameProperty ValueProperty Description
NteDecimal or NULLTask max price limit - Not to exceed amount.
CurrencyTypeIdCurrencyType enumCurrency type
ParentIdIntegerParent Id
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

UserPayRateMoneyValues

Property NameProperty ValueProperty Description
RateDecimal or NULL
CurrencyTypeIdCurrencyType enumCurrency type
ParentIdIntegerParent Id
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

RoleMoneyValues

Property NameProperty ValueProperty Description
NteLimitDecimal or NULL
CurrencyTypeIdCurrencyType enumCurrency type
ParentIdIntegerParent Id
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Portfolio

Property NameProperty ValueProperty Description
DisplayAsString
TypeIdPortfolioType enum
ParentPortfolioIdInteger
UseBizHoursBoolean
UseHolidaysBoolean
UseOnCallBoolean
UseEscalationBoolean
TurnTemplateIdInteger
SlaValuesSlaValuesOverride entity reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

AssetTemplate

Property NameProperty ValueProperty Description
DisplayAsString
RootAssetIdInteger
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

AssetSystem

Property NameProperty ValueProperty Description
DescriptionString
DisplayAsString
IdIntegerGets or sets a Corrigo entity identifier.

ProductCategory

Property NameProperty ValueProperty Description
DisplayAsStringDisplayAs
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdInteger
IdIntegerGets or sets a Corrigo entity identifier.

LinkProductAndSupplier

Property NameProperty ValueProperty Description
ProductIdIntegerProductId
SupplierIdIntegerSupplierId
PartNumberStringPartNumber
IsDefaultBooleanIsDefault
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ProductMoneyValues

Property NameProperty ValueProperty Description
UnitPriceDecimal or NULL
LastPriceDecimal or NULL
CurrencyTypeIdCurrenctyType entity referenceCurrency type
ParentIdIntegerParent Id
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ApInvoiceStatus

Property NameProperty ValueProperty Description
DisplayAsString
DescriptionString
ForecastGroupIdForecastGroup enum
ApStateIdApState enum
ReadyForExportBoolean
SetOnExportBoolean
ChildWoDefaultBoolean
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

TimeCardWeek

Property NameProperty ValueProperty Description
StartDateDateTimeFirst day of week (no time). Acts like unique ID of the week.
EndDateDateTimeLast day of week (no time).
IdIntegerGets or sets a Corrigo entity identifier.

TimeCard

Property NameProperty ValueProperty Description
WeekStartDateDateTime
EmployeeEmployee entity referenceTechnician ID
FlaggedIntegerFlagged != 0 means Time Card is flagged
StatusIdTimeCardStatus enum
WeekTimeCardWeek entity referenceGlobal Week identified by its start.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

TimeCardItem

Property NameProperty ValueProperty Description
CommentStringOptional comment provided by Technician.
WorkZoneWorkZone entity referenceWork Zone ID
EndDateDateTime or NULLDate/time when labor ended; local time of the user
SystemEndDateDateTime or NULLDate/time when labor ended (local time of the user) as recorded automatically by application
StartDateDateTimeDate/time when labor started; local time of the user
SystemStartDateDateTime or NULLDate/time when labor started (local time of the user) as recorded automatically by application
WeekStartDateDateTime
DurationIntegerTCI duration in minutes auto-computed as (dtEnd - dtStart). Only zero and positive values are allowed.
EmployeeEmployee entity referenceTechnician ID
LaborCodeLaborCode entity referenceLabor Code ID
LatitudeStartDecimalRepresent geolocation result for “time card start” action
LatitudeStopDecimalRepresent geolocation result for “time card stop” action
LongitudeStartDecimalRepresent geolocation result for “time card start” action
LongitudeStopDecimalRepresent geolocation result for “time card stop” action
TimeCardTimeCard entity referenceParent Time Card
TypeIdTimeCardType enum
InternalCostItemFinancialItem entity referenceWO cost labor record
WorkOrderWorkOrder entity referenceInherited from WO labor cost record
QtyInteger
RateDecimal
MoneyIdCurrencyType enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ProviderCoi

Property NameProperty ValueProperty Description
DisplayAsString
EmployeeIdInteger
AmtCoverageMoneyValue entity reference
StatusIdInsuranceStatus enum
StartDateDateTime
EndDateDateTime
CommentString
CurrencyTypeIdCurrencyType enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ResponsibilityType

Property NameProperty ValueProperty Description
DisplayAsString
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ToDoType

Property NameProperty ValueProperty Description
DisplayAsString
DescriptionString
IsDefaultBoolean
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ApprovalTemplateStep

Property NameProperty ValueProperty Description
ApprovalTemplateIdInteger
StepNumberInteger
ActorTypeIdActorType enum
ActorIdInteger
RuleIdApprovalRule enum
AutoSkipHoursInteger
IsParallelBoolean
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ApprovalTemplate

Property NameProperty ValueProperty Description
DisplayAsString
StepsApprovalTemplateStep entity reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ProcedureTemplateStep

Property NameProperty ValueProperty Description
ProcedureTemplateIdInteger
IndexInteger
DescriptionString
TypeIdProcedureStepType enum
IsRequiredBoolean
FieldDescriptorCustomFieldDescriptor entity reference
AttrDescriptorAttributeDescriptor entity reference
InstructionsString
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ProcedureFlagReason

Property NameProperty ValueProperty Description
DisplayAsString
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ProcedureTemplate

Property NameProperty ValueProperty Description
DisplayAsString
AllowMarkAllBoolean
AllowNotApplicableBoolean
StepsProcedureTemplateStep entity reference
ProcedureCategoriesLinkProcedureCategoryAndTemplate entity reference
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WoProcedureStep

Property NameProperty ValueProperty Description
WorkOrderIdInteger
IndexInteger
CommentString
DescriptionString
StatusIdProcedureStatus enum
WoProcedureIdInteger
ProcedureTemplateStepProcedureTemplateStep entity reference
TypeIdProcedureStepType enum
IsWonBoolean
IsRequiredBoolean
FieldDescriptorCustomFieldDescriptor entity reference
AttrDescriptorAttributeDescriptor entity reference
DataTypeIdCfType enum
DataValueString
DataLabelString
FlagProcedureFlagReason entity reference
IsNotApplicableBoolean
MoneyIdCurrencyType enum
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

WoProcedure

Property NameProperty ValueProperty Description
WorkOrderIdInteger
ProcedureTemplateProcedureTemplate entity reference
AssetLocation entity reference
DisplayAsString
TypeIdProcedureType enum
AllowMarkAllBoolean
AllowNotApplicableBoolean
IsNotApplicableBoolean
FlagProcedureFlagReason entity reference
StatusIdProcedureStatus enum
IndexInteger
StepsWoProcedureStep entity reference
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

StockLocation

Property NameProperty ValueProperty Description
DisplayAsString
NumberString
TypeIdMhLocationType enum
ShipToNameString
BillToNameString
DeliveryInstructionsString
CommentsString
AllowNegativeQtyBoolean
MoneyIdCurrencyType enum
TimeZoneIdInteger
StreetAddressesAddress2 entity referenceStreet address with TypeId == StreetAddrType.Primary is shipping address; the one with TypeId == StreetAddrType.Alt is billing address.
ContactAddressesContactInfo entity referenceContact address with AddrTypeId == ContactAddrType.PrimPhone is shipping phone number; the one with AddrTypeId == ContactAddrType.AltPhone is billing phone number.
CustomFieldsCustomField2 entity reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ReplenishmentOrder

Property NameProperty ValueProperty Description
StatusIdMhOrderStatus enum
DescriptionString
PoNumberString
DEstimatedtDeliveryDateTime or NULL
SupplierEmployee entity reference
StockLocationStockLocation entity reference
SupplierInstructionsString
SupplierOrderNumberString
IsExportedBoolean
NumberString
TimeZoneInteger
CurrencyTypeIdCurrencyType enum
ItemsReplenishmentOrderItem entity reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ReplenishmentOrderItem

Property NameProperty ValueProperty Description
ReplenishmentOrderIdInteger
ProductProduct entity reference
PriceMoneyValue entity reference
QtyOrderedDecimal
QtyReceivedDecimal
AmtTotalMoneyValue entity reference
CurrencyTypeIdCurrencyType enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ApprovalScope

Property NameProperty ValueProperty Description
ActorIdInteger
ActorTypeIdActorType enum
IsDefaultBoolean
ApprovalTemplateApprovalTemplate entity reference
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

CustomFieldAutocompleteOption

Property NameProperty ValueProperty Description
DescriptorIdInteger
ValueString
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

TimeOff

Property NameProperty ValueProperty Description
EmployeeIdInteger
StartDateDateTime
EndDateDateTime
ReplaceByIdInteger
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

SlaValuesOverride

Property NameProperty ValueProperty Description
ActorTypeIdActorType enum
ActorIdInteger
PriorityIdInteger
DueInMinutesInteger
RespondInMinutesInteger
AckInMinutesInteger
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

Turn

Property NameProperty ValueProperty Description
AssetIdInteger
WtTemplateIdInteger
DtReadyByDueDateTime or NULL
DtParentScheduledStartDateTime or NULL
StatusIdTurnStatus enum
ErrorDetailsString
WorkOrderIdInteger
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

LinkModelAndAttribute

Property NameProperty ValueProperty Description
ModelIdInteger
AttributeDescriptorIdInteger
IdIntegerGets or sets a Corrigo entity identifier.

BillToOption

Property NameProperty ValueProperty Description
DisplayAsString
CodeString
TypeIdBillTypeRule enum
IdIntegerGets or sets a Corrigo entity identifier.

PrintoutTemplate

Property NameProperty ValueProperty Description
DisplayAsString
IsDefaultBoolean
IsHiddenBoolean
StatusIdPrintoutStatus enum
ActorTypeIdActorType enum
IdIntegerGets or sets a Corrigo entity identifier.

InvoiceLog

Property NameProperty ValueProperty Description
InvoiceInvoice entity reference
ActorActor entity reference
IdxInteger
ActionTypeIdCiActionType enum
DtStampDateTime
DtActualDateTime
CommentsString
IdIntegerInternal Id

QuoteOrEstimateItem

Property NameProperty ValueProperty Description
WorkOrderIdInteger
ParentIdInteger
ParentTypeIdActorType enum
InvoiceItemInvoiceDictionaryItem entity reference
DescriptionString
QuantityDecimal
RateMoneyValue entity reference
AmountMoneyValue entity reference
IsFlaggedBoolean
TaxCodeTaxCode entity reference
CurrencyTypeIdCurrencyType enum
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

MaterialTransaction

Property NameProperty ValueProperty Description
TypeIdMhTransactionType enumExposed as MhTransactionType enumeration member.
WorkOrderIdIntegerFor retrieval only; ignored when material transaction is committed.
PoNumberString
SupplierIdInteger
SupplierOrderNumberString
TransactionDateDateTime
CommentsString
CreatorIdIntegerFor retrieval only; ignored when material transaction is committed.
CreatorTypeIdActorType enumFor retrieval only; ignored when material transaction is committed.
IsCommittedBooleanFor retrieval only; ignored when material transaction is committed.
StockLocationIdInteger
SourceStockLocationIdInteger
ReplenishmentOrderIdInteger
ItemsMaterialTransactionItem entity referenceExposed as list of MaterialTransactionItem entities.
IdIntegerGets or sets a Corrigo entity identifier.

MaterialTransactionItem

Property NameProperty ValueProperty Description
TransactionIdIntegerFor retrieval only; ignored when material transaction is committed.
ProductIdInteger
StockLocationIdIntegerFor retrieval only; ignored when material transaction is committed.
SourceStockLocationIdIntegerFor retrieval only; ignored when material transaction is committed.
TypeIdMhTransactionType enumExposed as MhTransactionType enumeration member. For retrieval only; ignored when material transaction is committed.
FinancialItemIdIntegerFor retrieval only; ignored when material transaction is committed.
QuantityDecimal
PriceDecimal or NULL
LineAmountDecimal or NULL
ReplenishmentOrderItemIdInteger
CurrencyTypeIdCurrencyType enum
IdIntegerGets or sets a Corrigo entity identifier.

StockLocationInventoryDetails

Property NameProperty ValueProperty Description
StockLocationIdInteger
ProductIdInteger
PriceDecimal or NULL
QuantityDecimal
CreatedOnDateTime
CurrencyTypeIdCurrencyType enum
IdIntegerGets or sets a Corrigo entity identifier.

InternalCostStatus

Property NameProperty ValueProperty Description
NameString
DescriptionString
ForecastGroupIdForecastGroup enum
InternalCostStateIdCostState enum
IdIntegerGets or sets a Corrigo entity identifier.

WoFlag

Property NameProperty ValueProperty Description
WoIdInteger
FlagIdInteger
UtcStampDateTime
CommentString
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

ProcedureCategory

Property NameProperty ValueProperty Description
DisplayAsStringDisplayAs
IsRemovedBooleanGets or sets the boolean flag indicating if an entity was deleted.
ConcurrencyIdIntegerGets or sets the concurrency identifier used for optimistic locks.
IdIntegerGets or sets a Corrigo entity identifier.

LinkProcedureCategoryAndTemplate

Property NameProperty ValueProperty Description
ProcedureCategoryIdInteger
ProcedureTemplateIdInteger
IdIntegerGets or sets a Corrigo entity identifier.

MoneyValue

Property NameProperty ValueProperty Description
CurrencyTypeIdCurrencyType enum
ValueDecimal

TaxDetail

Property NameProperty ValueProperty Description
JurisTypeJurisdictionType enum
JurisNameString
RateDecimal
TaxCalculatedDecimal
MoneyIdInteger
TaxDateDateTime or NULL