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 | Address 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 | CustomerAndGroup 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. |
WorkZone
DisplayAs | String | |
Asset | Location entity reference | |
TimeZone | Integer | |
LanguageId | Integer | |
WoNumberPrefix | String | |
Entity | String | |
SchedulingWindow | Integer | |
NoIncompleteProcedure | Boolean | |
AccessOptionsMask | Integer | |
Number | String | |
AdvanceNotice | Integer | |
TaxRegion | TaxRegion entity reference | |
WoNumberDigits | Integer | |
RoundApptTimeTo | Integer | |
WorkPlanAutoCancel | Boolean | |
WorkPlanChildResolution | Boolean | |
WorkPlanAutoDependency | Boolean | |
CpThemeId | Integer | |
DefaultAccess | PTEType enum | |
AutoAssignEnabled | Boolean | |
BackupRoutingId | BackupRouting enum | |
BillingAccount | BillingAccount enum | |
Contract | Contract entity reference | |
NoIncompleteItem | Boolean | |
UiShowProvidersFirst | Boolean | |
CurrencyTypeId | CurrencyType enum | |
IsOffline | Boolean | |
ContactAddresses | ContactInfo entity reference | |
CustomFields | CustomField2 entity reference | |
Portfolios | LinkPortfolioAndWorkZone entity reference | |
SlaValues | SlaValuesOverride entity reference | |
Teams | LinkTeamAndWorkZone entity reference | |
BizHours | BusinessHours entity reference | |
EscalationRules | EscalationRule entity reference | |
SpecDispatchRules | SpecDispatchRule entity reference | |
OnCallRules | OnCallRules entity reference | |
Responsibilities | Responsibilitiy entity reference | |
UseBizHours | Boolean | |
UseHolidays | Boolean | |
UseOnCall | Boolean | |
UseEscalation | Boolean | |
DefaultBillToLogic | Integer | |
TurnKickOffAuto | Boolean | |
TurnKickOffLagDays | Integer | |
TurnKickOffOnDays | Byte | |
EarliestSlot | Integer | |
LatestSlot | Integer | |
SlotsCount | Integer | |
IsPrecalculatedSchedule | Boolean | |
AllowTimePreference | Boolean | |
TurnTemplateId | Integer | |
IsmSpecGroupId | Integer | |
IsmUrl | String | |
ExcludeNonCompliantProviders | ExcludeCoi enum | |
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. |
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. |
WorkOrder
Property Name | Property Value | Property Description |
---|---|---|
Number | String | Gets a work order number. Automatically generated if not supplied automatically. Max Length=16 |
TypeCategory | WoType enum | 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 enum | Status: Unknown, Open, Paused, Cancelled, Closed, Attention, New, OnHold, InProgress, Completed |
RequestorContact | Contact entity reference | Requestor contact data |
Access | PTEType enum | 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 | 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 reference | Customer. Is required. |
ContactName | String | Contact name. Max Length=256 |
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 reference | Action Reason. References table [WOActionReasonLookup] |
FlagId | Integer | Action Reason ID. |
TimeZone | Integer | Time Zone |
CurrencyTypeId | CurrencyType enum | |
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 reference | Last Action. WO Shadow record. |
Address | Address2 reference | Address |
Items | WoItem reference | Work order tasks. |
EquipmentWorkedOn | WoEquipment reference | Equipment |
Notes | WoNote reference | Notes |
CompletionNote | WoNote reference | Completion Note |
ContactAddress | ContactInfo reference | Contact Address. Is required. |
Assignments | WoAssignment reference | Assignments |
Procedures | WoProcedure reference | Punch List Items |
Documents | Document reference | Documents |
CustomFields | CustomField2 reference | Custom Fields |
Verifications | WoVerification reference | Verifications. (WO Ratings) |
Quote | WoQuote reference | Quote |
CheckInOuts | WoOnsite reference | Check In/Outs Log |
ActionLogRecords | WoActionLog reference | Action Logs |
Estimate | WoEstimate reference | Customer Estimate |
Owner | Employee reference | WO Owner |
InductionAndSafetyStatusID | IsmStatus enum | |
Flags | WoFlag reference | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
InvoiceDictionaryItem
Property Name | Property Value | Property Description |
---|---|---|
Descr | String | Gets or sets a description, this field is optional |
TaxCode | TaxCode reference | Gets or sets a tax code object |
CostCategory | CostCategory enum | 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 | Integer |
BillingAccount
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
CpThemeId | Integer | |
IsBillAcct | Boolean | |
Number | String | |
PaymentTerms | String | |
PaymentNumberOfDays | Integer | |
PaymentInstrustions | String | |
IsCreditHold | Boolean | |
AccrualMargin | Integer | |
SalesRep | String | |
IsTaxExempt | Boolean | |
CorpEntity | CorporateEntity reference | |
Balance | Decimal | |
PayDayType | Byte | |
PayDayNumber | Byte | |
IsSelfSelect | Boolean | |
CurrencyTypeId | CurrencyType enum | |
Users | LinkUserAndCustomerGroup reference | |
Customers | LinkCustomerAndGroup reference | |
Contacts | LinkContactAndGroup reference | |
CustomFields | CustomField2 reference | |
Address | Address2 reference | |
Notes | Note reference | |
SynchronizeNte | Boolean | |
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. |
Location
Property Name | Property Value | Property Description |
---|---|---|
Name | String | Gets a location name. Max Length=64. Is required. |
Address | Address2 reference | Gets a location address. Is required. |
ModelId | Integer | Model Id. Is required. |
Orphan | Boolean | True means Asset is orphaned. Is required. |
TypeId | AssetType enum | 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 reference | Asset additional info. |
Documents | Document reference | Asset documents: links and/or files. |
IsOffline | Boolean | “True” when asset is offline. |
IsLocked | Boolean | “True” when asset is locked. |
Attributes | AssetAttibute reference | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
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. |
Invoice
Property Name | Property Value | Property Description |
---|---|---|
CurrencyTypeId | CurrencyType enum | |
TimeSetId | Integer | Gets a time period ID |
Period | TimePeriod reference | |
Group | BillingAccount reference | Gets a billing account object |
State | CiInvoiceState enum | 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 | |
DraftProcessStepId | DraftProcessStep enum | 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”). |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
InvoiceLine
Property Name | Property Value | Property Description |
---|---|---|
CurrencyTypeId | CurrencyType enum | |
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 enum | 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. |
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. |
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. |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
Payment
Property Name | Property Value | Property Description |
---|---|---|
CurrencyTypeId | CurrencyType enum | |
Group | BillingAccount reference | Gets or sets a billing account object |
Number | String | Gets a payment number; initially empty, generated by Post action. |
State | PaymentState enum | Gets a payment state; Supported values are draft, posted, posted-credit. |
Comments | String | Gets or sets comments, optional. |
Method | PaymentMethod enum | 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 | |
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. |
PaymentItem
Property Name | Property Value | Property Description |
---|---|---|
CurrencyTypeId | CurrencyType enum | |
ObjectTypeId | ActorType enum | 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. |
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 enum | 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 enum | 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 enum | 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 reference | Custom Fields |
Organization | Organization reference | Organization Bridge |
BillAtZero | Boolean | Bill At Zero |
IsSupplier | Boolean | Is Supplier [Obsolete("Disabled for writing since 9.6su1")] |
ProviderTypeId | ProviderType enum | ProviderTypeId (tied with Is Supplier for backward compatibility) |
ContactAddresses | ContactInfo reference](#contactinfo) | Contact Addresses |
Address | Address2 reference | Address |
Teams | LinkUserAndTeam reference | Teams |
WorkZones | LinkUserAndWorkZone reference | Work Zones |
Portfolios | LinkUserAndPortfolio reference | Portfolios |
CustomerGroups | LinkUserAndCustomerGroup reference | Customer Groups |
Specialties | LinkUserAndSpecialty reference | Specialties |
PayRates | UserPayRate reference | Pay Rates |
StockLocations | LinkUserAndStocklocation reference | Stock Locations |
Services | LinkProviderAndService reference | Services |
AlertSubscriptions | AlertSubscription reference | Alert Subscriptions |
TaxExempt | Boolean | TaxExempt |
LimitAssignmentByPortfolioId | Integer | |
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. |
Space
Property Name | Property Value | Property Description |
---|---|---|
CustomerId | Integer | Customer Id. Is required. |
Asset | Location 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 reference | Space work zone - taken from customer. Is required. |
StatusId | LeasingSpaceStatus enum | Unknown, Historical, Current, OnNotice, Pending. Is required. |
Addresses | Address2 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. |
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. |
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. |
Routine | Boolean | "True" for routine task. Is required. |
CompletionTime | Integer | Time to complete task in minutes, supported values 0-599999. Is required. |
Specialty | Specialty reference | Specialty that is needed to resolve that task - used for work order employee assignment. |
ProcedureTemplate | ProcedureTemplate reference | |
Priority | WoPriority 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 reference | Money values |
ChargeCode | ChargeCodeLookUp 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. |
Disposition
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
IsCompleted | Boolean | |
IsCancelled | Boolean | |
OnCreate | Boolean | |
OnComplete | Boolean | |
OnCancel | Boolean | |
IsRemoved | Boolean | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
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 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 reference | Asset to work with. Is required. |
Task | Task 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. |
CustomFieldDescriptor
Property Name | Property Value | Property Description |
---|---|---|
ActorTypeId | ActorType reference | Custom field object type and field type. Is required. |
Length | Integer | Field length. Max value string length (if string type) |
Type | CfType enum | Field type : Unknown, String, Integer, Decimal, Money, Phone, Date, Time, Boolean, Url. Is required. |
SharedWithProvider | CfSharingMode enum | Shared mode with provider Exposed as scalar CfSharingMode enumeration value. |
SharedByRequestor | CfSharingMode enum | 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 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. |
CustomField
Property Name | Property Value | Property Description |
---|---|---|
Descriptor | CustomFieldDiscriptor reference | Gets custom field metadata |
ObjectId | Integer | Object ID |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
Organization
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
Number | String | |
CustomFields | CustomField2 reference | |
Notes | Note reference | |
ContactAddresses | ContactInfo reference | |
Address | Address2 reference | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
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 enum | 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 reference | Custom Fields. |
ContactAddresses | ContactInfo reference | Phone, Email, other can be defined here. |
GroupsBridge | LinkContactAndGroup 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 | |
LanguageId | Integer | |
CustomerNoteAccessId | LsNoteAccess enum | Contact’s access level to Customer Notes. |
NoPwdExpirationAlert | Boolean | |
Currencies | ContactMoneyValues reference | Money values |
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. |
TimePeriod
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
StartDate | DateTime | |
EndDate | DateTime | |
dtStart | DateTime or NULL | |
dtEnd | DateTime or NULL | |
IsFinancial | Boolean | |
IsRemoved | Boolean | Gets or sets the boolean flag indicating if an entity was deleted. |
IsTime | Boolean | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
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 reference | Labor Tax Code. |
Currencies | SpecialtyMoneyValues 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. |
WorkOrderType
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
TypeId | WoType enum | |
Abbr | String | |
IsDefSR | Boolean | |
IsDefBasic | Boolean | |
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. |
CustomerNoteType
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
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. |
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 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. |
AttributeDescriptor
Property Name | Property Value | Property Description |
---|---|---|
Type | CfType enum | |
Name | String | |
IsHistory | Boolean | |
DisplayInWorkOrder | Boolean | |
Options | AttibuteOption 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. |
WoActionReasonLookup
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | How the reason is represented in UI. Max Length=128 |
ActionId | WoActionType enum | 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. |
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. |
WoLastAction
Property Name | Property Value | Property Description |
---|---|---|
Id | Integer | Internal Id |
WorkOrderId | Integer | NOTE: It's used as ID |
LastAction | WoActionLog reference | Reference to last status-changing action for WO, WOActionLog2Object.ID. |
EmergencyReason | WoActionReasonLookUp reference | Reason for escalating WO to Emergency when creating new WO from Customer Portal. References WOActionReasonLookup.(ActionID = WOActionType.PriorityChanged, ReasonID). |
Reason | WoActionReasonLookUp 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. |
BillStatus | BillStatus enum | 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 reference](#invoice) | Customer Invoice associated with WO; references ciInvoiceObject.ID. |
BilledTotal | MoneyValue 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). |
XNumber | String | “External” WO number provided by third-party application. Used by integration. Max Length=256 |
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 enum | Type: Unknown, Completion, Public, Private. Is required. |
CreatedBy | Actor reference](#actor) | Represents the user, provider or other part that created that note. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
Actor
Property Name | Property Value | Property Description |
---|---|---|
Id | Integer | Gets or sets a Corrigo entity identifier. |
TypeId | ActorType enum | Enumeration which defines type of object the Actor is (e.g. Employee) |
DisplayAs | String | How an object is represented on UI. Max Length=256 |
ContactAddress
Property Name | Property Value | Property Description |
---|---|---|
TypeId | ContactAddrType enum | |
Address | String | |
IsDefault | Boolean | |
IsAlert | Boolean | |
IsLocked | Boolean | |
IsReport | Boolean | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
Address2
Property Name | Property Value | Property Description |
---|---|---|
ActorTypeId | ActorType enum | Actor Type of the parent object. Is required. |
ActorId | Integer | ID of the parent object. Is required. |
TypeId | StreeAddrType enum | 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 enum | 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. |
ContactInfo
Property Name | Property Value | Property Description |
---|---|---|
ActorTypeId | ActorType enum | Actor Type of the parent object : Customer, Employee, etc. Is required. |
AddrTypeId | ContactAddrType enum | 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. |
ActorId | Integer | ID of the parent object. Is required. |
CustomField2
Property Name | Property Value | Property Description |
---|---|---|
Descriptor | CustomFieldDescriptor reference | Gets custom field metadata. Is required. |
ObjectId | Integer | Parent Object ID. Is required. |
ObjectTypeId | ActorType enum | Parent Object Type ID. Is required. |
Value | String | Gets Custom Field value. Max Length=1024. Is required. |
CurrencyTypeId | CurrencyType enum | 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. |
Note
Property Name | Property Value | Property Description |
---|---|---|
ActorId | Integer | Parent Object ID |
ActorTypeId | ActorType enum | Parent Object Type ID |
NoteTypeLookup | CustomerNoteType reference | Note type |
IsResolved | Boolean | True means Note was “resolved” |
CreatedAt | DateTime | Local date/time when Note was created |
CreatedBy | Actor reference | Actor who created the Note |
UpdatedAt | DateTime or NULL | Local date/time when Note was created |
UpdatedBy | Actor reference | Actor who last modified the Note |
NoteText | String | Customer note text |
Id | Integer | Gets or sets a Corrigo entity identifier. |
WorkOrderCost
Property Name | Property Value | Property Description |
---|---|---|
Id | Integer | Internal Id |
CurrencyTypeId | CurrencyType enum | Currency type inherited from WO |
BillToType | BillToType enum | 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. |
BillToOption | BillToOption reference | This field defines type of entity which will be billed for this WO, or lack thereof. |
CostsTotal | MoneyValue reference | Total amount of Costs associated with WO. Zero value is allowed. |
ApStateId | ApState enum | 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 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 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 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 reference | Total amount of costs plus Vendor Invoice total. This represents total amount of expenses associated with WO. Zero value is allowed. |
BillingRule | BillingRule enum | Enumeration of values: Unknown, VendorAndServiceFee, Contract, NotBilled, ServiceFee, All, CostsAndFees. |
TaxStatus | TaxValidationStatus enum | Enumeration of values: Unknown, None, Success, Failure, Provider |
CustomerNte | MoneyValue reference | Customer NTE (not to exceed). |
Items | FinancialItem reference | Financial Items |
TaxValidationNote | Blob reference | Tax Validation Note |
TaxDetails | TaxDetail reference | Tax Details based on Tax Validation Note |
ServiceFeesTotal | MoneyValue 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 enum | Enumeration of values: Pending, Submitted, Approved, Exported Cost State matching current Cost status; references vlangCostState.ID and matches enumeration CostState. Is required. |
ChargeCode | ChargeCodeLookUp 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 reference | Billing Account associated with WO; references lsGroupObject.ID and must match record with IsBillAcct == True. |
ExternalId | String | External ID; used by integration clients. Max Length=64 |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
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. |
WoOnSite
Property Name | Property Value | Property Description |
---|---|---|
WorkOrderId | Integer | |
EmployeeId | Integer | |
TimeZone | Integer | |
DtCheckIn | DateTime | |
InCheckTypeId | OnSiteValidationType enum | |
InValidationValue | String | |
InLatitude | Decimal | |
InLongitude | Decimal | |
InInvItemId | Integer | |
InDistance | Decimal | |
InStatusId | OnSiteValidationResult enum | |
DtCheckOut | DateTime or NULL | |
OutCheckTypeId | OnSiteValidationType enum | |
OutValidationValue | String | |
OutLatitude | Decimal | |
OutLongitude | Decimal | |
OutInvItemId | Integer | |
OutDistance | Decimal | |
OutStatusId | OnSiteValidationResult enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
WoActionLog
Property Name | Property Value | Property Description |
---|---|---|
WorkOrderId | Integer | Work Order Id |
TypeId | WOActionType enum | Type of the action. |
Actor | Actor 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 |
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 enum | 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 reference | Additional action information records. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
WoVerification
Property Name | Property Value | Property Description |
---|---|---|
Idx | Integer | |
WorkOrderId | Integer | WorkOrder ID |
WoRatingId | WoRating enum | |
Comment | String | |
EditedDate | DateTime | |
Actor | Actor reference | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
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 enum | Property type (enumeration member); references WOALPropertyLookup.ID. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
FinancialItem
Property Name | Property Value | Property Description |
---|---|---|
WoId | Integer | |
CurrencyTypeId | CurrencyType enum | Currency type inherited from WO |
Comment | String | |
Amount | MoneyValue entity reference | |
CostCategoryId | CostCategory enum | |
Rate | MoneyValue entity reference | |
StartDate | DateTime or NULL | |
Duration | Integer | |
InvoiceItem | InvoiceDictionaryItem entity reference | |
Exclude | Boolean | This property is not mapped. It’s supported for backward compatibility. |
RuleModification | WoCostExclusion enum | |
Product | Product entity reference | |
Employee | Employee entity reference | |
Quantity | Decimal | |
LaborCode | LaborCode entity reference | |
TypeId | WoCostLineType enum | |
TaxAmount | MoneyValue entity reference | |
WithholdingTaxRate | Decimal | |
WithholdingTaxRateUndefined | Boolean | |
StockLocation | StockLocation entity reference | |
TaxCodeReference | TaxCode entity reference | |
NonBillable | Boolean or NULL | |
MerchantName | String | |
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. |
WoQuote
Property Name | Property Value | Property Description |
---|---|---|
WoId | Integer | |
CurrencyTypeId | CurrencyType enum | Currency type inherited from WO |
Amount | MoneyValue entity reference | |
Description | String | |
Reason | String | |
StatusId | QuoteStatus enum | |
IsMultiline | Boolean | |
Items | QuoteEstimateItem entity reference | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
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 enum | 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. |
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 |
DocumentType
Property Name | Property Value | Property Description |
---|---|---|
Description | String | |
DisplayAs | String | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
Document
Property Name | Property Value | Property Description |
---|---|---|
ActorId | Integer | Id of document owner. Is required. |
ActorTypeId | ActorType enum | 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 enum | 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. |
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 enum | 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 |
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. |
LaborCode
Property Name | Property Value | Property Description |
---|---|---|
InvoiceItem | InvoiceDictionaryItem entity reference | |
Description | String | |
DisplayAs | String | |
IsDefault | Boolean | |
ShowForWo | Boolean | |
IsTimeCard | Boolean | |
IsProductive | Boolean | |
IsPaid | Boolean | |
IsShortcut | Boolean | |
IsDefTimeCard | Boolean | |
ExternalCode | String | |
TypeId | LaborCodeType enum | |
Rate | Decimal | |
CurrencyTypeId | CurrencyType enum | |
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. |
WpTree
Property Name | Property Value | Property Description |
---|---|---|
ChildWoId | Integer | |
DependOnWorkOrder | WorkOrder entity reference | |
Level | Integer | |
Number | Integer | |
ParentWorkOrder | WorkOrder entity reference | |
RootWorkOrder | WorkOrder entity reference | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
WoEstimate
Property Name | Property Value | Property Description |
---|---|---|
WorkOrderId | Integer | Estimate work order id. Is required. |
CurrencyTypeId | CurrencyType enum | 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 enum | 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. |
ToDoItem
Property Name | Property Value | Property Description |
---|---|---|
ActorId | Integer | Standard link to parent object along with ActorTypeID |
ActorTypeId | ActorType enum | 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 | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
LinkCustomerAndGroup
Property Name | Property Value | Property Description |
---|---|---|
CustomerId | Integer | |
CustomerGroupId | Integer | |
IsBillingAccount | Boolean | |
IsParentRemoved | Boolean | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
LinkContactAndGroup
Property Name | Property Value | Property Description |
---|---|---|
ContactId | Integer | |
CustomerGroupId | Integer | |
IsBillingContact | Boolean | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
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 |
Contract
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
TaxRegion
Property Name | Property Value | Property Description |
---|---|---|
Items | TaxRegionItem entity reference | |
DisplayAs | String | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
TaxRegionItem
Property Name | Property Value | Property Description |
---|---|---|
TaxRegionId | Integer | |
TaxCode | TaxCode entity reference | |
TaxRate | Decimal | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
PriceList
Property Name | Property Value | Property Description |
---|---|---|
CurrencyTypeId | CurrencyType enum | Currency type (independent context). |
DisplayAs | String | |
TypeId | PriceListType enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
PriceListItem
Property Name | Property Value | Property Description |
---|---|---|
CurrencyTypeId | CurrencyType enum | Currency type inherited from parent price list. |
VendorRate | MoneyValue entity reference | |
Description | String | |
RateType | RateType enum | |
VendorType | VendorType enum | |
PriceListId | Integer | |
Rate | MoneyValue entity reference | |
InvoiceItem | InvoiceDictionaryItem entity reference | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
ChargeCodeLookup
Property Name | Property Value | Property Description |
---|---|---|
Code | String | |
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. |
CustomFieldOption
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. |
Model
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
Description | String | |
AssetCategoryId | AssetType enum | |
Public | Boolean | |
SubComponentIdx | Char | |
GlAccount | String | |
Instructions | String | |
Tasks | Task entity reference | |
AttributeDescriptors | LinkModelAndAttribute entity reference | |
Number | String | |
AllowAnonymousRequests | Boolean | |
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. |
LinkUserAndSpecialty
Property Name | Property Value | Property Description |
---|---|---|
UserId | Integer | |
SpecialtyId | Integer | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
LinkUserAndCustomerGroup
Property Name | Property Value | Property Description |
---|---|---|
UserId | Integer | |
CustomerGroupId | Integer | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
LinkUserAndWorkZone
Property Name | Property Value | Property Description |
---|---|---|
UserId | Integer | |
WorkZoneId | Integer | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
LinkUserAndPortfolio
Property Name | Property Value | Property Description |
---|---|---|
UserId | Integer | |
PortfolioId | Integer | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
LinkUserAndTeam
Property Name | Property Value | Property Description |
---|---|---|
UserId | Integer | |
TeamId | Integer | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
UserPayRate
Property Name | Property Value | Property Description |
---|---|---|
LaborCodeId | Integer | |
UserId | Integer | |
IsDefault | Boolean | |
Currencies | UserPayRateMoneyValues entity reference | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
LinkUserAndStockLocation
Property Name | Property Value | Property Description |
---|---|---|
UserId | Integer | |
StockLocationId | Integer | |
FullAccess | Integer | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
LinkProviderPriceList
Property Name | Property Value | Property Description |
---|---|---|
ProviderId | Integer | |
PortfolioId | Integer | |
PriceListId | Integer | |
Idx | Integer | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
LinkProviderAndService
Property Name | Property Value | Property Description |
---|---|---|
ProviderId | Integer | |
ServiceId | Integer | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
Role
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
Rank | Integer | |
UnlimitedNte | Boolean | |
SsoLoginOnly | Boolean | |
Currencies | RoleMoneyValues entity reference | |
IsIsmRequired | Boolean | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
AlertScope
Property Name | Property Value | Property Description |
---|---|---|
UserId | Integer | |
AlertTypeId | AlertType enum | |
ScopeId | Integer | |
ScopeTypeId | ActorType enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
AlertSubscription
Property Name | Property Value | Property Description |
---|---|---|
Id | Integer | |
UserId | Integer | |
AlertTypeId | AlertType enum | |
FullScopeSubscription | Boolean | |
SubscriptionScope | AlertScope entity reference | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
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) |
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. |
Team
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
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. |
LinkTeamAndWorkZone
Property Name | Property Value | Property Description |
---|---|---|
TeamId | Integer | |
WorkZoneId | Integer | |
IsDefault | Boolean | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
LinkPortfolioAndWorkZone
Property Name | Property Value | Property Description |
---|---|---|
WorkZoneId | Integer | |
PortfolioId | Integer | |
IsPrimary | Boolean | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
BusinessHours
Property Name | Property Value | Property Description |
---|---|---|
DayIdxDayOfWeek | Integer | |
FinishTime | DateTime or NULL | |
StartTime | DateTime or NULL | |
ActorId | Integer | |
ActorTypeId | ActorType enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
Holiday
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
DtHoliday | DateTime | |
ActorId | Integer | |
ActorTypeId | ActorType enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
SpecDispatchRule
Property Name | Property Value | Property Description |
---|---|---|
SpecialtyId | Integer | |
Index | Integer | |
UserId | Integer | |
ActorId | Integer | |
ActorTypeId | ActorType enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
EscalationRule
Property Name | Property Value | Property Description |
---|---|---|
UserId | Integer | |
NotifyAfter | Integer | |
ActorId | Integer | |
ActorTypeId | ActorType enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
OnCallRule
Property Name | Property Value | Property Description |
---|---|---|
DayOfWeek | Integer | |
BizHoursUserId | Integer | |
AfterHoursUserId | Integer | |
ActorId | Integer | |
ActoryTypeId | ActorType enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
Responsibility
Property Name | Property Value | Property Description |
---|---|---|
UserId | Integer | |
AssigneeId | Integer | |
AssigneeTypeId | ActorType enum | |
ResponsibilityType | ResponsibilityType entity reference | |
ActorId | Integer | |
ActorTypeId | ActorType enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
Warranty
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
AdditionalInfo | String | |
IsTemplate | Boolean | |
Organization | Organization entity reference | |
StatusId | WarrantyStatus enum | |
PrimaryContact | String | |
TemplateId | Integer | |
WorkOrder | WorkOrder entity reference | |
StartDate | DateTime or NULL | |
EndDate | DateTime or NULL | |
AutoCoverage | Integer | |
LaborCoverageTypeId | SchedInterval enum | |
LaborCoverageLength | Integer | |
PartsCoverageTypeId | SchedInterval enum | |
PartsCoverageLength | Integer | |
OtherCoverageTypeId | SchedInterval enum | |
OtherCoveragerLength | Integer | |
WarrantorTypeId | ActorType enum | |
WarrantorId | Integer | |
Comment | String | |
Asset | Location entity reference | |
TimeZone | Integer | |
WorkZone | WorkZone entity reference | |
ContactAddresses | ContactInfo entity reference | |
IsManufacturer | Boolean | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
AssetAttribute
Property Name | Property Value | Property Description |
---|---|---|
Descriptor | AttributeDescriptor entity reference | |
AssetId | Integer | |
TopAssetId | Integer | This field is auto-computed by application. |
CurrencyTypeId | CurrencyType enum | 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. |
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 enum | 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. |
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 enum | 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. |
TaskMoneyValues
Property Name | Property Value | Property Description |
---|---|---|
Nte | Decimal or NULL | Task max price limit - Not to exceed amount. |
CurrencyTypeId | CurrencyType enum | 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. |
UserPayRateMoneyValues
Property Name | Property Value | Property Description |
---|---|---|
Rate | Decimal or NULL | |
CurrencyTypeId | CurrencyType enum | 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. |
RoleMoneyValues
Property Name | Property Value | Property Description |
---|---|---|
NteLimit | Decimal or NULL | |
CurrencyTypeId | CurrencyType enum | 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. |
Portfolio
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
TypeId | PortfolioType enum | |
ParentPortfolioId | Integer | |
UseBizHours | Boolean | |
UseHolidays | Boolean | |
UseOnCall | Boolean | |
UseEscalation | Boolean | |
TurnTemplateId | Integer | |
SlaValues | SlaValuesOverride entity reference | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
AssetTemplate
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
RootAssetId | Integer | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
AssetSystem
Property Name | Property Value | Property Description |
---|---|---|
Description | String | |
DisplayAs | String | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
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 | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
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. |
ProductMoneyValues
Property Name | Property Value | Property Description |
---|---|---|
UnitPrice | Decimal or NULL | |
LastPrice | Decimal or NULL | |
CurrencyTypeId | CurrenctyType entity reference | 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. |
ApInvoiceStatus
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
Description | String | |
ForecastGroupId | ForecastGroup enum | |
ApStateId | ApState enum | |
ReadyForExport | Boolean | |
SetOnExport | Boolean | |
ChildWoDefault | Boolean | |
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. |
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. |
TimeCard
Property Name | Property Value | Property Description |
---|---|---|
WeekStartDate | DateTime | |
Employee | Employee entity reference | Technician ID |
Flagged | Integer | Flagged != 0 means Time Card is flagged |
StatusId | TimeCardStatus enum | |
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. |
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 | |
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 enum | |
InternalCostItem | FinancialItem entity reference | WO cost labor record |
WorkOrder | WorkOrder entity reference | Inherited from WO labor cost record |
Qty | Integer | |
Rate | Decimal | |
MoneyId | CurrencyType enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
ProviderCoi
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
EmployeeId | Integer | |
AmtCoverage | MoneyValue entity reference | |
StatusId | InsuranceStatus enum | |
StartDate | DateTime | |
EndDate | DateTime | |
Comment | String | |
CurrencyTypeId | CurrencyType enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
ResponsibilityType
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
ToDoType
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
Description | String | |
IsDefault | Boolean | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
ApprovalTemplateStep
Property Name | Property Value | Property Description |
---|---|---|
ApprovalTemplateId | Integer | |
StepNumber | Integer | |
ActorTypeId | ActorType enum | |
ActorId | Integer | |
RuleId | ApprovalRule enum | |
AutoSkipHours | Integer | |
IsParallel | Boolean | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
ApprovalTemplate
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
Steps | ApprovalTemplateStep entity reference | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
ProcedureTemplateStep
Property Name | Property Value | Property Description |
---|---|---|
ProcedureTemplateId | Integer | |
Index | Integer | |
Description | String | |
TypeId | ProcedureStepType enum | |
IsRequired | Boolean | |
FieldDescriptor | CustomFieldDescriptor entity reference | |
AttrDescriptor | AttributeDescriptor entity reference | |
Instructions | String | |
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. |
ProcedureFlagReason
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
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. |
ProcedureTemplate
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
AllowMarkAll | Boolean | |
AllowNotApplicable | Boolean | |
Steps | ProcedureTemplateStep entity reference | |
ProcedureCategories | LinkProcedureCategoryAndTemplate 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. |
WoProcedureStep
Property Name | Property Value | Property Description |
---|---|---|
WorkOrderId | Integer | |
Index | Integer | |
Comment | String | |
Description | String | |
StatusId | ProcedureStatus enum | |
WoProcedureId | Integer | |
ProcedureTemplateStep | ProcedureTemplateStep entity reference | |
TypeId | ProcedureStepType enum | |
IsWon | Boolean | |
IsRequired | Boolean | |
FieldDescriptor | CustomFieldDescriptor entity reference | |
AttrDescriptor | AttributeDescriptor entity reference | |
DataTypeId | CfType enum | |
DataValue | String | |
DataLabel | String | |
Flag | ProcedureFlagReason entity reference | |
IsNotApplicable | Boolean | |
MoneyId | CurrencyType enum | |
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. |
WoProcedure
Property Name | Property Value | Property Description |
---|---|---|
WorkOrderId | Integer | |
ProcedureTemplate | ProcedureTemplate entity reference | |
Asset | Location entity reference | |
DisplayAs | String | |
TypeId | ProcedureType enum | |
AllowMarkAll | Boolean | |
AllowNotApplicable | Boolean | |
IsNotApplicable | Boolean | |
Flag | ProcedureFlagReason entity reference | |
StatusId | ProcedureStatus enum | |
Index | Integer | |
Steps | WoProcedureStep 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. |
StockLocation
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
Number | String | |
TypeId | MhLocationType enum | |
ShipToName | String | |
BillToName | String | |
DeliveryInstructions | String | |
Comments | String | |
AllowNegativeQty | Boolean | |
MoneyId | CurrencyType enum | |
TimeZoneId | Integer | |
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. |
ReplenishmentOrder
Property Name | Property Value | Property Description |
---|---|---|
StatusId | MhOrderStatus enum | |
Description | String | |
PoNumber | String | |
DEstimatedtDelivery | DateTime or NULL | |
Supplier | Employee entity reference | |
StockLocation | StockLocation entity reference | |
SupplierInstructions | String | |
SupplierOrderNumber | String | |
IsExported | Boolean | |
Number | String | |
TimeZone | Integer | |
CurrencyTypeId | CurrencyType enum | |
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. |
ReplenishmentOrderItem
Property Name | Property Value | Property Description |
---|---|---|
ReplenishmentOrderId | Integer | |
Product | Product entity reference | |
Price | MoneyValue entity reference | |
QtyOrdered | Decimal | |
QtyReceived | Decimal | |
AmtTotal | MoneyValue entity reference | |
CurrencyTypeId | CurrencyType enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
ApprovalScope
Property Name | Property Value | Property Description |
---|---|---|
ActorId | Integer | |
ActorTypeId | ActorType enum | |
IsDefault | Boolean | |
ApprovalTemplate | ApprovalTemplate entity reference | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
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. |
TimeOff
Property Name | Property Value | Property Description |
---|---|---|
EmployeeId | Integer | |
StartDate | DateTime | |
EndDate | DateTime | |
ReplaceById | Integer | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
SlaValuesOverride
Property Name | Property Value | Property Description |
---|---|---|
ActorTypeId | ActorType enum | |
ActorId | Integer | |
PriorityId | Integer | |
DueInMinutes | Integer | |
RespondInMinutes | Integer | |
AckInMinutes | Integer | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
Turn
Property Name | Property Value | Property Description |
---|---|---|
AssetId | Integer | |
WtTemplateId | Integer | |
DtReadyByDue | DateTime or NULL | |
DtParentScheduledStart | DateTime or NULL | |
StatusId | TurnStatus enum | |
ErrorDetails | String | |
WorkOrderId | Integer | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
LinkModelAndAttribute
Property Name | Property Value | Property Description |
---|---|---|
ModelId | Integer | |
AttributeDescriptorId | Integer | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
BillToOption
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
Code | String | |
TypeId | BillTypeRule enum | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
PrintoutTemplate
Property Name | Property Value | Property Description |
---|---|---|
DisplayAs | String | |
IsDefault | Boolean | |
IsHidden | Boolean | |
StatusId | PrintoutStatus enum | |
ActorTypeId | ActorType enum | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
InvoiceLog
Property Name | Property Value | Property Description |
---|---|---|
Invoice | Invoice entity reference | |
Actor | Actor entity reference | |
Idx | Integer | |
ActionTypeId | CiActionType enum | |
DtStamp | DateTime | |
DtActual | DateTime | |
Comments | String | |
Id | Integer | Internal Id |
QuoteOrEstimateItem
Property Name | Property Value | Property Description |
---|---|---|
WorkOrderId | Integer | |
ParentId | Integer | |
ParentTypeId | ActorType enum | |
InvoiceItem | InvoiceDictionaryItem entity reference | |
Description | String | |
Quantity | Decimal | |
Rate | MoneyValue entity reference | |
Amount | MoneyValue entity reference | |
IsFlagged | Boolean | |
TaxCode | TaxCode entity reference | |
CurrencyTypeId | CurrencyType enum | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
MaterialTransaction
Property Name | Property Value | Property Description |
---|---|---|
TypeId | MhTransactionType enum | Exposed as MhTransactionType enumeration member. |
WorkOrderId | Integer | For retrieval only; ignored when material transaction is committed. |
PoNumber | String | |
SupplierId | Integer | |
SupplierOrderNumber | String | |
TransactionDate | DateTime | |
Comments | String | |
CreatorId | Integer | For retrieval only; ignored when material transaction is committed. |
CreatorTypeId | ActorType enum | For retrieval only; ignored when material transaction is committed. |
IsCommitted | Boolean | For retrieval only; ignored when material transaction is committed. |
StockLocationId | Integer | |
SourceStockLocationId | Integer | |
ReplenishmentOrderId | Integer | |
Items | MaterialTransactionItem entity reference | Exposed as list of MaterialTransactionItem entities. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
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 enum | 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 | |
Price | Decimal or NULL | |
LineAmount | Decimal or NULL | |
ReplenishmentOrderItemId | Integer | |
CurrencyTypeId | CurrencyType enum | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
StockLocationInventoryDetails
Property Name | Property Value | Property Description |
---|---|---|
StockLocationId | Integer | |
ProductId | Integer | |
Price | Decimal or NULL | |
Quantity | Decimal | |
CreatedOn | DateTime | |
CurrencyTypeId | CurrencyType enum | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
InternalCostStatus
Property Name | Property Value | Property Description |
---|---|---|
Name | String | |
Description | String | |
ForecastGroupId | ForecastGroup enum | |
InternalCostStateId | CostState enum | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
WoFlag
Property Name | Property Value | Property Description |
---|---|---|
WoId | Integer | |
FlagId | Integer | |
UtcStamp | DateTime | |
Comment | String | |
ConcurrencyId | Integer | Gets or sets the concurrency identifier used for optimistic locks. |
Id | Integer | Gets or sets a Corrigo entity identifier. |
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. |
LinkProcedureCategoryAndTemplate
Property Name | Property Value | Property Description |
---|---|---|
ProcedureCategoryId | Integer | |
ProcedureTemplateId | Integer | |
Id | Integer | Gets or sets a Corrigo entity identifier. |
MoneyValue
Property Name | Property Value | Property Description |
---|---|---|
CurrencyTypeId | CurrencyType enum | |
Value | Decimal |
TaxDetail
Property Name | Property Value | Property Description |
---|---|---|
JurisType | JurisdictionType enum | |
JurisName | String | |
Rate | Decimal | |
TaxCalculated | Decimal | |
MoneyId | Integer | |
TaxDate | DateTime or NULL |