Data models

ActionWithComment

Name	Type	Verification	Description
Comment	String	Optional	Action comment.

AdditionalField

A custom field created by the customer.

Name	Type	Verification	Description
AdditionalField	Int	Mandatory	Unique identifiers of a custom field in requestor’s system.
FieldLabel	String	Mandatory	A label of the custom field.
URLLabel	String	Optional	Applicable only for URL. Label used for URL.
Value	String	Mandatory	A value of the custom field.

AdditionalFieldDescriptor

Information regarding the definition of a custom field.

Name	Type	Verification	Description
Id	String	Mandatory	Custom field ID.
Label	String	Mandatory	A label of the custom field.
Values	String[]	Optional	Custom field values, which are possible to select. Array.
DataType	String	Mandatory	Custom field value data type ( 'String', 'Integer', 'Float', 'Money', 'PhoneNumber', 'Date', 'Time', 'Bool', 'Url').
DataLength	Int	Mandatory	Length of a value that can be entered in the custom field.
IsDeleted	Bool	Mandatory	Length of a value that can be entered in the custom field
IsReadonly	Bool	Mandatory	Identifies whether the custom field is read-only. If value = true, then value is ready-only.

AdditionalFieldHistory

Describes the history of changes made to the values of a custom field.

Name	Type	Verification	Description
URLLabel	String	Optional	Applicable only for URL. Label used for URL.
Value	String	Mandatory	A value of the custom fields.
DtStemp	DateTime	Mandatory	Date and time of field value changes.
UpdatedBy	String	Mandatory	A person who updated a custom field value

Address

Address information as received from a customer.

Name	Type	Verification	Description
City	String	Optional, Maximum length 40	A city name.
Country	String	Optional, Maximum length 50	Name or abbreviation of a country.
State	String	Optional, Maximum length 128	Name or abbreviation of a state.
Street1	String	Optional, Maximum length 128	A street (line 1).
Street2	String	Optional, Maximum length 128	A street (line 2). This field is used if the street information does not fit the Street1 field.
PostalCode	String	Optional, Maximum length: 10	A postal code/ZIP code.

Appointment

Name	Type	Verification	Description
ScheduledStart	DateTime	Mandatory	Scheduled start date of a work order.
Pte	Pte	PTE Mandatory	Permission To Enter describes what a technician must do before arriving on site.

Asset

Describes a requested service.

Name	Type	Verification	Description
Id	Int	Mandatory	Identifier of an asset.
Path	String	Optional, Maximum length 128	Hierarchical path describes the type of work. “ >” is used as a separator in the path.
Task	String	Mandatory, Maximum length 512	Description of what should be done.
AssetName	String	Mandatory, Maximum length 128	An asset name.
Comment	String	Optional, Maximum length 3096	Additional information about the service.

Attachment

Attachments are files, often pictures, that can be attached to work orders by either you or your customer.

Name	Type	Verification	Description
Id	String	Mandatory, Maximum length 36	A unique attachment identifier.
Sender	Sender	Mandatory	Information about a person who added the attachment.
Name	String	Mandatory	The attachment name.
MimeType	String	Mandatory	The attachment type.
Size	Long	Mandatory	The file size in bytes.
SentAt	DateTime	Mandatory	The date when the attachment was sent.

BulkActionError

Describes a bulk action error.

Name	Type	Verification	Description
Code	ErrorCode	Mandatory	The error code.
Message	String	Mandatory, Maximum length 1000	The error text.

BulkActionResult

Description of a result of a bulk action.

Name	Type	Verification	Description
WorkOrderId	Int	Mandatory	Identifier of a work order.
Error	BulkActionError	Optional	Description of an error. Is available only if a work order failed to be processed.

CheckListItem

Аn item to be checked as work is done. Used in actions which modify check list properties.

Name	Type	Verification	Description
Id	Int	Mandatory	Identifier of an item to be checked.
Comment	String	Optional, Maximum length 512	A comment provided by a provider about the checklist item.
Exception	String	Optional, Maximum length 256	Text of the exception. Additional information provided by the provider for the checklist item.
IsDone	Bool	Mandatory	When true, indicates that the work is completed.

