Create Service Reminder
Creates a new Service Reminder
- application/json
Request Body
- service_task_id integer required
Possible values:
>= 1
- meter_interval float required
The meter interval of which this Service Reminder should occur.
- secondary_meter_interval float
The secondary meter interval of which this Service Reminder should occur.
- secondary_meter boolean
Default value:
false
Indicates whether the Service Reminder is associated with a secondary meter. If this is not set, the value for the record will be set to
false
. - time_interval integer
The number of time units according to
time_frequency
between each occurrence of the Service Reminder. - time_frequency string
Possible values: [
days
,weeks
,months
,years
] - overridden boolean
Indicates whether the Service Reminder is overridden.
- next_due_meter_value float
The meter value at which the Service Reminder is next due, if applicable.
- next_due_secondary_meter_value float
The secondary meter value at which the Service Reminder is next due, if applicable.
- next_due_at date-time
We recommend using ISO-8601 formatted dates to avoid ambiguity.
- due_soon_meter_threshold float
The meter value threshold to which this Service Reminder will be due soon.
- due_soon_secondary_meter_threshold float
The secondary meter value threshold to which this Service Reminder will be due soon.
- active boolean
Indicates whether the Service Reminder is currently active.
- due_soon_time_threshold_interval integer
The number of time units according to
due_soon_time_threshold_frequency
betweendue_soon_at
occurrences. - due_soon_time_threshold_frequency string
Possible values: [
days
,weeks
,months
,years
] - vehicle_id integer required
Possible values:
>= 1
- starting_interval boolean
Indicates whether the Service Reminder has a starting interval.
- starting_meter_interval float
The starting meter interval for this Service Reminder.
- starting_secondary_meter_interval float
The starting secondary meter interval for this Service Reminder.
- starting_time_interval integer
The starting time interval according to
starting_time_frequency
for time-based Service Reminders, if applicable. - starting_time_frequency string
Possible values: [
days
,weeks
,months
,years
] - snooze_until date-time
The date and time until which the Service Reminder will be snoozed. We recommend using ISO-8601 formatted dates to avoid ambiguity.
- user_ids integer[]
Possible values:
>= 1
The IDs of any
Users
associated with the Service Reminder. - watcher_user_ids integer[]
Possible values:
>= 1
The IDs of any
Users
to watch the Service Reminder. comments_attributes object[]
title stringThe title of the comment.
comment stringThe comment text.
- 201
- 401
- 403
- 422
- 500
OK
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
- id integer
Possible values:
>= 1
- created_at date-time
The date and time at which this record was created.
- updated_at date-time
The date and time at which this record was most recently updated.
- active boolean
Indicates whether the Service Reminder is currently active.
- vehicle_id integer
Possible values:
>= 1
- service_task_id NullableId
Possible values:
>= 1
- service_task_name string
The name of the
Service Task
associated with the Service Reminder, if applicable. - time_interval integer
The number of time units according to
time_frequency
between each occurrence of the Service Reminder. - time_frequency string
Possible values: [
day
,week
,month
,year
,days
,weeks
,months
,years
] - next_due_at date-time
The date and time when the Service Reminder is next due. Formatted according to ISO-8601 in
User
's local time. - due_soon_at date-time
The date and time when the Service Reminder will be considered due soon. Formatted according to ISO-8601 in
User
's local time. - due_soon_time_threshold_interval integer
The number of time units according to
due_soon_time_threshold_frequency
betweendue_soon_at
occurrences. - due_soon_time_threshold_frequency string
Possible values: [
day
,week
,month
,year
,days
,weeks
,months
,years
] - vehicle_archived_at date-time
The date and time at which the vehicle associated with the Service Reminder was archived, if applicable.
- forecasted_next_due_at date-time
The forecasted date and time for the next due service.
- forecasted_due_soon_at date-time
The forecasted date and time for the Service Reminder to be due soon.
- comments_count integer
The number of
Comments
on the Service Reminder. - starting_interval boolean
Indicates whether the Service Reminder has a starting interval.
- starting_meter_interval string
The starting meter interval for this Service Reminder.
- starting_secondary_meter_interval string
The starting secondary meter interval for this Service Reminder.
- starting_time_interval integer
The starting time interval according to
starting_time_frequency
for time-based Service Reminders, if applicable. - starting_time_frequency string
Possible values: [
day
,week
,month
,year
,days
,weeks
,months
,years
] - snooze_until date-time
The date and time until which the Service Reminder is snoozed.
- service_reminder_status_name string
The name of the Service Reminder status, if applicable.
- secondary_meter boolean
Indicates whether the Service Reminder is associated with a secondary meter.
- meter_interval string
The meter interval of which this Service Reminder takes place.
- next_due_meter_value string
The meter value at which the Service Reminder is next due, if applicable.
- due_soon_meter_value string
The meter value at which the Service Reminder is due soon, if applicable.
- due_soon_meter_threshold date-time
The meter value threshold to which this Service Reminder will be due soon.
- meter_remaining_until_due integer
The remaining meter units until the Service Reminder is due.
- secondary_meter_remaining_until_due integer
The remaining secondary meter interval until the Service Reminder is due.
- forecasted_primary_due_soon_at date-time
The forecasted date and time for the primary Service Reminder to be due soon.
- forecasted_primary_next_due_at date-time
The forecasted date and time for the next primary due Service Reminder.
- forecasted_secondary_due_soon_at date-time
The forecasted date and time for the secondary Service Reminder to be due soon.
- forecasted_secondary_next_due_at date-time
The forecasted date and time for the next secondary due Service Reminder.
users object[]
A list of
Users
associated with the Service Reminder.id integerPossible values:
>= 1
name string- vehicle_name string
The name of the
Vehicle
associated with the Service Reminder. - vehicle_default_image_url string
The default image URL for the associated vehicle, if available.
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
latest_occurrence object
A Service Entry
id integercreated_at date-timeupdated_at date-timetax_free_labor booleanIndicates whether or not to include labor subtotals in tax calculations.
completed_at date-timeThe date and time at which the Service Entry was completed.
reference stringA reference number for this Service Entry.
started_at date-timeThe date and time at which the Service Entry was started.
status stringPossible values: [
pending
,completed
]The status of this Service Entry.
custom_fields object*Full details on working with Custom Fields here.
general_notes stringGeneral notes for this Service Entry.
vehicle_id integerPossible values:
>= 1
vehicle_name stringThe name of the
Vehicle
associated with this Service Entry.vendor_id NullableIdPossible values:
>= 1
vendor_name stringThe name of the
Vendor
associated with this Service Entry.work_order_id NullableIdPossible values:
>= 1
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
is_sample booleanIndicates whether or not this Service Entry is a sample. Sample Service Entries are not included in reports.
work_order_number integerThe number of the
Work Order
this Service Entry is associated with.date date-timeThe date of this Service Entry. Formatted according to ISO-8601 in User's local time.
service_entry_line_items object[]
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
description stringA description of the service performed for this line item.
type stringPossible values: [
ServiceEntryServiceTaskLineItem
,ServiceEntryLaborLineItem
,ServiceEntryPartLineItem
,ServiceEntryTaxLineItem
,ServiceEntryFeeLineItem
,ServiceEntryTireLineItem
,ServiceEntryFreeTextLineItem
]Denotes the type of the ServiceEntryLineItem
service_entry_line_item_id integerFor nested line items. This value denotes the parent
Service Entry Line Item
.service_reminder_id integerIf this line item is linked to a Service Reminder, this ID will be set.
service_task object
A Service Task
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
name stringPossible values:
<= 255 characters
A name for this Service Task.
description stringA description of this Service Task.
expected_duration_in_seconds integerThe expected duration in seconds this Service Task should take to complete.
archived_at date-timeThe date and time at which this Service Task was archived.
null
if this Service Task is active.subtasks object[]
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
name stringThe name of this subtask.
description stringA description of this subtask.
expected_duration_in_seconds integerThe expected duration in seconds this subtask should take to complete.
subtasks arrayThe subtasks array at this level will always be empty.
default_vmrs_reason_for_repair object
account_id integeralias stringcode stringenabled booleanid integername stringrepair_type stringstandard booleanstandard_name stringtype stringvmrs_standard_reason_for_repair objectdefault_vmrs_system_group object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_system object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_assembly object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_component object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectusage integerIndicates the number of times this Service Task has been used. Available by setting the
include_usage
query parameter to1
.default_vmrs_reason_for_repair object
account_id integeralias stringcode stringenabled booleanid integername stringrepair_type stringstandard booleanstandard_name stringtype stringvmrs_standard_reason_for_repair objectdefault_vmrs_system_group object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_system object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_assembly object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_component object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectservice_task_parts object[]
Any
Parts
associated with this Service Task. Available by setting theexpand[]
query parameter toservice_task_parts
.id integerquantity floatThe quantity of this
Part
related to the Service Task.part_id integerThe ID of this
Part
related to the Service Task.part_archived_at date-timeThe date and time at which the
Part
related to the Service Task was archived, if applicable.position integerThe position of this
Part
in the list of Service Task Parts.issues object[]
Any
Issues
this line item is linked to.id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
number stringA unique identifier for the Issue.
name stringThe name of the Issue.
summary stringA summary of the Issue.
description stringA longer description of the Issue.
state stringPossible values: [
Open
,Closed
,Resolved
]The Issue's current state.
reported_at date-timeThe date and time at which the issue was reported.
reported_by_id NullableIdPossible values:
>= 1
reported_by_name stringThe name of the Contact associated with the User who reported this Issue.
fault_id NullableIdPossible values:
>= 1
due_date dateThe date on which this Issue should be resolved by. Formatted according to ISO-8601 in
User
's local time zone.due_meter_value stringThe meter value at which this Issue should be resolved by.
due_secondary_meter_value floatThe secondary meter value at which this Issue should be resolved by.
overdue booleanIndicates whether the Issue is overdue.
vehicle_id integerPossible values:
>= 1
vehicle_name stringThe name of the Vehicle associated with this Issue.
is_sample booleanIndicates whether this Issue is sample data.
created_by_workflow booleanIndicates whether this Issue was created by a workflow.
submitted_inspection_form_id NullableIdPossible values:
>= 1
custom_fields object*Full details on working with Custom Fields here.
valid_required_custom_fields booleandtc_alert_id NullableIdPossible values:
>= 1
assigned_contacts object[]
An array of assigned Contacts related to the Issue.
id integercreated_at date-timeupdated_at date-timeemail stringThe Contact's email address.
name stringThe Contact's full name.
first_name stringThe Contact's first name.
middle_name stringThe Contact's middle name.
last_name stringThe Contact's last name.
images_count integerThe number of images associated with this Contact.
documents_count integerThe number of documents associated with this Contact.
comments_count integerThe number of comments associated with this Contact.
group_id integerIf this Contact belongs to a Group, this will be the Fleetio ID of that
Group
.group_name stringIf this Contact belongs to a Group, this will be the
Group
's name.group_hierarchy stringIf this Contact belongs to a Group, this will be a pipe delimited string representing the
Group
hierarchy. EachGroup
in the list is the parent of theGroups
which follow.technician booleanWhether or not the Contact is a Technician.
vehicle_operator booleanWhether or not the Contact is a Vehicle Operator.
employee booleanWhether or not the Contact is an Employee.
birth_date dateThe Contact's birth date.
street_address stringThe Contact's street address.
street_address_line_2 stringThe Contact's street address line 2.
city stringThe Contact's city.
region stringThe Contact's region, state, or province.
postal_code stringThe Contact's postal code, zip code, or equivalent.
country stringThe Contact's country.
employee_number stringThe Contact's employee number.
job_title stringPossible values:
<= 255 characters
The Contact's job title.
license_class stringThe Contact's driver's license class.
license_number stringThe Contact's driver's license number.
license_state stringThe locality which issued the Contact's license.
license_expiration dateThe Contact's driver's license expiration date.
home_phone_number stringThe Contact's home phone number.
mobile_phone_number stringThe Contact's mobile phone number.
work_phone_number stringThe Contact's work phone number.
other_phone_number stringAny other phone number for this Contact.
start_date dateWhen the Contact started working for the company, if applicable.
leave_date dateWhen the Contact left or will leave the company, if applicable.
hourly_labor_rate floatThe Contact's hourly rate.
custom_fields object*Full details on working with Custom Fields here.
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_url stringThe URL of the Contact's default image/profile photo, if any.
user objectIf the Contact is a Fleetio
User
, those details will be included here.account_membership_id NullableIdPossible values:
>= 1
labels object[]
id integerPossible values:
>= 1
name stringattachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
is_watched booleanDefault value:
false
Indicates whether the Issue is watched.
vehicle_image_url stringThe URL to the image of the Vehicle associated with the Issue.
vehicle_image_url_medium stringThe URL to a medium-sized Vehicle image associated with the Issue.
vehicle_image_url_small stringThe URL to a small-sized Vehicle image associated with the Issue.
vehicle_image_url_large stringThe URL to a large-sized Vehicle image associated with the Issue.
watchers_count integerThe count of watchers related to the Issue.
linked_work_orders object[]
Summative information of linked Work Orders related to the Issue.
id integerPossible values:
>= 1
number integerThe Work Order number.
issued_at date-timeThe date and time at which the Work Order was issued.
source object
Inspection source information.
inspection_form object
id NullableIdPossible values:
>= 1
color stringtitle stringinspection_submissions_count integerThe count of inspection submissions related to the Issue.
last_inspection_submission_at date-timeThe date and time of the last inspection submission related to the Issue.
failed_inspection_item_label stringThe label associated with a failed inspection item.
comments object[]
A list of the comments made on this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
commentable_type CommentableTypePossible values: [
Contact
,FleetcorCard
,FuelEntry
,InventoryJournalEntry
,Issue
,Part
,PurchaseOrder
,ServiceEntry
,ServiceReminder
,SubmittedInspectionItem
,Vehicle
,VehicleAssignment
,Vendor
,WexCard
,WorkOrder
]The type of record that the Comment will be left on. Must be associated with a matching
commentable_id
.commentable_id integerPossible values:
>= 1
user_id integerPossible values:
>= 1
title string deprecatedThe title of the Comment.
comment stringThe content of the Comment message body.
user_full_name stringThe full name of the
User
who created the Comment.user_image_url stringThe image url for the
User
who created the Comment.rich_content objecthtml_content stringThe comment message body rendered as HTML.
with_mentions booleanIndicates if the message body contains @mentions.
comments_count integerThe number of comments made on this record.
documents object[]
A list of the documents attached to this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
documentable_id integerPossible values:
>= 1
documentable_type DocumentableTypePossible values: [
ServiceEntry
,FuelEntry
,Issue
,WorkOrder
,ExpenseEntry
]file_name stringThe name of the file.
file_mime_type stringThe MIME type of the file.
file_size numberThe size of the file in bytes.
file_url stringThe URL to access the file.
full_file_url stringThe full URL to access the file, including any necessary authentication or parameters.
documents_count integerThe number of documents attached to this record.
images object[]
A list of the images attached to this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
imageable_id integerPossible values:
>= 1
imageable_type ImageableTypePossible values: [
ExpenseEntry
,WorkOrder
,Equipment
,IssueResolution
,ServiceEntry
,Vendor
,ServiceProgram
,Issue
,Contact
,Part
,Vehicle
,FuelEntry
,SubmittedInspectionItem
]file_name stringThe name of the image file.
file_mime_type Image MIME TypePossible values: [
image/jpeg
,image/gif
,image/jif
,image/jfif
,image/jfi
,image/tiff
,image/png
,image/jpg
,image/jpe
,image/pdf
,image/webp
,image/tif
,image/psd
,image/raw
,image/arw
,image/cr2
,image/nrw
,image/k25
,image/bmp
,image/dip
,image/ai
,image/eps
,image/heif
,image/heic
,image/ind
,image/indd
,image/indt
,image/jp2
,image/j2k
,image/jpf
,image/jpx
,image/jpm
,image/mj2
,image/x-png
]file_size numberThe size of the image file in bytes.
file_url stringThe URL to access the image file.
full_url stringThe full URL to access the image file, including any necessary authentication or parameters.
images_count integerThe number of images attached to this record.
labor_cost floatThe total cost of labor for this line item.
parts_cost floatThe total cost of parts for this line item.
subtotal floatThe pre-tax cost of this line item.
vmrs_reason_for_repair object
account_id integeralias stringcode stringenabled booleanid integername stringrepair_type stringstandard booleanstandard_name stringtype stringvmrs_standard_reason_for_repair objectvmrs_system_group object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectvmrs_system object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectvmrs_assembly object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectvmrs_component object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectservice_tasks object[]
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
name stringPossible values:
<= 255 characters
A name for this Service Task.
description stringA description of this Service Task.
expected_duration_in_seconds integerThe expected duration in seconds this Service Task should take to complete.
archived_at date-timeThe date and time at which this Service Task was archived.
null
if this Service Task is active.subtasks object[]
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
name stringThe name of this subtask.
description stringA description of this subtask.
expected_duration_in_seconds integerThe expected duration in seconds this subtask should take to complete.
subtasks arrayThe subtasks array at this level will always be empty.
default_vmrs_reason_for_repair object
account_id integeralias stringcode stringenabled booleanid integername stringrepair_type stringstandard booleanstandard_name stringtype stringvmrs_standard_reason_for_repair objectdefault_vmrs_system_group object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_system object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_assembly object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_component object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectusage integerIndicates the number of times this Service Task has been used. Available by setting the
include_usage
query parameter to1
.default_vmrs_reason_for_repair object
account_id integeralias stringcode stringenabled booleanid integername stringrepair_type stringstandard booleanstandard_name stringtype stringvmrs_standard_reason_for_repair objectdefault_vmrs_system_group object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_system object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_assembly object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectdefault_vmrs_component object
account_id numberassembly_code stringassembly_name stringcode_type stringPossible values: [
system_group
,system
,assembly
,component
]component_code stringcomponent_name stringenabled booleanid integerpermissions object
destroy booleanstandard booleansystem_code stringsystem_group stringsystem_group_code stringsystem_name stringtype stringvmrs_standard_system_assembly_component objectservice_task_parts object[]
Any
Parts
associated with this Service Task. Available by setting theexpand[]
query parameter toservice_task_parts
.id integerquantity floatThe quantity of this
Part
related to the Service Task.part_id integerThe ID of this
Part
related to the Service Task.part_archived_at date-timeThe date and time at which the
Part
related to the Service Task was archived, if applicable.position integerThe position of this
Part
in the list of Service Task Parts.issues object[]
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
number stringA unique identifier for the Issue.
name stringThe name of the Issue.
summary stringA summary of the Issue.
description stringA longer description of the Issue.
state stringPossible values: [
Open
,Closed
,Resolved
]The Issue's current state.
reported_at date-timeThe date and time at which the issue was reported.
reported_by_id NullableIdPossible values:
>= 1
reported_by_name stringThe name of the Contact associated with the User who reported this Issue.
fault_id NullableIdPossible values:
>= 1
due_date dateThe date on which this Issue should be resolved by. Formatted according to ISO-8601 in
User
's local time zone.due_meter_value stringThe meter value at which this Issue should be resolved by.
due_secondary_meter_value floatThe secondary meter value at which this Issue should be resolved by.
overdue booleanIndicates whether the Issue is overdue.
vehicle_id integerPossible values:
>= 1
vehicle_name stringThe name of the Vehicle associated with this Issue.
is_sample booleanIndicates whether this Issue is sample data.
created_by_workflow booleanIndicates whether this Issue was created by a workflow.
submitted_inspection_form_id NullableIdPossible values:
>= 1
custom_fields object*Full details on working with Custom Fields here.
valid_required_custom_fields booleandtc_alert_id NullableIdPossible values:
>= 1
assigned_contacts object[]
An array of assigned Contacts related to the Issue.
id integercreated_at date-timeupdated_at date-timeemail stringThe Contact's email address.
name stringThe Contact's full name.
first_name stringThe Contact's first name.
middle_name stringThe Contact's middle name.
last_name stringThe Contact's last name.
images_count integerThe number of images associated with this Contact.
documents_count integerThe number of documents associated with this Contact.
comments_count integerThe number of comments associated with this Contact.
group_id integerIf this Contact belongs to a Group, this will be the Fleetio ID of that
Group
.group_name stringIf this Contact belongs to a Group, this will be the
Group
's name.group_hierarchy stringIf this Contact belongs to a Group, this will be a pipe delimited string representing the
Group
hierarchy. EachGroup
in the list is the parent of theGroups
which follow.technician booleanWhether or not the Contact is a Technician.
vehicle_operator booleanWhether or not the Contact is a Vehicle Operator.
employee booleanWhether or not the Contact is an Employee.
birth_date dateThe Contact's birth date.
street_address stringThe Contact's street address.
street_address_line_2 stringThe Contact's street address line 2.
city stringThe Contact's city.
region stringThe Contact's region, state, or province.
postal_code stringThe Contact's postal code, zip code, or equivalent.
country stringThe Contact's country.
employee_number stringThe Contact's employee number.
job_title stringPossible values:
<= 255 characters
The Contact's job title.
license_class stringThe Contact's driver's license class.
license_number stringThe Contact's driver's license number.
license_state stringThe locality which issued the Contact's license.
license_expiration dateThe Contact's driver's license expiration date.
home_phone_number stringThe Contact's home phone number.
mobile_phone_number stringThe Contact's mobile phone number.
work_phone_number stringThe Contact's work phone number.
other_phone_number stringAny other phone number for this Contact.
start_date dateWhen the Contact started working for the company, if applicable.
leave_date dateWhen the Contact left or will leave the company, if applicable.
hourly_labor_rate floatThe Contact's hourly rate.
custom_fields object*Full details on working with Custom Fields here.
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_url stringThe URL of the Contact's default image/profile photo, if any.
user objectIf the Contact is a Fleetio
User
, those details will be included here.account_membership_id NullableIdPossible values:
>= 1
labels object[]
id integerPossible values:
>= 1
name stringattachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
is_watched booleanDefault value:
false
Indicates whether the Issue is watched.
vehicle_image_url stringThe URL to the image of the Vehicle associated with the Issue.
vehicle_image_url_medium stringThe URL to a medium-sized Vehicle image associated with the Issue.
vehicle_image_url_small stringThe URL to a small-sized Vehicle image associated with the Issue.
vehicle_image_url_large stringThe URL to a large-sized Vehicle image associated with the Issue.
watchers_count integerThe count of watchers related to the Issue.
linked_work_orders object[]
Summative information of linked Work Orders related to the Issue.
id integerPossible values:
>= 1
number integerThe Work Order number.
issued_at date-timeThe date and time at which the Work Order was issued.
source object
Inspection source information.
inspection_form object
id NullableIdPossible values:
>= 1
color stringtitle stringinspection_submissions_count integerThe count of inspection submissions related to the Issue.
last_inspection_submission_at date-timeThe date and time of the last inspection submission related to the Issue.
failed_inspection_item_label stringThe label associated with a failed inspection item.
comments object[]
A list of the comments made on this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
commentable_type CommentableTypePossible values: [
Contact
,FleetcorCard
,FuelEntry
,InventoryJournalEntry
,Issue
,Part
,PurchaseOrder
,ServiceEntry
,ServiceReminder
,SubmittedInspectionItem
,Vehicle
,VehicleAssignment
,Vendor
,WexCard
,WorkOrder
]The type of record that the Comment will be left on. Must be associated with a matching
commentable_id
.commentable_id integerPossible values:
>= 1
user_id integerPossible values:
>= 1
title string deprecatedThe title of the Comment.
comment stringThe content of the Comment message body.
user_full_name stringThe full name of the
User
who created the Comment.user_image_url stringThe image url for the
User
who created the Comment.rich_content objecthtml_content stringThe comment message body rendered as HTML.
with_mentions booleanIndicates if the message body contains @mentions.
comments_count integerThe number of comments made on this record.
documents object[]
A list of the documents attached to this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
documentable_id integerPossible values:
>= 1
documentable_type DocumentableTypePossible values: [
ServiceEntry
,FuelEntry
,Issue
,WorkOrder
,ExpenseEntry
]file_name stringThe name of the file.
file_mime_type stringThe MIME type of the file.
file_size numberThe size of the file in bytes.
file_url stringThe URL to access the file.
full_file_url stringThe full URL to access the file, including any necessary authentication or parameters.
documents_count integerThe number of documents attached to this record.
images object[]
A list of the images attached to this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
imageable_id integerPossible values:
>= 1
imageable_type ImageableTypePossible values: [
ExpenseEntry
,WorkOrder
,Equipment
,IssueResolution
,ServiceEntry
,Vendor
,ServiceProgram
,Issue
,Contact
,Part
,Vehicle
,FuelEntry
,SubmittedInspectionItem
]file_name stringThe name of the image file.
file_mime_type Image MIME TypePossible values: [
image/jpeg
,image/gif
,image/jif
,image/jfif
,image/jfi
,image/tiff
,image/png
,image/jpg
,image/jpe
,image/pdf
,image/webp
,image/tif
,image/psd
,image/raw
,image/arw
,image/cr2
,image/nrw
,image/k25
,image/bmp
,image/dip
,image/ai
,image/eps
,image/heif
,image/heic
,image/ind
,image/indd
,image/indt
,image/jp2
,image/j2k
,image/jpf
,image/jpx
,image/jpm
,image/mj2
,image/x-png
]file_size numberThe size of the image file in bytes.
file_url stringThe URL to access the image file.
full_url stringThe full URL to access the image file, including any necessary authentication or parameters.
images_count integerThe number of images attached to this record.
meter_entry object
A Meter Entry
id integercreated_at date-timeupdated_at date-timeauto_voided_at date-timeThe date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in
User
's local time.category stringPossible values: [
starting
,ending
,nightly
,manual
]A category to describe the function of this Meter Entry.
meter_type stringPossible values: [
secondary
]Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableIdPossible values:
>= 1
meterable_type stringPossible values: [
FuelEntry
,Issue
,PurchaseDetail
,ServiceEntry
,SubmittedInspectionItem
,VehicleAssignment
,WorkOrder
]The type of the object with which this Meter Entry is associated.
value stringThe current value of the meter.
vehicle_id NullableIdPossible values:
>= 1
void booleanDefault value:
false
Indicates whether or not this Meter Entry has been voided.
type stringPossible values: [
GpsMeterEntry
]date dateThe date on which this Meter Entry was recorded. Formatted according to ISO-8601.
secondary_meter_entry object
A Meter Entry
id integercreated_at date-timeupdated_at date-timeauto_voided_at date-timeThe date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in
User
's local time.category stringPossible values: [
starting
,ending
,nightly
,manual
]A category to describe the function of this Meter Entry.
meter_type stringPossible values: [
secondary
]Indicates whether or not this Meter is a secondary Meter.
meterable_id NullableIdPossible values:
>= 1
meterable_type stringPossible values: [
FuelEntry
,Issue
,PurchaseDetail
,ServiceEntry
,SubmittedInspectionItem
,VehicleAssignment
,WorkOrder
]The type of the object with which this Meter Entry is associated.
value stringThe current value of the meter.
vehicle_id NullableIdPossible values:
>= 1
void booleanDefault value:
false
Indicates whether or not this Meter Entry has been voided.
type stringPossible values: [
GpsMeterEntry
]date dateThe date on which this Meter Entry was recorded. Formatted according to ISO-8601.
vmrs_repair_priority_class object
The Vehicle Maintenance Reporting Standards (VMRS) Repair Priority Class for this Service Entry.
id integerThe ID of the VMRS Repair Priority Class.
code stringThe code of the VMRS Repair Priority Class.
name stringThe name of the VMRS Repair Priority Class.
color stringThe color of the VMRS Repair Priority Class.
labels object[]
id integerPossible values:
>= 1
name stringauto_integrate_ro_id NullableIdPossible values:
>= 1
auto_integrate_ro_link stringThe Auto Integrate
Repair Order
link for this Service Entry.auto_integrate_repair_order_status stringPossible values: [
approved
,auto_approved
,awaiting_invoice
,awaiting_reconciliation
,completed
,invoiced
,needs_approval
,needs_reapproval
,paid
,rejected
]The Auto Integrate
Repair Order
status for this Service Entry.auto_integrate_repair_order_status_color stringThe color applied to the Auto Integrate
Repair Order
status for this Service Entry.invoice object
An MSI Repair Order Invoice (pass expand[]=invoice in query to include in response)
id integerPossible values:
>= 1
created_at date-timeThe date and time when the Invoice was created.
po_number stringThe PO number for the Invoice.
updated_at date-timeThe date and time when the Invoice was last updated.
discount floatThe discount amount.
discount_type DiscountTypePossible values: [
fixed
,percentage
]Default value:
percentage
The type of discount applied to this record.
discount_percentage floatThe discount percentage. This field should be present when
discount_type
is set topercentage
.fees floatThe fees amount. This is the sum of any
ServiceEntryFeeLineItem
s present.subtotal floatThe pre-tax subtotal amount.
parts_subtotal floatThe pre-tax subtotal amount for parts.
labor_subtotal floatThe pre-tax subtotal amount for labor.
tax_1 floatThe primary tax amount.
tax_1_percentage floatThe primary tax percentage.
tax_1_type stringThe primary tax type.
tax_2 floatThe secondary tax amount.
tax_2_percentage floatThe secondary tax percentage.
tax_2_type stringThe secondary tax type.
total_amount floatThe total amount.
comments object[]
A list of the comments made on this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
commentable_type CommentableTypePossible values: [
Contact
,FleetcorCard
,FuelEntry
,InventoryJournalEntry
,Issue
,Part
,PurchaseOrder
,ServiceEntry
,ServiceReminder
,SubmittedInspectionItem
,Vehicle
,VehicleAssignment
,Vendor
,WexCard
,WorkOrder
]The type of record that the Comment will be left on. Must be associated with a matching
commentable_id
.commentable_id integerPossible values:
>= 1
user_id integerPossible values:
>= 1
title string deprecatedThe title of the Comment.
comment stringThe content of the Comment message body.
user_full_name stringThe full name of the
User
who created the Comment.user_image_url stringThe image url for the
User
who created the Comment.rich_content objecthtml_content stringThe comment message body rendered as HTML.
with_mentions booleanIndicates if the message body contains @mentions.
comments_count integerThe number of comments made on this record.
labor_time_in_seconds integerThe sum, in seconds, of the duration of all labor line items of the Work Order that created this Service Entry, if applicable. This field is only relevant when the Service Entry is created from a Work Order.
documents object[]
A list of the documents attached to this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
documentable_id integerPossible values:
>= 1
documentable_type DocumentableTypePossible values: [
ServiceEntry
,FuelEntry
,Issue
,WorkOrder
,ExpenseEntry
]file_name stringThe name of the file.
file_mime_type stringThe MIME type of the file.
file_size numberThe size of the file in bytes.
file_url stringThe URL to access the file.
full_file_url stringThe full URL to access the file, including any necessary authentication or parameters.
documents_count integerThe number of documents attached to this record.
images object[]
A list of the images attached to this record.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
imageable_id integerPossible values:
>= 1
imageable_type ImageableTypePossible values: [
ExpenseEntry
,WorkOrder
,Equipment
,IssueResolution
,ServiceEntry
,Vendor
,ServiceProgram
,Issue
,Contact
,Part
,Vehicle
,FuelEntry
,SubmittedInspectionItem
]file_name stringThe name of the image file.
file_mime_type Image MIME TypePossible values: [
image/jpeg
,image/gif
,image/jif
,image/jfif
,image/jfi
,image/tiff
,image/png
,image/jpg
,image/jpe
,image/pdf
,image/webp
,image/tif
,image/psd
,image/raw
,image/arw
,image/cr2
,image/nrw
,image/k25
,image/bmp
,image/dip
,image/ai
,image/eps
,image/heif
,image/heic
,image/ind
,image/indd
,image/indt
,image/jp2
,image/j2k
,image/jpf
,image/jpx
,image/jpm
,image/mj2
,image/x-png
]file_size numberThe size of the image file in bytes.
file_url stringThe URL to access the image file.
full_url stringThe full URL to access the image file, including any necessary authentication or parameters.
images_count integerThe number of images attached to this record.
service_program_line_item object
id integercreated_at date-timeupdated_at date-timetime_interval integerThe number of time units according to
time_frequency
between each occurrence of theService Task
(s) of this Service Program line item.time_frequency stringPossible values: [
day
,week
,month
,year
,days
,weeks
,months
,years
]meter_interval floatThe meter interval of which this Service Program line item takes place.
secondary_meter_interval floatThe secondary meter interval of which this Service Program line item takes place.
due_soon_time_threshold_interval integerThe number of time units according to
due_soon_time_threshold_frequency
betweendue_soon_at
occurrences.due_soon_time_threshold_frequency stringPossible values: [
day
,week
,month
,year
,days
,weeks
,months
,years
]due_soon_meter_threshold floatThe meter value threshold to which this Service Program line item will be due soon.
due_soon_secondary_meter_threshold floatThe secondary meter value threshold to which this Service Program line item will be due soon.
service_tasks object[]
Any
Service Tasks
associated with this Service Program line item.id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
name stringThe name of this Service Task.
description stringA description of this Service Task.
expected_duration_in_seconds integerThe expected time to complete this Service Task in seconds.
subtasks arrayThe subtasks array within a parent subtasks array will always be empty.
default_vmrs_reason_for_repair object
id integerPossible values:
>= 1
code stringThe VMRS code for this reason for repair.
name stringThe name of this reason for repair.
repair_type stringThe repair type of this reason for repair.
enabled booleanWhether or not this reason for repair is enabled.
default_vmrs_system_group object
id integerPossible values:
>= 1
system_group_code stringThe system group code of this system group.
system_group_name stringThe name of this system group.
system_code stringThe system code of this system group.
system_name stringThe name of this system.
assembly_code stringThe assembly code of this system group.
assembly_name stringThe assembly name related to this system group.
component_code stringThe component code of this system group.
component_name stringThe component name related to this system group.
enabled booleanWhether or not this system group is enabled.
default_vmrs_system object
id integerPossible values:
>= 1
system_group_code stringThe system group code of the default VMRS system.
system_group_name stringThe name of the default VMRS system group.
system_code stringThe system code of the default VMRS system.
system_name stringThe name of the default VMRS system.
assembly_code stringThe assembly code of the default VMRS system.
assembly_name stringThe name of the default VMRS assembly.
component_code stringThe component code of the default VMRS system.
component_name stringThe name of the default VMRS component.
enabled booleanWhether or not the default VMRS system is enabled.
default_vmrs_assembly object
id integerPossible values:
>= 1
system_group_code stringThe system group code of the default VMRS assembly.
system_group_name stringThe name of the default VMRS system group.
system_code stringThe system code of the default VMRS assembly.
system_name stringThe name of the default VMRS system.
assembly_code stringThe assembly code of the default VMRS assembly.
assembly_name stringThe name of the default VMRS assembly.
component_code stringThe component code of the default VMRS assembly.
component_name stringThe name of the default VMRS component.
enabled booleanWhether or not the default VMRS assembly is enabled.
default_vmrs_component object
id integerPossible values:
>= 1
system_group_code stringThe system group code of the default VMRS component.
system_group_name stringThe name of the default VMRS system group.
system_code stringThe system code of the default VMRS component.
system_name stringThe name of the default VMRS system.
assembly_code stringThe assembly code of the default VMRS component.
assembly_name stringThe name of the default VMRS assembly.
component_code stringThe component code of the default VMRS component.
component_name stringThe name of the default VMRS component.
service_program object
Basic information about the parent Service Program.
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
nameThe name of the Service Program.
comments object[]
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
commentable_type CommentableTypePossible values: [
Contact
,FleetcorCard
,FuelEntry
,InventoryJournalEntry
,Issue
,Part
,PurchaseOrder
,ServiceEntry
,ServiceReminder
,SubmittedInspectionItem
,Vehicle
,VehicleAssignment
,Vendor
,WexCard
,WorkOrder
]The type of record that the Comment will be left on. Must be associated with a matching
commentable_id
.commentable_id integerPossible values:
>= 1
user_id integerPossible values:
>= 1
title string deprecatedThe title of the Comment.
comment stringThe content of the Comment message body.
user_full_name stringThe full name of the
User
who created the Comment.user_image_url stringThe image url for the
User
who created the Comment.rich_content objecthtml_content stringThe comment message body rendered as HTML.
with_mentions booleanIndicates if the message body contains @mentions.
- watchers_count integer
The count of watchers associated with the record.
- is_watched boolean
Indicates whether the record is being watched.
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"active": true,
"vehicle_id": 0,
"service_task_id": 0,
"service_task_name": "string",
"time_interval": 0,
"time_frequency": "day",
"next_due_at": "2023-03-14T13:46:27-06:00",
"due_soon_at": "2023-03-14T13:46:27-06:00",
"due_soon_time_threshold_interval": 0,
"due_soon_time_threshold_frequency": "day",
"vehicle_archived_at": "2023-03-14T13:46:27-06:00",
"forecasted_next_due_at": "2023-03-14T13:46:27-06:00",
"forecasted_due_soon_at": "2023-03-14T13:46:27-06:00",
"comments_count": 0,
"starting_interval": true,
"starting_meter_interval": "string",
"starting_secondary_meter_interval": "string",
"starting_time_interval": 0,
"starting_time_frequency": "day",
"snooze_until": "2023-03-14T13:46:27-06:00",
"service_reminder_status_name": "string",
"secondary_meter": true,
"meter_interval": "string",
"next_due_meter_value": "string",
"due_soon_meter_value": "string",
"due_soon_meter_threshold": "2023-03-14T13:46:27-06:00",
"meter_remaining_until_due": 0,
"secondary_meter_remaining_until_due": 0,
"forecasted_primary_due_soon_at": "2023-03-14T13:46:27-06:00",
"forecasted_primary_next_due_at": "2023-03-14T13:46:27-06:00",
"forecasted_secondary_due_soon_at": "2023-03-14T13:46:27-06:00",
"forecasted_secondary_next_due_at": "2023-03-14T13:46:27-06:00",
"users": [
{
"id": 0,
"name": "string"
}
],
"vehicle_name": "string",
"vehicle_default_image_url": "string",
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"latest_occurrence": {
"id": 0,
"created_at": "2024-10-07",
"updated_at": "2024-10-07",
"tax_free_labor": true,
"completed_at": "2023-03-14T13:46:27-06:00",
"reference": "string",
"started_at": "2023-03-14T13:46:27-06:00",
"status": "pending",
"custom_fields": {},
"general_notes": "string",
"vehicle_id": 0,
"vehicle_name": "string",
"vendor_id": 0,
"vendor_name": "string",
"work_order_id": 0,
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"is_sample": true,
"work_order_number": 0,
"date": "2023-03-14T13:46:27-06:00",
"service_entry_line_items": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"description": "string",
"type": "ServiceEntryServiceTaskLineItem",
"service_entry_line_item_id": 0,
"service_reminder_id": 0,
"service_task": {
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"name": "string",
"description": "string",
"expected_duration_in_seconds": 0,
"archived_at": "2024-10-07",
"subtasks": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"name": "string",
"description": "string",
"expected_duration_in_seconds": 0,
"subtasks": [
null
],
"default_vmrs_reason_for_repair": {
"account_id": 0,
"alias": "string",
"code": "string",
"enabled": true,
"id": 0,
"name": "string",
"repair_type": "string",
"standard": true,
"standard_name": "string",
"type": "string",
"vmrs_standard_reason_for_repair": {}
},
"default_vmrs_system_group": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"default_vmrs_system": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"default_vmrs_assembly": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"default_vmrs_component": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
}
}
],
"usage": 0,
"default_vmrs_reason_for_repair": {
"account_id": 0,
"alias": "string",
"code": "string",
"enabled": true,
"id": 0,
"name": "string",
"repair_type": "string",
"standard": true,
"standard_name": "string",
"type": "string",
"vmrs_standard_reason_for_repair": {}
},
"default_vmrs_system_group": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"default_vmrs_system": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"default_vmrs_assembly": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"default_vmrs_component": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"service_task_parts": [
{
"id": 0,
"quantity": 0,
"part_id": 0,
"part_archived_at": "2024-10-07",
"position": 0
}
]
},
"issues": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"number": "string",
"name": "string",
"summary": "string",
"description": "string",
"state": "Open",
"reported_at": "2023-03-14T13:46:27-06:00",
"reported_by_id": 0,
"reported_by_name": "string",
"fault_id": 0,
"due_date": "2023-03-14",
"due_meter_value": "string",
"due_secondary_meter_value": 0,
"overdue": true,
"vehicle_id": 0,
"vehicle_name": "string",
"is_sample": true,
"created_by_workflow": true,
"submitted_inspection_form_id": 0,
"custom_fields": {},
"valid_required_custom_fields": true,
"dtc_alert_id": 0,
"assigned_contacts": [
{
"id": 0,
"created_at": "2024-10-07",
"updated_at": "2024-10-07",
"email": "string",
"name": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"images_count": 0,
"documents_count": 0,
"comments_count": 0,
"group_id": 0,
"group_name": "string",
"group_hierarchy": "Group 1|Group 2|Group 3",
"technician": true,
"vehicle_operator": true,
"employee": true,
"birth_date": "2023-03-14",
"street_address": "123 Main St",
"street_address_line_2": "Apt 1",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string",
"employee_number": "string",
"job_title": "string",
"license_class": "string",
"license_number": "string",
"license_state": "string",
"license_expiration": "2023-03-14",
"home_phone_number": "string",
"mobile_phone_number": "string",
"work_phone_number": "string",
"other_phone_number": "string",
"start_date": "2024-10-07",
"leave_date": "2024-10-07",
"hourly_labor_rate": 0,
"custom_fields": {},
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"default_image_url": "string",
"user": {},
"account_membership_id": 0
}
],
"labels": [
{
"id": 0,
"name": "string"
}
],
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"is_watched": false,
"vehicle_image_url": "string",
"vehicle_image_url_medium": "string",
"vehicle_image_url_small": "string",
"vehicle_image_url_large": "string",
"watchers_count": 0,
"linked_work_orders": [
{
"id": 0,
"number": 0,
"issued_at": "2024-10-07"
}
],
"source": {
"inspection_form": {
"id": 0,
"color": "string",
"title": "string"
},
"inspection_submissions_count": 0,
"last_inspection_submission_at": "2024-10-07",
"failed_inspection_item_label": "string"
},
"comments": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"commentable_type": "Contact",
"commentable_id": 0,
"user_id": 0,
"comment": "string",
"user_full_name": "string",
"user_image_url": "string",
"rich_content": {},
"html_content": "string",
"with_mentions": true
}
],
"comments_count": 0,
"documents": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"documentable_id": 0,
"documentable_type": "ServiceEntry",
"file_name": "string",
"file_mime_type": "string",
"file_size": 0,
"file_url": "string",
"full_file_url": "string"
}
],
"documents_count": 0,
"images": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"imageable_id": 0,
"imageable_type": "ExpenseEntry",
"file_name": "string",
"file_mime_type": "image/jpeg",
"file_size": 0,
"file_url": "string",
"full_url": "string"
}
],
"images_count": 0
}
],
"labor_cost": 0,
"parts_cost": 0,
"subtotal": 0,
"vmrs_reason_for_repair": {
"account_id": 0,
"alias": "string",
"code": "string",
"enabled": true,
"id": 0,
"name": "string",
"repair_type": "string",
"standard": true,
"standard_name": "string",
"type": "string",
"vmrs_standard_reason_for_repair": {}
},
"vmrs_system_group": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"vmrs_system": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"vmrs_assembly": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"vmrs_component": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
}
}
],
"service_tasks": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"name": "string",
"description": "string",
"expected_duration_in_seconds": 0,
"archived_at": "2024-10-07",
"subtasks": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"name": "string",
"description": "string",
"expected_duration_in_seconds": 0,
"subtasks": [
null
],
"default_vmrs_reason_for_repair": {
"account_id": 0,
"alias": "string",
"code": "string",
"enabled": true,
"id": 0,
"name": "string",
"repair_type": "string",
"standard": true,
"standard_name": "string",
"type": "string",
"vmrs_standard_reason_for_repair": {}
},
"default_vmrs_system_group": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"default_vmrs_system": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"default_vmrs_assembly": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"default_vmrs_component": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
}
}
],
"usage": 0,
"default_vmrs_reason_for_repair": {
"account_id": 0,
"alias": "string",
"code": "string",
"enabled": true,
"id": 0,
"name": "string",
"repair_type": "string",
"standard": true,
"standard_name": "string",
"type": "string",
"vmrs_standard_reason_for_repair": {}
},
"default_vmrs_system_group": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"default_vmrs_system": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"default_vmrs_assembly": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"default_vmrs_component": {
"account_id": 0,
"assembly_code": "string",
"assembly_name": "string",
"code_type": "system_group",
"component_code": "string",
"component_name": "string",
"enabled": true,
"id": 0,
"permissions": {
"destroy": true
},
"standard": true,
"system_code": "string",
"system_group": "string",
"system_group_code": "string",
"system_name": "string",
"type": "string",
"vmrs_standard_system_assembly_component": {}
},
"service_task_parts": [
{
"id": 0,
"quantity": 0,
"part_id": 0,
"part_archived_at": "2024-10-07",
"position": 0
}
]
}
],
"issues": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"number": "string",
"name": "string",
"summary": "string",
"description": "string",
"state": "Open",
"reported_at": "2023-03-14T13:46:27-06:00",
"reported_by_id": 0,
"reported_by_name": "string",
"fault_id": 0,
"due_date": "2023-03-14",
"due_meter_value": "string",
"due_secondary_meter_value": 0,
"overdue": true,
"vehicle_id": 0,
"vehicle_name": "string",
"is_sample": true,
"created_by_workflow": true,
"submitted_inspection_form_id": 0,
"custom_fields": {},
"valid_required_custom_fields": true,
"dtc_alert_id": 0,
"assigned_contacts": [
{
"id": 0,
"created_at": "2024-10-07",
"updated_at": "2024-10-07",
"email": "string",
"name": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"images_count": 0,
"documents_count": 0,
"comments_count": 0,
"group_id": 0,
"group_name": "string",
"group_hierarchy": "Group 1|Group 2|Group 3",
"technician": true,
"vehicle_operator": true,
"employee": true,
"birth_date": "2023-03-14",
"street_address": "123 Main St",
"street_address_line_2": "Apt 1",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string",
"employee_number": "string",
"job_title": "string",
"license_class": "string",
"license_number": "string",
"license_state": "string",
"license_expiration": "2023-03-14",
"home_phone_number": "string",
"mobile_phone_number": "string",
"work_phone_number": "string",
"other_phone_number": "string",
"start_date": "2024-10-07",
"leave_date": "2024-10-07",
"hourly_labor_rate": 0,
"custom_fields": {},
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"default_image_url": "string",
"user": {},
"account_membership_id": 0
}
],
"labels": [
{
"id": 0,
"name": "string"
}
],
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"is_watched": false,
"vehicle_image_url": "string",
"vehicle_image_url_medium": "string",
"vehicle_image_url_small": "string",
"vehicle_image_url_large": "string",
"watchers_count": 0,
"linked_work_orders": [
{
"id": 0,
"number": 0,
"issued_at": "2024-10-07"
}
],
"source": {
"inspection_form": {
"id": 0,
"color": "string",
"title": "string"
},
"inspection_submissions_count": 0,
"last_inspection_submission_at": "2024-10-07",
"failed_inspection_item_label": "string"
},
"comments": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"commentable_type": "Contact",
"commentable_id": 0,
"user_id": 0,
"comment": "string",
"user_full_name": "string",
"user_image_url": "string",
"rich_content": {},
"html_content": "string",
"with_mentions": true
}
],
"comments_count": 0,
"documents": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"documentable_id": 0,
"documentable_type": "ServiceEntry",
"file_name": "string",
"file_mime_type": "string",
"file_size": 0,
"file_url": "string",
"full_file_url": "string"
}
],
"documents_count": 0,
"images": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"imageable_id": 0,
"imageable_type": "ExpenseEntry",
"file_name": "string",
"file_mime_type": "image/jpeg",
"file_size": 0,
"file_url": "string",
"full_url": "string"
}
],
"images_count": 0
}
],
"meter_entry": {
"id": 0,
"created_at": "2024-10-07",
"updated_at": "2024-10-07",
"auto_voided_at": "2023-03-14T13:46:27-06:00",
"category": "starting",
"meter_type": "secondary",
"meterable_id": 0,
"meterable_type": "FuelEntry",
"value": "string",
"vehicle_id": 0,
"void": false,
"type": "GpsMeterEntry",
"date": "2023-03-14"
},
"secondary_meter_entry": {
"id": 0,
"created_at": "2024-10-07",
"updated_at": "2024-10-07",
"auto_voided_at": "2023-03-14T13:46:27-06:00",
"category": "starting",
"meter_type": "secondary",
"meterable_id": 0,
"meterable_type": "FuelEntry",
"value": "string",
"vehicle_id": 0,
"void": false,
"type": "GpsMeterEntry",
"date": "2023-03-14"
},
"vmrs_repair_priority_class": {
"id": 0,
"code": "string",
"name": "string",
"color": "string"
},
"labels": [
{
"id": 0,
"name": "string"
}
],
"auto_integrate_ro_id": 0,
"auto_integrate_ro_link": "string",
"auto_integrate_repair_order_status": "approved",
"auto_integrate_repair_order_status_color": "string",
"invoice": {
"id": 0,
"created_at": "2024-10-07",
"po_number": "string",
"updated_at": "2024-10-07"
},
"discount": 0,
"discount_type": "percentage",
"discount_percentage": 0,
"fees": 0,
"subtotal": 0,
"parts_subtotal": 0,
"labor_subtotal": 0,
"tax_1": 0,
"tax_1_percentage": 0,
"tax_1_type": "string",
"tax_2": 0,
"tax_2_percentage": 0,
"tax_2_type": "string",
"total_amount": 0,
"comments": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"commentable_type": "Contact",
"commentable_id": 0,
"user_id": 0,
"comment": "string",
"user_full_name": "string",
"user_image_url": "string",
"rich_content": {},
"html_content": "string",
"with_mentions": true
}
],
"comments_count": 0,
"labor_time_in_seconds": 0,
"documents": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"documentable_id": 0,
"documentable_type": "ServiceEntry",
"file_name": "string",
"file_mime_type": "string",
"file_size": 0,
"file_url": "string",
"full_file_url": "string"
}
],
"documents_count": 0,
"images": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"imageable_id": 0,
"imageable_type": "ExpenseEntry",
"file_name": "string",
"file_mime_type": "image/jpeg",
"file_size": 0,
"file_url": "string",
"full_url": "string"
}
],
"images_count": 0
},
"service_program_line_item": {
"id": 0,
"created_at": "2024-10-07",
"updated_at": "2024-10-07",
"time_interval": 0,
"time_frequency": "day",
"meter_interval": 0,
"secondary_meter_interval": 0,
"due_soon_time_threshold_interval": 0,
"due_soon_time_threshold_frequency": "day",
"due_soon_meter_threshold": 0,
"due_soon_secondary_meter_threshold": 0,
"service_tasks": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"name": "string",
"description": "string",
"expected_duration_in_seconds": 0,
"subtasks": [
null
],
"default_vmrs_reason_for_repair": {
"id": 0,
"code": "string",
"name": "string",
"repair_type": "string",
"enabled": true
},
"default_vmrs_system_group": {
"id": 0,
"system_group_code": "string",
"system_group_name": "string",
"system_code": "string",
"system_name": "string",
"assembly_code": "string",
"assembly_name": "string",
"component_code": "string",
"component_name": "string",
"enabled": true
},
"default_vmrs_system": {
"id": 0,
"system_group_code": "string",
"system_group_name": "string",
"system_code": "string",
"system_name": "string",
"assembly_code": "string",
"assembly_name": "string",
"component_code": "string",
"component_name": "string",
"enabled": true
},
"default_vmrs_assembly": {
"id": 0,
"system_group_code": "string",
"system_group_name": "string",
"system_code": "string",
"system_name": "string",
"assembly_code": "string",
"assembly_name": "string",
"component_code": "string",
"component_name": "string",
"enabled": true
},
"default_vmrs_component": {
"id": 0,
"system_group_code": "string",
"system_group_name": "string",
"system_code": "string",
"system_name": "string",
"assembly_code": "string",
"assembly_name": "string",
"component_code": "string",
"component_name": "string"
}
}
],
"service_program": {
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00"
}
},
"comments": [
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"commentable_type": "Contact",
"commentable_id": 0,
"user_id": 0,
"comment": "string",
"user_full_name": "string",
"user_image_url": "string",
"rich_content": {},
"html_content": "string",
"with_mentions": true
}
],
"watchers_count": 0,
"is_watched": true
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Insufficient permission to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Unprocessable Entity
- application/json
- Schema
- Example (from schema)
- Example
Schema
errors object
typeitems string
{
"errors": {}
}
{
"errors": {
"field1": [
"error1",
"error2"
],
"field2": [
"error3"
]
}
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}