Corrigo: Commands schemas

65 Corrigo schemas with complete fields and constraints.

Ai response required wo statistic (Ai Response Required Wo Statistic Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`processedDays`	JSON	Optional
`processedDays (anyOf 1)`	integer	Alternative	Format: int32
`processedDays (anyOf 2)`	null	Alternative
`userEmail`	JSON	Optional
`userEmail (anyOf 1)`	string	Alternative
`userEmail (anyOf 2)`	null	Alternative

Ap status change (Ap Status Change Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`currentStatusId`	integer	Optional	Format: int32
`financialConcurrencyId`	integer	Optional	Format: int32
`keepCommentIntact`	boolean	Optional
`vendorInvoiceStatusId`	integer	Optional	Format: int32

Ap submit payment (Ap Submit Payment Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`currentStatusId`	integer	Optional	Format: int32
`financialConcurrencyId`	integer	Optional	Format: int32
`keepCommentIntact`	boolean	Optional
`vendorInvoiceStatusId`	integer	Optional	Format: int32
`checkCutDate`	JSON	Optional
`checkCutDate (anyOf 1)`	string	Alternative	Format: date-time
`checkCutDate (anyOf 2)`	null	Alternative
`checkNumber`	JSON	Optional
`checkNumber (anyOf 1)`	string	Alternative
`checkNumber (anyOf 2)`	null	Alternative
`paymentAmount`	number	Optional	Format: double

Asset match by task code (Asset Match By Task Code Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`assetCategories`	JSON	Optional
`assetCategories (anyOf 1)`	array	Alternative
`assetCategories (anyOf 1)[]`	string	Each item	One of: Unknown, Regular, Building, Unit, Community, RoomArea, Floor, Utility, Equipment Format: int32
`assetCategories (anyOf 2)`	null	Alternative
`parentAssetId`	integer	Optional	Format: int32
`recordCount`	integer	Optional	Format: int32
`taskCode`	JSON	Optional
`taskCode (anyOf 1)`	string	Alternative
`taskCode (anyOf 2)`	null	Alternative

Composite (Composite Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`commands`	JSON	Optional
`commands (anyOf 1)`	array	Alternative
`commands (anyOf 1)[]`	JSON	Each item
`commands (anyOf 1)[] (anyOf 1)`	object	Alternative	A Corrigo CommandRequest.
`commands (anyOf 1)[] (anyOf 2)`	null	Alternative
`commands (anyOf 2)`	null	Alternative
`isTransactional`	boolean	Optional

Convert money values (Convert Money Values Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`targetCurrencyTypeId`	Model	Optional	Expand Create rcs action — request body — body entity money Id
`values`	JSON	Optional
`values (anyOf 1)`	array	Alternative
`values (anyOf 1)[]`	JSON	Each item
`values (anyOf 1)[] (anyOf 1)`	object	Alternative	A Corrigo MoneyValue.
`values (anyOf 1)[] (anyOf 2)`	null	Alternative
`values (anyOf 2)`	null	Alternative

Referenced models: Create rcs action — request body — body entity money Id

Cost status change (Cost Status Change Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`costStatusId`	integer	Optional	Format: int32
`currentStatusId`	integer	Optional	Format: int32
`financialConcurrencyId`	integer	Optional	Format: int32
`keepCommentIntact`	boolean	Optional

Create (Create Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`entity`	JSON	Optional
`entity (anyOf 1)`	object	Alternative	A Corrigo CorrigoEntity.
`entity (anyOf 2)`	null	Alternative

Create wo printout (Create Wo Printout Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`languageId`	integer	Optional	Format: int32
`printoutTemplateId`	integer	Optional	Format: int32
`workOrderId`	integer	Optional	Format: int32

Delete (Delete Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`entitySpecifier`	JSON	Optional
`entitySpecifier (anyOf 1)`	object	Alternative	A Corrigo EntitySpecifier.
`entitySpecifier (anyOf 2)`	null	Alternative

Execute a command addressed through an entity — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`requestId`	JSON	Optional
`requestId (anyOf 1)`	string	Alternative
`requestId (anyOf 2)`	null	Alternative
`command`	JSON	Optional
`command (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`command (anyOf 1).*`	JSON	Additional keys
`command (anyOf 2)`	null	Alternative

Extend scheduled rcs action (Extend Scheduled Rcs Action Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`dueDate`	string	Optional	Format: date-time
`id`	integer	Optional	Format: int32

Generate pm wo (Generate Pm Wo Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`pmScheduleId`	integer	Optional	Format: int32

Get ai response required work orders (Get Ai Response Required Work Orders Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`filters`	JSON	Optional
`filters (anyOf 1)`	object	Alternative	A Corrigo AiResponseRequiredWorkOrdersFilters.
`filters (anyOf 2)`	null	Alternative
`login`	JSON	Optional
`login (anyOf 1)`	string	Alternative
`login (anyOf 2)`	null	Alternative
`skip`	JSON	Optional
`skip (anyOf 1)`	integer	Alternative	Format: int32
`skip (anyOf 2)`	null	Alternative
`sortBy`	JSON	Optional
`sortBy (anyOf 1)`	string	Alternative
`sortBy (anyOf 2)`	null	Alternative
`sortDirection`	JSON	Optional
`sortDirection (anyOf 1)`	string	Alternative
`sortDirection (anyOf 2)`	null	Alternative
`take`	JSON	Optional
`take (anyOf 1)`	integer	Alternative	Format: int32
`take (anyOf 2)`	null	Alternative

Get alert (Get Alert Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`workOrderId`	integer	Optional	Format: int32

Get company setting (Get Company Setting Command) — request body — body command

Field	Type	Presence
`$`	object	Root
`settingId`	JSON	Optional
`settingId (anyOf 1)`	string	Alternative
`settingId (anyOf 2)`	null	Alternative

Get company wsdk url (Get Company Wsdk Url Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`apiType`	string	Optional	One of: SOAP, REST Format: int32
`companyName`	JSON	Optional
`companyName (anyOf 1)`	string	Alternative
`companyName (anyOf 2)`	null	Alternative
`protocol`	string	Optional	One of: HTTP, HTTPS Format: int32

Get customer by asset (Get Customer By Asset Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`assetId`	integer	Optional	Format: int32
`searchCustomerInWorkZone`	boolean	Optional

Get doc download url (Get Doc Download Url Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`documentIds`	JSON	Optional
`documentIds (anyOf 1)`	array	Alternative
`documentIds (anyOf 1)[]`	integer	Each item	Format: int32
`documentIds (anyOf 2)`	null	Alternative

Get invoice list data (Get Invoice List Data Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`filters`	JSON	Optional
`filters (anyOf 1)`	object	Alternative	A Corrigo InvoiceListMcpFilters.
`filters (anyOf 2)`	null	Alternative
`login`	JSON	Optional
`login (anyOf 1)`	string	Alternative
`login (anyOf 2)`	null	Alternative
`skip`	JSON	Optional
`skip (anyOf 1)`	integer	Alternative	Format: int32
`skip (anyOf 2)`	null	Alternative
`sortBy`	JSON	Optional
`sortBy (anyOf 1)`	string	Alternative
`sortBy (anyOf 2)`	null	Alternative
`sortDirection`	JSON	Optional
`sortDirection (anyOf 1)`	string	Alternative
`sortDirection (anyOf 2)`	null	Alternative
`take`	JSON	Optional
`take (anyOf 1)`	integer	Alternative	Format: int32
`take (anyOf 2)`	null	Alternative

Get invoice tile data (Get Invoice Tile Data Command) — request body — body command

Field	Type	Presence
`$`	object	Root
`login`	JSON	Optional
`login (anyOf 1)`	string	Alternative
`login (anyOf 2)`	null	Alternative

Get pricing agent work zones specialties (Get Pricing Agent Work Zones Specialties Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`login`	JSON	Optional
`login (anyOf 1)`	string	Alternative
`login (anyOf 2)`	null	Alternative
`specialtiesSkip`	JSON	Optional
`specialtiesSkip (anyOf 1)`	integer	Alternative	Format: int32
`specialtiesSkip (anyOf 2)`	null	Alternative
`specialtiesSortBy`	JSON	Optional
`specialtiesSortBy (anyOf 1)`	string	Alternative
`specialtiesSortBy (anyOf 2)`	null	Alternative
`specialtiesSortDirection`	JSON	Optional
`specialtiesSortDirection (anyOf 1)`	string	Alternative
`specialtiesSortDirection (anyOf 2)`	null	Alternative
`specialtiesTake`	JSON	Optional
`specialtiesTake (anyOf 1)`	integer	Alternative	Format: int32
`specialtiesTake (anyOf 2)`	null	Alternative
`workZonesSkip`	JSON	Optional
`workZonesSkip (anyOf 1)`	integer	Alternative	Format: int32
`workZonesSkip (anyOf 2)`	null	Alternative
`workZonesSortBy`	JSON	Optional
`workZonesSortBy (anyOf 1)`	string	Alternative
`workZonesSortBy (anyOf 2)`	null	Alternative
`workZonesSortDirection`	JSON	Optional
`workZonesSortDirection (anyOf 1)`	string	Alternative
`workZonesSortDirection (anyOf 2)`	null	Alternative
`workZonesTake`	JSON	Optional
`workZonesTake (anyOf 1)`	integer	Alternative	Format: int32
`workZonesTake (anyOf 2)`	null	Alternative

Get time card (Get Time Card Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`baseDate`	string	Optional	Format: date-time
`employeeId`	integer	Optional	Format: int32

Invoice recall (Invoice Recall Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`invoiceId`	integer	Optional	Format: int32
`timestamp`	JSON	Optional
`timestamp (anyOf 1)`	string	Alternative	Format: date-time
`timestamp (anyOf 2)`	null	Alternative

Lir get all previews (Lir Get All Previews Command) — request body — body command

Field	Type	Presence
`$`	object	Root
`email1`	JSON	Optional
`email1 (anyOf 1)`	string	Alternative
`email1 (anyOf 2)`	null	Alternative

Lir get provider contacts (Lir Get Provider Contacts Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`email1`	JSON	Optional
`email1 (anyOf 1)`	string	Alternative
`email1 (anyOf 2)`	null	Alternative
`providerId`	integer	Optional	Format: int32

Lir outstanding invoice wo details (Lir Outstanding Invoice Wo Details Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`filters`	JSON	Optional
`filters (anyOf 1)`	array	Alternative
`filters (anyOf 1)[]`	JSON	Each item
`filters (anyOf 1)[] (anyOf 1)`	object	Alternative	A Corrigo LirInvoiceWoDetailsFilterExpression.
`filters (anyOf 1)[] (anyOf 2)`	null	Alternative
`filters (anyOf 2)`	null	Alternative

Make document public (Make Document Public Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`documentId`	integer	Optional	Format: int32

Material transaction commit (Material Transaction Commit Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`transaction`	JSON	Optional
`transaction (anyOf 1)`	object	Alternative	A Corrigo MaterialTransaction.
`transaction (anyOf 2)`	null	Alternative

Portfolio delete (Portfolio Delete Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`portfolioId`	integer	Optional	Format: int32

Post payment (Post Payment Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`paymentId`	integer	Optional	Format: int32
`timestamp`	JSON	Optional
`timestamp (anyOf 1)`	string	Alternative	Format: date-time
`timestamp (anyOf 2)`	null	Alternative

Post schedule ai solution (Post Schedule AI Solution Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`error`	JSON	Optional
`error (anyOf 1)`	object	Alternative	A Corrigo DecisionEngineErrorResponse.
`error (anyOf 2)`	null	Alternative
`requestId`	string	Optional	Format: uuid
`solution`	JSON	Optional
`solution (anyOf 1)`	object	Alternative	A Corrigo SchedulingSolution.
`solution (anyOf 2)`	null	Alternative
`status`	string	Optional	One of: Submitted, Queued, Running, Completed, Failed, Cancelled Format: int32

Proposal reject (Proposal Reject Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`proposalId`	integer	Optional	Format: int32

Retrieve with currency type (Retrieve With Currency Type Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`parentEntitySpecifiers`	JSON	Optional
`parentEntitySpecifiers (anyOf 1)`	array	Alternative
`parentEntitySpecifiers (anyOf 1)[]`	JSON	Each item
`parentEntitySpecifiers (anyOf 1)[] (anyOf 1)`	object	Alternative	A Corrigo EntitySpecifier.
`parentEntitySpecifiers (anyOf 1)[] (anyOf 2)`	null	Alternative
`parentEntitySpecifiers (anyOf 2)`	null	Alternative
`targetCurrencyTypeId`	Model	Optional	Expand Create rcs action — request body — body entity money Id

Referenced models: Create rcs action — request body — body entity money Id

Schedule agent requests tile (Schedule Agent Requests Tile Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`instanceWide`	boolean	Optional
`login`	JSON	Optional
`login (anyOf 1)`	string	Alternative
`login (anyOf 2)`	null	Alternative
`skip`	integer	Optional	Format: int32
`sortBy`	JSON	Optional
`sortBy (anyOf 1)`	string	Alternative
`sortBy (anyOf 2)`	null	Alternative
`sortDirection`	JSON	Optional
`sortDirection (anyOf 1)`	string	Alternative
`sortDirection (anyOf 2)`	null	Alternative
`take`	integer	Optional	Format: int32

Schedule agent summary tile (Schedule Agent Summary Tile Command) — request body — body command

Field	Type	Presence
`$`	object	Root
`instanceWide`	boolean	Optional
`login`	JSON	Optional
`login (anyOf 1)`	string	Alternative
`login (anyOf 2)`	null	Alternative

Schedule rcs action (Schedule Rcs Action Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionTypeId`	string	Optional	One of: Unknown, Purchased, Disposed, Refilled, CylinderRelease, CircuitRelease, Added, Recovered, Tested, Transferred, LeakIdentified, LeakRepaired, LeakTestFollow, Created, CircuitEdit, Retired, LeakTestInitial, Adjusted, CylinderEdit, LeakInspected, ALDCalibrated, Retrofitted, Activated, ServicedOrLeakRepaired Format: int32
`circuitId`	integer	Optional	Format: int32
`dueDate`	string	Optional	Format: date-time
`parasenseId`	JSON	Optional
`parasenseId (anyOf 1)`	string	Alternative
`parasenseId (anyOf 2)`	null	Alternative
`parentId`	JSON	Optional
`parentId (anyOf 1)`	integer	Alternative	Format: int32
`parentId (anyOf 2)`	null	Alternative
`workOrderId`	JSON	Optional
`workOrderId (anyOf 1)`	integer	Alternative	Format: int32
`workOrderId (anyOf 2)`	null	Alternative

Send work order (Send Work Order Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`requestQuote`	boolean	Optional
`sendTo`	JSON	Optional
`sendTo (anyOf 1)`	string	Alternative
`sendTo (anyOf 2)`	null	Alternative
`workOrderId`	integer	Optional	Format: int32

Set work order dependency (Set Work Order Dependency Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`dependentWorkOrderId`	integer	Optional	Format: int32
`mainWorkOrderId`	integer	Optional	Format: int32

Space create (Space Create Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`customerId`	integer	Optional	Format: int32
`endDate`	string	Optional	Format: date-time
`ifUnitAlreadyExists`	string	Optional	One of: Unknown, Fail, Reuse, Ignore Format: int32
`instructions`	JSON	Optional
`instructions (anyOf 1)`	string	Alternative
`instructions (anyOf 2)`	null	Alternative
`moveInDate`	string	Optional	Format: date-time
`moveOutDate`	string	Optional	Format: date-time
`newUnitSpecifier`	JSON	Optional
`newUnitSpecifier (anyOf 1)`	object	Alternative	A Corrigo NewUnitSpecifier.
`newUnitSpecifier (anyOf 2)`	null	Alternative
`startDate`	string	Optional	Format: date-time
`unitId`	integer	Optional	Format: int32

Time card action (Time Card Action Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionId`	string	Optional	One of: Uknown, Flag, Submit, Approve, Export, ClearFlag, UnSubmit, UnApprove, UnExport, ReadyForExport, NotReadyForExport Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`employeeId`	integer	Optional	Format: int32
`weekStartDate`	string	Optional	Format: date-time

Update (Update Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`entity`	JSON	Optional
`entity (anyOf 1)`	object	Alternative	A Corrigo CorrigoEntity.
`entity (anyOf 2)`	null	Alternative
`propertySet`	JSON	Optional
`propertySet (anyOf 1)`	object	Alternative	A Corrigo PropertySetBase.
`propertySet (anyOf 2)`	null	Alternative

Update invoice state (Update Invoice State Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`invoiceId`	integer	Optional	Format: int32
`state`	string	Optional	One of: Draft, Posted, Credit, CreditUsed, Paid, PaidInFull, Approved, Exported Format: int32
`timestamp`	JSON	Optional
`timestamp (anyOf 1)`	string	Alternative	Format: date-time
`timestamp (anyOf 2)`	null	Alternative

Update refrigerant sync settings (Update Refrigerant Sync Settings Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`lastSync`	string	Optional	Format: date-time
`status`	boolean	Optional

Update wo induction and safety status (Update Wo Induction And Safety Status Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`inductionAndSafetyStatusID`	string	Optional	One of: NotApplicable, NotRequired, Passed, PassedManual, Waiting, Started Format: int32

User or provider suspend (User Or Provider Suspend Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`id`	integer	Optional	Format: int32
`reactivate`	JSON	Optional
`reactivate (anyOf 1)`	boolean	Alternative
`reactivate (anyOf 2)`	null	Alternative

User sign in info (User Sign In Info Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`signInThresholdDate`	JSON	Optional
`signInThresholdDate (anyOf 1)`	string	Alternative	Format: date-time
`signInThresholdDate (anyOf 2)`	null	Alternative
`userIds`	JSON	Optional
`userIds (anyOf 1)`	array	Alternative
`userIds (anyOf 1)[]`	integer	Each item	Format: int32
`userIds (anyOf 2)`	null	Alternative

Verify work (Verify Work Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`woRatingId`	string	Optional	One of: Unknown, NotVerified, Negative, Neutral, Positive, NotCompleted Format: int32
`workOrderId`	integer	Optional	Format: int32

Wo add procedure (Wo Add Procedure Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`assetId`	integer	Optional	Format: int32
`procedureTemplateId`	integer	Optional	Format: int32

Wo assign (Wo Assign Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`assignees`	JSON	Optional
`assignees (anyOf 1)`	array	Alternative
`assignees (anyOf 1)[]`	integer	Each item	Format: int32
`assignees (anyOf 2)`	null	Alternative
`mode`	string	Optional	One of: Primary, AddSecondary, RemoveSecondary, Snapshot Format: int32

Wo check in (Wo Check In Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`employeeId`	JSON	Optional
`employeeId (anyOf 1)`	integer	Alternative	Format: int32
`employeeId (anyOf 2)`	null	Alternative
`latitude`	JSON	Optional
`latitude (anyOf 1)`	number	Alternative	Format: double
`latitude (anyOf 2)`	null	Alternative
`longitude`	JSON	Optional
`longitude (anyOf 1)`	number	Alternative	Format: double
`longitude (anyOf 2)`	null	Alternative

Wo clear flags (Wo Clear Flags Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`flagsToClear`	JSON	Optional
`flagsToClear (anyOf 1)`	array	Alternative
`flagsToClear (anyOf 1)[]`	integer	Each item	Format: int32
`flagsToClear (anyOf 2)`	null	Alternative

Wo complete (Wo Complete Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`completionNoteOption`	string	Optional	One of: Ignore, Replace, FillEmpty, Append Format: int32
`repairCodeId`	integer	Optional	Format: int32

Wo copy (Wo Copy Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32

Wo create (Wo Create Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`allowNewUnassignedEmergencies`	boolean	Optional
`computeAssignment`	boolean	Optional
`computeSchedule`	boolean	Optional
`emergencyDisabled`	boolean	Optional
`employeeId`	integer	Optional	Format: int32
`externalNumber`	JSON	Optional
`externalNumber (anyOf 1)`	string	Alternative
`externalNumber (anyOf 2)`	null	Alternative
`keepUnassigned`	boolean	Optional
`scheduledTransactions`	JSON	Optional
`scheduledTransactions (anyOf 1)`	array	Alternative
`scheduledTransactions (anyOf 1)[]`	integer	Each item	Format: int32
`scheduledTransactions (anyOf 2)`	null	Alternative
`skipBillToLogic`	boolean	Optional
`skipPriority`	boolean	Optional
`skipProcedures`	boolean	Optional
`workOrder`	JSON	Optional
`workOrder (anyOf 1)`	object	Alternative	A Corrigo WorkOrder.
`workOrder (anyOf 2)`	null	Alternative
`wpTree`	JSON	Optional
`wpTree (anyOf 1)`	object	Alternative	A Corrigo WpTree.
`wpTree (anyOf 2)`	null	Alternative

Wo message (Wo Message Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`senderId`	integer	Optional	Format: int32
`senderType`	Model	Optional	Expand Create actor — request body — body entity type Id

Referenced models: Create actor — request body — body entity type Id

Wo set flags (Wo Set Flags Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`actionDate`	string	Optional	Format: date-time
`actionReasonId`	integer	Optional	Format: int32
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`concurrencyId`	integer	Optional	Format: int32
`statusId`	string	Optional	One of: Unknown, Open, Paused, Cancelled, New, OnHold, InProgress, Completed Format: int32
`workOrderId`	integer	Optional	Format: int32
`flagsToSet`	JSON	Optional
`flagsToSet (anyOf 1)`	array	Alternative
`flagsToSet (anyOf 1)[]`	integer	Each item	Format: int32
`flagsToSet (anyOf 2)`	null	Alternative

Wo update procedure step (Wo Update Procedure Step Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`comment`	JSON	Optional
`comment (anyOf 1)`	string	Alternative
`comment (anyOf 2)`	null	Alternative
`dataValueId`	JSON	Optional
`dataValueId (anyOf 1)`	integer	Alternative	Format: int32
`dataValueId (anyOf 2)`	null	Alternative
`flagId`	JSON	Optional
`flagId (anyOf 1)`	integer	Alternative	Format: int32
`flagId (anyOf 2)`	null	Alternative
`moneyId`	Model	Optional	Expand Create rcs action — request body — body entity money Id
`procedureStepId`	integer	Optional	Format: int32
`updateMask`	string	Optional	One of: None, Comment, Flag, Value Format: int32
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative
`value (anyOf 2)`	null	Alternative

Referenced models: Create rcs action — request body — body entity money Id

Wo visit check in (Wo Visit Check In Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`dtWhen`	string	Optional	Format: date-time
`otherComments`	JSON	Optional
`otherComments (anyOf 1)`	string	Alternative
`otherComments (anyOf 2)`	null	Alternative
`services`	JSON	Optional
`services (anyOf 1)`	array	Alternative
`services (anyOf 1)[]`	integer	Each item	Format: int32
`services (anyOf 2)`	null	Alternative
`workOrderId`	integer	Optional	Format: int32
`iLatitude`	number	Optional	Format: double
`iLongitude`	number	Optional	Format: double
`iPhone`	JSON	Optional
`iPhone (anyOf 1)`	string	Alternative
`iPhone (anyOf 2)`	null	Alternative
`iValidated`	boolean	Optional
`iWeather`	JSON	Optional
`iWeather (anyOf 1)`	string	Alternative
`iWeather (anyOf 2)`	null	Alternative

Wo visit check out (Wo Visit Check Out Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`dtWhen`	string	Optional	Format: date-time
`otherComments`	JSON	Optional
`otherComments (anyOf 1)`	string	Alternative
`otherComments (anyOf 2)`	null	Alternative
`services`	JSON	Optional
`services (anyOf 1)`	array	Alternative
`services (anyOf 1)[]`	integer	Each item	Format: int32
`services (anyOf 2)`	null	Alternative
`workOrderId`	integer	Optional	Format: int32
`oLatitude`	number	Optional	Format: double
`oLongitude`	number	Optional	Format: double
`oPhone`	JSON	Optional
`oPhone (anyOf 1)`	string	Alternative
`oPhone (anyOf 2)`	null	Alternative
`oValidated`	boolean	Optional
`oWeather`	JSON	Optional
`oWeather (anyOf 1)`	string	Alternative
`oWeather (anyOf 2)`	null	Alternative

Wo visit verify (Wo Visit Verify Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`services`	JSON	Optional
`services (anyOf 1)`	array	Alternative
`services (anyOf 1)[]`	JSON	Each item
`services (anyOf 1)[] (anyOf 1)`	object	Alternative	A Corrigo WoVisitServiceCredit.
`services (anyOf 1)[] (anyOf 2)`	null	Alternative
`services (anyOf 2)`	null	Alternative
`verificationId`	string	Optional	One of: None, Bad, Good Format: int32
`verifyComments`	JSON	Optional
`verifyComments (anyOf 1)`	string	Alternative
`verifyComments (anyOf 2)`	null	Alternative
`visitId`	integer	Optional	Format: int32

Work zone create (Work Zone Create Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`assetTemplateId`	integer	Optional	Format: int32
`skipDefaultSettings`	boolean	Optional
`workZone`	JSON	Optional
`workZone (anyOf 1)`	object	Alternative	A Corrigo WorkZone.
`workZone (anyOf 2)`	null	Alternative

Work zone default (Work Zone Default Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root

Work zone delete (Work Zone Delete Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`workZoneId`	integer	Optional	Format: int32

Work zone offline (Work Zone Offline Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`deactivateCustomers`	boolean	Optional
`workZoneId`	integer	Optional	Format: int32

Report an issue with this page