CheckListItemDescriptor

Describes an item to be checked as work is done. Used in actions which retrieve state of a check list.

Name	Type	Verification	Description
Id	Int	Mandatory	Identifier of an item to be checked.
SortingIndex	Int	Mandatory	Index for ordering items in the checklist.
Description	String	Mandatory, Maximum length 512	Description of an activity or a check to be done.
Comment	String	Optional, Maximum length 512	A comment provided by a provider about the checklist item.
Exception	String	Optional, Maximum length 256	Text of the exception. Additional information provided by the provider for the checklist item.
IsDone	Bool	Mandatory	When true, indicates that the work is completed.

CompletionDetails

Describes work order completion details.


CompletedOn	DateTime	Optional	Date and time of work order completion.
RepairCategoryId	Int	Optional	Selected repair category id.
RepairCategory	String	Optional	Selected repair category name.
RepairCodeId	Int	Optional	Selected repair code id.
RepairCode	String	Optional	Selected repair code name.
Comment	String	Optional	Optional Completion comment.
CustomFields	CustomField	Optional	List of available custom fields with their values.

Contact

A contact is the person requesting the work.

Name	Type	Verification	Description
FullName	String	Mandatory, Maximum length 100	Name of a person who created a request.
ContactAt	String	Mandatory, Maximum length 512	The contact information represented as a single string (email, phone).
Phones	String[]	Optional	A parsed phone part from the ContactAt. It can also include additional phone numbers not listed in the ContactAt.
Emails	String[]	Optional	A parsed email part from the ContactAt. It can also include additional emails not listed in the ContactAt.

CruMember

Information about a technician.

Name	Type	Verification	Description
Id	Int	Mandatory	A cru member identifier.
Name	String	Mandatory, Maximum length 100	The cru member name.
Phone	Sring	Mandatory	The cru member phone.

CustomerDetails

The customer corresponds to the company that has sent you the work order, e.g. Safeway, Wells Fargo, etc.

Name	Type	Verification	Description
Id	Int	Mandatory	A unique identifier of a customer in Corrigo.
Name	String	Mandatory, Maximum length 256	The customer name.
BranchIds	Int[]	Optional	Unique identifiers of your branches to which this customer is connected.

CustomField

Additional field that can be required for completion of a work order.

Name	Type	Verification	Description
Id	Int	Mandatory	Corresponds to a CustomFieldDescriptor.Id.
Value	string	Mandatory, Maximum length 1024	Value of a custom field set by the provider. The provided value must meet the requirements defined by the CustomFieldDescriptor. *(Note: Custom field values are case-sensitive.)*

Name

Type

Verification

Description

Int

Mandatory

Corresponds to a CustomFieldDescriptor.Id.

Value

string

Mandatory,
Maximum length 1024

Value of a custom field set by the provider.

The provided value must meet the requirements defined by the CustomFieldDescriptor.

(Note: Custom field values are case-sensitive.)

CustomFieldDescriptor

Detailed description of an additional field required for completion of a work order.

Name	Type	Verification	Description
Id	Int	Mandatory	The identifier of a custom field in a customer system.
LabelText	String	Maximum length 50	A name of the custom field.
IsRequired	Bool	Mandatory	If true, the custom field value is required.
DataLength	Int	Mandatory	Length of a value that can be entered in the custom field.
Values	String[]	Optional	If available, the custom field must be one of the values from this list.
Type	ValueType	Mandatory	The custom field value data type.
Currency	String	Optional, Maximum length 3	ISO 4217 alphabetic currency code. This parameter is required if the Type is Money.

DateRange

Describes a date range.

Name	Type	Verification	Description
From	DateTime	Mandatory	Date and time when an event starts.
To	DateTime	Mandatory	Date and time when the event completes.

EditableInvoice


InvoiceNumber	String	Optional Max length - 32	Invoice number. Mandatory for Invoice Submit.
InvoiceDate	DateTime	Optional	Invoice Date. Mandatory for Invoice Submit.
DiscountAmount	Decimal (Money)	Optional	Optional Discount.
ConcurrencyId	Long	Optional	Concurrency identifier.
LineItems	LineItem[]	Optional	List of line items

Equipment

Describes of a piece of equipment.

Name	Type	Verification	Description
Id	Int	Mandatory	Equipment identifier in a customer system.
Type	EquipmentType	Mandatory	Type of equipment.
EquipmentAssetId	Int	Optional *	Corresponds to the EquipmentAsset.Id in a customer system.
Name	String	Optional	Name or title of equipment.
Comment	String	Optional, Maximum length 1024	Additional information about equipment, such as S/N, model number, manufacturer, etc.

This field is mandatory if the Type = Existing.

EquipmentAsset

Describes predefined customer equipment.

Name	Type	Verification	Description
Id	Int	Mandatory	Identifier of a piece of equipment in a customer system.
Name	String	Mandatory	Name of the piece of equipment.

EquipmentAttribute

A new value of an attribute of a predefined customer equipment.

Name	Type	Verification	Description
Id	Int	Mandatory	Identifier of an attribute descriptor in a customer system.
Value	String	Mandatory	A value of the attribute of the piece of equipment.

EquipmentAttributeDescriptor

Describes an attribute of a piece of equipment.

Name	Type	Verification	Description
Id	Int	Mandatory	An attribute identifier in a customer system.
LabelText	String	Maximum length 50	The attribute name.
Value	String	Optional, Maximum length 1024	The current value of the attribute.
Values	String[]	Optional	If available, the attribute value must be one of the values from this list.
Type	ValueType	Mandatory	The attribute value type.
HistoryAvailable	Bool	Mandatory	If true, the history of the attribute changes is available, and can be viewed. If false, the history of changes is not tracked.
DataLength	Int	Mandatory	The attribute value length.

EquipmentAttributeHistory

History of an attribute of the piece of equipment.

Name	Type	Verification	Description
TimeStamp	DateTime	Mandatory	Date and time when the attribute was changed.
Value	String	Mandatory	A value of the attribute.

EquipmentWorkedOn

Information about a piece of equipment to be added or updated in a work order.

Name	Type	Verification	Description
Id	Int	Mandatory	Corresponds to theField Id in a customer system. It must be 0 when you add equipment to the work order.
Type	EquipmentType	Mandatory	Equipment type.
EquipmentAssetId	Int	Optional *	Corresponds to the EquipmentAsset.Id in a customer system.
Comment	String	Optional	A field for entering information about piece of equipment, such as S/N, model number, manufacturer, etc.
Attributes	EquipmentAttribute[]	Optional	List of attributes of the piece of equipment.

This field is mandatory if the Type = Existing.

Feedback

Customer rating for completed work.

Name	Type	Verification	Description
TimeStamp	DateTime	Mandatory	Date and time when a work order was evaluated.
Actor	String	Mandatory	Name of a person who evaluated the work order.
Comment	String	Optional	An optional comment from an evaluator of the work order.
Type	FeedbackType	Mandatory	Work order evaluation result type.

GeoLocation

Geographic coordinates of a technician or subcontractor at the moment of checking in a work order.

Name	Type	Verification	Description
Latitude	Float (double)	Mandatory, Minimum value -90, Maximum value 90	Google geographic latitude.
Longitude	Float (double)	Mandatory, Minimum value -180, Maximum value 180	Google geographic longitude.

InputValidationError

Description of an invalid field of a request model.

Name	Type	Verification	Description
FieldName	String	Mandatory	Name of the invalid field. For complex structure ‘.’ is used as separator for nested types. Example: PerformedBy.Name
ErrorType	InputErrorType	Mandatory	Type of an error.
Message	String	Mandatory	The error message description.

Invoice

Name	Type	Verification	Description
InvoiceNumber	String	Optional Max length - 32	Invoice number. Mandatory for Invoice Submit.
InvoiceDate	DateTime	Optional	Invoice Date. Mandatory for Invoice Submit.
DiscountAmount	Decimal (Money)	Optional	Optional Discount.
ConcurrencyId	Long	Optional	Concurrency identifier
LineItems	LineItem[]	Optional	List of line items.
Status	InvoiceStatus	Mandatory	Invoice Status
TotalAmount	Decimal (Money)	Mandatory	Total Amount of invoice.
Nte	Decimal (Money)	Mandatory	Not To Exceed includes information approved quote.
IsPrebilled	Boolean	Mandatory	If true, an invoice should be submitted before the work order is accepted.
CustomerComment	DateTime	Optional	Optional comment.
Currency	DateTime	Mandatory	Currency ISO three letter code.
LastUpdateDate	DateTime	Mandatory	Last Update Date.
SubmissionDeadline	DateTime	Optional	Submit invoice before date.
HasAttachments	Boolean	Mandatory	True if invoice has attachments.
PaymentDate	DateTime	Optional	Invoice payment date (if invoice status is paid).
CheckNumber	String	Optional	Payment check number (if invoice status is paid).
PaymentAmount	Decimal (Money)	Optional	Invoice payment amount (if invoice status is paid).

IVRInfo

Information for using Interactive Voice Response


IvrNumber	String	Optional	Phone number to access IVR application
WonInfo	String	Optional	An optional customer-specific instructions
IvrCode	String	Optional	IVR code, usable only if IvrNumber is specified

InternalNote

Internal note object containing detailed information about the internal note history.

Name	Type	Verification	Description
InternalNoteText	String	Mandatory, Max Length 3000	Internal note field.
DtStamp	DateTime	Mandatory	Date of note creation.
UpdatedBy	String	Mandatory	Person who changed an internal note.

LineItem

Name	Type	Verification	Description
Id	Int	Optional *	Line item identifier in the CorrigoPro system (generated by the system)
Category	LineItemCategory	Required	Line item type
PriceListItemId	Int	Optional **	Customer price list item identifier
PriceListItemName	String	Optional **	Customer price list item name
IsRateReadOnly	Bool	Optional **	If true, relevant price list item rate can not be changed by provider
Description	String	Optional ***	Line item description
Quantity	Decimal	Required	Line item quantity. For Labor type represents a fractional number of hours
Rate	Decimal (Money)	Required	Cost per line item unit. Currency is taken from Workorder.Currency
TaxCode	String	Optional	Tax code of related tax to the PriceListItem or TaxItem as self.

* Required to edit an existing item. Must be empty to add a new item
** Required if Category = PriceList
*** Optional during invoice edit. Required during invoice submit.

MessageHeader

A Message header is present in all WebHook notifications. Its Action indicates what was changed.

Name	Type	Verification	Description
WorkOrderId	int	Mandatory	Unique identifier (Id) of Work Order in the CorrigoPro system.
BranchId	int	Mandatory	Identifier of the Provider Branch to which this Work Order was sent. You may find it in CorrigoPro Desktop.
Sender	Sender	Mandatory	Information about person who changed a Work Order.
Action	Actions	Mandatory	Action type.
ActionDate	DateTime	Mandatory	Date of an action.
ApiVersion	string	Mandatory, Maximum length 50	CorrigoPro Direct API version.
MessageId	string	Mandatory, Maximum length 36	Unique message identifier.

NTE

Describes a quote amount request.

Name	Type	Verification	Description
Amount	Decimal (Money)	Mandatory	Not to exceed amount. When set to 0, NTE is not applied.
Quote	Quote	Optional	Is available if the quote is submitted by a provider.
IsQuoteMultiline	Bool	Optional	Flag to show if NTE is applicable to line item (true) or work order (false).
DtLastUpdate	DateTime	Optional	NTE last updated date.

Participants

A list of participants to be assigned or unassigned to work orders.

Name	Type	Verification	Description
SubcontractorIds	int[]	Optional *	Identifiers of subcontractors. To retrieve these identifiers, call the GET - api/associates method, and review the Response.Subcontractors.Id.
ProMemberIds	int[]	Optional *	Identifiers of CorrigoPro cru members. To retrieve these identifiers, call the GET - api/associates method, and review the Response.CruMembers.Id.

At least one of the fields must be provided and must contain at the least one item.

PerformedBy

Information about a person who performs an operation.

Name	Type	Verification	Description
Name	String	Mandatory, Maximum length 100	Name of a person who performs the operation.
Phone	String	Optional, Valid phone number	Phone number of the person who performs the operation.

Placemark

Information about location of service requested in a work order.

Name	Type	Verification	Description
OccupantID	Int	Mandatory	Identifier of an occupant (tenant) in your customer's system. (Note: This is 0 for all work orders created before 2017-10-13.)
Address	Address	Optional	Address of the placemark.
Geo	GeoLocation	Mandatory	The geographic coordinates of the placemark.
OccupantName	String	Optional, Maximum length 64	Name of an occupant (tenant) in your customer's system.
SpaceName	string	Optional	Name of a space in your customer's system. *(Note: This will be null for work orders created before 2017-12-07.)*
SpaceId	int	Optional	Space identifier in your customer's system. *(Note: This will be null for work orders created before 2017-12-07.)*

📘
Additional Information on Placemarks
Both the Occupant and Space should be considered when using Placemark Locations. Neither is a unique identifier alone.
An OccupantID is unique per customer, but is not guaranteed to be unique among different customers.
A Space is considered to be specific area for the occupant. Depending on the customer, this could be a room name or number, a floor, or even an area of a room or floor. It is possible for a customer to reuse a Space (ID and Name) for another occupant. A Space cannot be assumed to be unique on its own.
Because a Space is location for an Occupant, you may receive work orders that use the same OccupantID, but with differing SpaceIds.
It is important to consider the Customer, Occupant, and Space when storing or mapping Landmarks to your own systems.

Procedure

Name	Type	Verification	Description
Id	Int	Mandatory	Procedure identifier in a customer system
Order	Int	Mandatory	Procedure order in work order
Name	String	Optional	Procedure name
AllowMarkNotApplicable	bool	Mandatory	When true, indicates that the procedure can be mark as not applicable
Status	ProcedureStatus	Mandatory	Status of procedure
Asset	Asset	Optional	Corresponds to the Asset in a customer system
Steps	StepDescriptor[]	Optional	List of steps

ProcedureUpdates

		Verification	Description
Procedure	Procedure	Mandatory	New information about procedures.
UpdateType	UpdateProcessType	Mandatory	Specify that procedure was removed, added or changed.

Quote

A request from a provider to increase NTE amount.

Name	Type	Verification	Description
Amount	Decimal (Money)	Mandatory	If the quote is approved by a customer, the WorkOrder.Nte.Amount becomes equal to the quoted amount.
QuoteStatus	QuoteStatus	Mandatory	A status of the request.
Comment	String	Mandatory, Maximum length 3072	Descriptive text with a reason why the provider needs to increase the NTE.
RejectionReason	String	Optional	Quote rejection reason.
DiscountAmount	Decimal (Money)	Optional	Calculated discount amount.
DiscountType	DiscountType	Optional	Type of discount.
QuoteLineItems	QuoteLineItem[]	Optional	The list of quote items added to the work order. Array

RepairCategory

Describes a repair category of a customer.

Name	Type	Verification	Description
Id	Int	Mandatory	Identifier of a repair category in a customer system.
Name	String	Mandatory, Maximum length 50	A repair category name.
Codes	RepairCode	Optional	A code of the repair category. If the AreRepairCodesAvailable is set to false in customer settings, the codes list is not available. Call GET - /api/customerSettings to check the value for AreRepairCodesAvailable.

RepairCode

Describes a repair code name.

Name	Type	Verification	Description
Id	Int	Mandatory	Identifier of a repair code in a customer system.
Name	String	Mandatory, Maximum length 50	A repair code name.

RepairInfo

Description of a repair category and code information.

Name	Type	Verification	Description
CodeId	Int	Optional *	Selected repair code identifier.
CategoryId	Int	Mandatory	Selected repair category identifier.
Code	String	Optional *	Selected repair code name.
Category	String	Mandatory	Selected repair category name.

* Can be mandatory if IsRepairCodeRequired is set to true in the customer settings. Call GET - /api/customerSettings to check the value of IsRepairCodeRequired.

RepairInfoHeader

Describes a repair category and code identifiers.

Name	Type	Verification	Description
CodeId	Int	Optional	Identifier of a selected repair code.
CategoryId	Int	Mandatory	Selected repair category identifier.

Sender

Information about a person who performed an action or sent a message.

Name	Type	Verification	Description
Name	string	Mandatory, Maximum length 100	Name of a person who performed an action.
Phone	string	Optional, Valid phone number	A phone number of the person who performed the action.
Type	SenderType	Mandatory	Determines application from which a message was sent.

SearchModel

Description of work orders search.
All search criteria are united with logical operator AND. Only Statuses criteria are united with logical operator OR.

Examples:
Created = {From: 2000-02-30T23:20:50.52Z, To: 2000-03-03T23:20:50.52Z} AND WorkOrderNumber = “JFH8920L48R”
Created = {From: 2000-02-30T23:20:50.52Z, To: 2000-03-03T23:20:50.52Z} AND ( Statuses = “New” OR Statuses = “Accepted”).

Name	Type	Verification	Description
WorkOrderNumber	String	Optional, Maximum length 50	Search for work orders where work order number contains a provided value.
CustomerId	Int	Optional	Identifier of a customer from whom the work order is received.
BranchId	Int	Optional	Identifier of the branch the work order is sent to.
Created	DateRange	Optional, Maximum range 30 days *	Work order creation date range.
AcknowledgeBy	DateRange	Optional, Maximum range 30 days *	Work orders that should be accepted/ rejected within the provided Date Range.
OnSiteBy	DateRange	Optional, Maximum range 30 days *	Work orders that should be started within the provided DateRange.
DueDate	DateRange	Optional, Maximum range 30 days *	Work orders that should be completed within the provided DateRange.
LastUpdate	DateRange	Optional, Maximum range 30 days *	Work orders that were changed within the provided DateRange.
Statuses	Status	Optional	List of work order statuses.

Semi-optional: at least of of these fields must be provided.

ScheduleInfo

Information about work schedule.

Name	Type	Verification	Description
ScheduledStart	DateTime	Optional	Scheduled start date of a work order.
Pte	PTE	Mandatory	Permission To Enter describes what a technician must do before arriving on site.

SLA

Service Level Agreement includes information about priority and deadlines of a work.

Name	Type	Verification	Description
DueDate	DateTime	Optional	Work order completion deadline.
OnSiteBy	DateTime	Optional	Work order start deadline.
AcknowledgeBy	DateTime	Optional	Accept/ reject deadline date.
PriorityId	Int	Mandatory	Identifier of the priority.
PriorityName	String	Mandatory, Maximum length 40	Work order priority.
IsEmergency	Bool	Mandatory	Indicates if the work order is an emergency case.

Step

Name	Type	Verification	Description
Id	Int	Mandatory	Step identifier in a customer system.
Status	ProcedureStatus	Mandatory	Status of step.
Value	String	Optional	A value of the step.
Comment	String	Optional	A comment of the step.
Currency	String	Optional	ISO 4217 alphabetic currency code.

StepAttachment

Represents attachment to a procedure step.

Name	Type	Verification	Description
Id	String	Mandatory	A unique attachment identifier.
Name	String	Mandatory	The Attachment name.
MimeType	String	Mandatory	The attachment type.

StepDescriptor

Name	Type	Verification	Description
Id	Int	Mandatory	Step identifier in a customer system.
Status	ProcedureStatus	Mandatory	Status of step.
Value	String	Optional	A value of the step.
Comment	String	Optional	A comment of the step.
Currency	String	Optional	ISO 4217 alphabetic currency code.
Order	Int	Mandatory	Step order in procedure
IsRequired	bool	Mandatory	When true, indicates that it is required to complete this step.
Description	String	Optional	A description of the step.
StepType	StepType	Mandatory	Type of step.
FlagReason	String	Optional	A flag reason of the step.
Label	String	Optional	A label of the step.
DataType	ValueType	Optional	The step value data type

StepDetails

Name	Type	Verification	Description
Id	Int	Mandatory	Step identifier in a customer system.
Instructions	String	Optional	A instructions of the step
Options	String[]	Optional	If available, the step must be one of the values from this list.
IsNa	Bool	Mandatory	Whether the value of a step can be changed or not.

Subcontractor

Information about a subcontractor.

Name	Type	Verification	Description
Id	Int	Mandatory	Identifier of a subcontractor.
Name	String	Mandatory, Maximum length 200	The subcontractor name.
Phone	String	Mandatory	The subcontractor phone.

TaxItemValidationResult

Name	Type	Verification	Description
Code	String	Mandatory	Tax code.
Description	String	Mandatory	Tax description or tax code if description is empty.
CalculatedAmount	Decimal	Mandatory	Needed tax amount per tax code.
TaxableAmount	Decimal	Mandatory	Initial amount of corresponding invoice line item.
SubmittedAmount	Decimal	Mandatory	Submitted tax amount per tax code.
CurrencyType	String	Mandatory	Currency.
IsValid	Bool	Mandatory	Tax item validation flag.

TextMessage

Describes a message in text format.

Name	Type	Verification	Description
Text	String	Mandatory, Maximum length 2000	Text of a message.
SentAt	DateTime	Mandatory	Date of an action.
Sender	Sender	Mandatory	Sender of the message.

Visit

Name	Type	Verification	Description
Id	Int	Optional	Visit identifier.
CheckedIn	DateTime	Optional	Date and time of CheckedIn of the visit.
CheckedOut	DateTime	Optional	Date and time of CheckedOut of the visit.
CheckInPhone	String	Optional	Phone number used for CheckIn.
CheckOutPhone	String	Optional	Phone number used for CheckOut.
Comment	String	Optional	A comment of the visit.
CheckInActor	String	Optional	Name of a person who evaluated CheckIn.
CheckOutActor	String	Optional	Name of a person who evaluated CheckOut.
IsCustomerVisit	Bool	Optional	When true, indicates that the visit created by the customer.
VisitStatus	VisitStatus	Optional	Verification status of visit.
VerificationComment	String	Optional	A comment provided by the customer about the visit verification.
VerificationCommentAuthor	String	Optional	Name of a person who provided verification comment.
VisitCommentAuthor	String	Optional	Name of a person who provided visit comment.
DtCreated	DateTime	Optional	Creation date of the visit.
CheckInWeather	String	Optional	Weather forecast during CheckIn.
CheckOutWeather	String	Optional	Weather forecast during CheckOut.
VisitProvidedServices	VisitProvidedService[]	Optional	Visit services that were provided.

VisitInfo

Name	Type	Verification	Description
Visits	Visit[]	Optional	List of Visits
VisitWoDetails	VisitWoDetails	Optional	Visit Work Details.
VisitServices	VisitServices[]	Optional	Visit service Financial Details.

VisitProvidedService

Name	Type	Verification	Description
ServiceId	Int	Optional	Service identifier.
Verification	Double	Optional	Amount of credit for Visit.
Name	String	Optional	The service name.

VisitWoDetails

Name	Type	Verification	Description
IvrCode	String	Optional	IVR code, usable only if IvrNumber is specified.
Instruction	String	Optional	Instruction for visit.
MaxNumberOfVisits	Int	Optional	Max number of possible visits.
WindowSchedule	WindowSchedule	Optional	Schedule for visits.
DtStart	DateTime	Optional	Start of the time period covered by visits schedule.
DtEnd	DateTime	Optional	End of the time period covered by visits schedule.
WeatherForecast	String	Optional	Optional element containing WO trigger event information supplied by third-party application, such as weather forecast.

VisitServices

Name	Type	Verification	Description
Id	Int	Optional	Visit service identifier.
Rate	Decimal (Money)	Optional	Service rate.
MoneyCulture	String	Optional	The money culture of currency data
Name	String	Optional	Name of a service.

WindowSchedule

Name	Type	Verification	Description
VisitDays	VisitDay	Optional	A bitmask representing visits schedule.
LocalWindowStart	String	Optional	Start of the arrival time window
WindowDurationInMinutes	Int	Optional	Visit time window duration in minutes.

WoActionInfo

Name	Type	Verification	Description
DtStamp	String	Optional	Date and time of action.
EventType	String	Optional	Type of Action Event.
Data	ActionWithComment	Optional	Data of Event Action

WorkDetails

Details about services to be provided and procedures to be filled out.

Name	Type	Verification	Description
CheckList	CheckListItemDescriptor[]	Optional	Items to be checked during the work process.
Assets	Asset[]	Mandatory	Information about services to be provided.
Procedures	Procedure[]	Optional	Procedures with steps to be completed during the work process.
VisitInfo	VisitInfo	Optional	Visit work order information.

❗️
Deprecation Warning
Check lists are becoming Procedures for most Enterprise clients on March 22, 2018, and we discourage their usage.

WorkOrder

Provides a detailed description of a work order.

Name	Type	Verification	Description
WorkOrderNumber	String	Mandatory Minimum length 16 Maximum length 32	An alphanumeric identifier of a work order in a customer system.
WorkOrderId	Int	Mandatory, Is greater than 0	A unique identifier of a work order in the CorrigoPro system.
BranchId	Int	Mandatory	Identifier of the Provider Branch to which this Work Order was sent. You may find it in CorrigoPro Desktop.
IVRInfo	IVRInfo	Optional	Optional IVR information.
Schedule	ScheduleInfo	Mandatory	Information about the work order schedule.
Type	WorkOrderType	Mandatory	The work order type.
AccompanyingMessage	String	Mandatory, Maximum length 3072	A descriptive summary of the work order provided by the requester.
Nte	NTE	Mandatory	Not To Exceed includes information about amount and quote request.
Sla	SLA	Mandatory	Service Level Agreement includes information about priority and term of execution work.
WorkDetails	WorkDetails	Mandatory	Details about services to be provided and procedures to be filled out.
CompletionDetails	CompletionDetails	Optional	Optional Comptetion Details information.
Contact	Contact	Optional	Information about a person who requested work.
ServiceLocation	Placemark	Optional	Information about work location.
Customer	CustomerDetails	Mandatory	Information about a customer.
IsPrebilled	Bool	Mandatory	If true, an invoice should be submitted before the work order is accepted.
IsWarranty	Bool	Mandatory	If true, the work order is possibly covered by warranty.
Created	DateTime	Mandatory	Creation date of the work order.
LastUpdate	DateTime	Mandatory	Date and time when the work order was last modified. This value changes if there are any changes in the work order data model. When a work order is in New status, changes to the work order are not tracked, and the LastUpdate value corresponds to the Created value.
Feedback	Feedback	Optional	Customer rating of completed work. The value is available only for work order in the Verified status.
Status	Status	Mandatory	Status of the work order.
Currency	String	Mandatory, Length 3	ISO 4217 alphabetic currency code.
TimeZone	String	Mandatory	Information for the time zone of service location
WorkZoneNumber	String	Maximum length 80	Information for Work Zone Number of the service location
InternalNote	String	Optional, Max length 3000	Internal note field.
AdditionalFields	AdditionalField	Optional	The list of custom fields and their values. Array.
LastAction	WoActionInfo	Optional	Work order last action.
IsmStatus	String	Optional	Status of the Induction and Safety Management = [“NotRequired”, “Waiting”, “Started”, “Passed”, “ManuallyPassed”]

WorkOrderSearchResult

Provides basic description of a work order.

Name	Type	Verification	Description
WorkOrderNumber	String	Mandatory, Maximum length 50	A unique alphanumeric identifier of a work order in a customer system.
WorkOrderId	Int	Mandatory, Is greater than 0	A unique identifier of a work order in the CorrigoPro system.
Type	WorkOrderType	Mandatory	A type of the work order.
Sla	SLA	Mandatory	Service Level Agreement includes information about priority and term of execution of work.
Status	Status	Mandatory	Status of the work order.
Customer	CustomerDetails	Mandatory	Information about a customer.
LastUpdate	DateTime	Mandatory	Date and time when the work order was last modified. This value changes if there are any changes in work order data. When a work order is in New status, changes to the work order are not tracked, and theLastUpdate value corresponds to the Created value.
Created	DateTime	Mandatory	Date and time of creation of the work order.
InternalNote	String	Optional, Max Length 3000	Internal note field.