Create Service Reminder

POST https://secure.fleetio.com/api/v1/service_reminders

Creates a new Service Reminder

Request

application/json

Body

service_task_idId (integer)required

Possible values: >= 1

meter_intervalfloatrequired

The meter interval of which this Service Reminder should occur.

secondary_meter_intervalfloat

The secondary meter interval of which this Service Reminder should occur.

secondary_meterboolean

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.

Default value: false

time_intervalinteger

The number of time units according to time_frequency between each occurrence of the Service Reminder.

time_frequencyFrequencyParameter (string)

Possible values: [days, weeks, months, years]

overriddenboolean

Indicates whether the Service Reminder is overridden.

next_due_meter_valuefloat

The meter value at which the Service Reminder is next due, if applicable.

next_due_secondary_meter_valuefloat

The secondary meter value at which the Service Reminder is next due, if applicable.

next_due_atdate-time

We recommend using ISO-8601 formatted dates to avoid ambiguity.

Example: 2023-03-14T13:46:27-06:00

due_soon_meter_thresholdfloat

The meter value threshold to which this Service Reminder will be due soon.

due_soon_secondary_meter_thresholdfloat

The secondary meter value threshold to which this Service Reminder will be due soon.

activeboolean

Indicates whether the Service Reminder is currently active.

due_soon_time_threshold_intervalinteger

The number of time units according to due_soon_time_threshold_frequency between due_soon_at occurrences.

due_soon_time_threshold_frequencyFrequencyParameter (string)

Possible values: [days, weeks, months, years]

vehicle_idId (integer)required

Possible values: >= 1

starting_intervalboolean

Indicates whether the Service Reminder has a starting interval.

starting_meter_intervalfloat

The starting meter interval for this Service Reminder.

starting_secondary_meter_intervalfloat

The starting secondary meter interval for this Service Reminder.

starting_time_intervalinteger

The starting time interval according to starting_time_frequency for time-based Service Reminders, if applicable.

starting_time_frequencyFrequencyParameter (string)

Possible values: [days, weeks, months, years]

snooze_untildate-time

The date and time until which the Service Reminder will be snoozed. We recommend using ISO-8601 formatted dates to avoid ambiguity.

Example: 2023-03-14T13:46:27-06:00

user_idsId (integer)[]

The IDs of any Users associated with the Service Reminder.

Possible values: >= 1

watcher_user_idsId (integer)[]

The IDs of any Users to watch the Service Reminder.

Possible values: >= 1

comments_attributes object[]

Responses

Response Headers

application/json

Schema
Example (auto)

Schema

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

activebooleanrequired

Indicates whether the Service Reminder is currently active.

vehicle_idId (integer)required

Possible values: >= 1

service_task_idNullableId (integer)nullablerequired

Possible values: >= 1

service_task_namestringnullablerequired

The name of the Service Task associated with the Service Reminder, if applicable.

time_intervalintegernullablerequired

The number of time units according to time_frequency between each occurrence of the Service Reminder.

time_frequencyFrequency (string)nullablerequired

Possible values: [day, week, month, year, days, weeks, months, years]

next_due_atdate-timenullablerequired

The date and time when the Service Reminder is next due. Formatted according to ISO-8601 in User's local time.

Example: 2023-03-14T13:46:27-06:00

due_soon_atdate-timenullablerequired

The date and time when the Service Reminder will be considered due soon. Formatted according to ISO-8601 in User's local time.

Example: 2023-03-14T13:46:27-06:00

due_soon_time_threshold_intervalintegernullablerequired

The number of time units according to due_soon_time_threshold_frequency between due_soon_at occurrences.

due_soon_time_threshold_frequencyFrequency (string)nullablerequired

Possible values: [day, week, month, year, days, weeks, months, years]

vehicle_archived_atdate-timenullablerequired

The date and time at which the vehicle associated with the Service Reminder was archived, if applicable.

Example: 2023-03-14T13:46:27-06:00

forecasted_next_due_atdate-timenullablerequired

The forecasted date and time for the next due service.

Example: 2023-03-14T13:46:27-06:00

forecasted_due_soon_atdate-timenullablerequired

The forecasted date and time for the Service Reminder to be due soon.

Example: 2023-03-14T13:46:27-06:00

comments_countintegerrequired

The number of Comments on the Service Reminder.

starting_intervalbooleannullablerequired

Indicates whether the Service Reminder has a starting interval.

starting_meter_intervalstringnullablerequired

The starting meter interval for this Service Reminder.

starting_secondary_meter_intervalstringnullablerequired

The starting secondary meter interval for this Service Reminder.

starting_time_intervalintegernullablerequired

The starting time interval according to starting_time_frequency for time-based Service Reminders, if applicable.

starting_time_frequencyFrequency (string)nullablerequired

Possible values: [day, week, month, year, days, weeks, months, years]

snooze_untildate-timenullablerequired

The date and time until which the Service Reminder is snoozed.

Example: 2023-03-14T13:46:27-06:00

service_reminder_status_namestringnullablerequired

The name of the Service Reminder status, if applicable.

secondary_meterbooleanrequired

Indicates whether the Service Reminder is associated with a secondary meter.

meter_intervalstringnullablerequired

The meter interval of which this Service Reminder takes place.

next_due_meter_valuestringnullablerequired

The meter value at which the Service Reminder is next due, if applicable.

due_soon_meter_valuestringnullablerequired

The meter value at which the Service Reminder is due soon, if applicable.

due_soon_meter_thresholddate-timenullablerequired

The meter value threshold to which this Service Reminder will be due soon.

Example: 2023-03-14T13:46:27-06:00

meter_remaining_until_dueintegernullablerequired

The remaining meter units until the Service Reminder is due.

secondary_meter_remaining_until_dueintegernullablerequired

The remaining secondary meter interval until the Service Reminder is due.

forecasted_primary_due_soon_atdate-timenullablerequired

The forecasted date and time for the primary Service Reminder to be due soon.

Example: 2023-03-14T13:46:27-06:00

forecasted_primary_next_due_atdate-timenullablerequired

The forecasted date and time for the next primary due Service Reminder.

Example: 2023-03-14T13:46:27-06:00

forecasted_secondary_due_soon_atdate-timenullablerequired

The forecasted date and time for the secondary Service Reminder to be due soon.

Example: 2023-03-14T13:46:27-06:00

forecasted_secondary_next_due_atdate-timenullablerequired

The forecasted date and time for the next secondary due Service Reminder.

Example: 2023-03-14T13:46:27-06:00

users object[]required

vehicle_namestringrequired

The name of the Vehicle associated with the Service Reminder.

vehicle_default_image_urlstringnullablerequired

The default image URL for the associated vehicle, if available.

attachment_permissions objectnullable

latest_occurrence objectnullablerequired

A Service Entry

idinteger

created_atdate-time

updated_atdate-time

tax_free_laborboolean

Indicates whether or not to include labor subtotals in tax calculations.

completed_atdate-timenullablerequired

The date and time at which the Service Entry was completed.

Example: 2023-03-14T13:46:27-06:00

referencestringnullablerequired

A reference number for this Service Entry.

started_atdate-timenullablerequired

The date and time at which the Service Entry was started.

Example: 2023-03-14T13:46:27-06:00

statusstringrequired

The status of this Service Entry.

Possible values: [pending, completed]

custom_fieldsobjectnullablerequired

*Full details on working with Custom Fields here.

general_notesstringnullablerequired

General notes for this Service Entry.

vehicle_idId (integer)required

Possible values: >= 1

vehicle_namestringnullablerequired

The name of the Vehicle associated with this Service Entry.

vendor_idNullableId (integer)nullablerequired

Possible values: >= 1

vendor_namestringnullablerequired

The name of the Vendor associated with this Service Entry.

work_order_idNullableId (integer)nullablerequired

Possible values: >= 1

attachment_permissions objectnullable

is_samplebooleanrequired

Indicates whether or not this Service Entry is a sample. Sample Service Entries are not included in reports.

work_order_numberintegernullablerequired

The number of the Work Order this Service Entry is associated with.

datedate-timerequired

The date of this Service Entry. Formatted according to ISO-8601 in User's local time.

Example: 2023-03-14T13:46:27-06:00

service_entry_line_items object[]required

Array [

idinteger

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

descriptionstringnullablerequired

A description of the service performed for this line item.

typeServiceEntryLineItemType (string)required

Denotes the type of the ServiceEntryLineItem

Possible values: [ServiceEntryServiceTaskLineItem, ServiceEntryLaborLineItem, ServiceEntryPartLineItem, ServiceEntryTaxLineItem, ServiceEntryFeeLineItem, ServiceEntryTireLineItem, ServiceEntryFreeTextLineItem]

service_entry_line_item_idintegernullablerequired

For nested line items. This value denotes the parent Service Entry Line Item.

service_reminder_idintegernullablerequired

If this line item is linked to a Service Reminder, this ID will be set.

service_task objectnullable

A Service Task

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

namestringrequired

A name for this Service Task.

Possible values: <= 255 characters

descriptionstringnullablerequired

A description of this Service Task.

expected_duration_in_secondsintegernullable

The expected duration in seconds this Service Task should take to complete.

archived_atdate-timenullable

The date and time at which this Service Task was archived. null if this Service Task is active.

subtasks object[]required

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

namestring

The name of this subtask.

descriptionstringnullable

A description of this subtask.

expected_duration_in_secondsintegernullable

The expected duration in seconds this subtask should take to complete.

subtasksarray

The subtasks array at this level will always be empty.

default_vmrs_reason_for_repair objectnullable

default_vmrs_system_group objectnullable

default_vmrs_system objectnullable

default_vmrs_assembly objectnullable

default_vmrs_component objectnullable

]

usageinteger

Indicates the number of times this Service Task has been used. Available by setting the include_usage query parameter to 1.

default_vmrs_reason_for_repair objectnullablerequired

default_vmrs_system_group objectnullablerequired

default_vmrs_system objectnullablerequired

default_vmrs_assembly objectnullablerequired

default_vmrs_component objectnullablerequired

service_task_parts object[]

issues object[]required

Any Issues this line item is linked to.

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

numberstringrequired

A unique identifier for the Issue.

namestringrequired

The name of the Issue.

summarystringrequired

A summary of the Issue.

descriptionstringnullablerequired

A longer description of the Issue.

statestringrequired

The Issue's current state.

Possible values: [Open, Closed, Resolved]

reported_atdate-timenullablerequired

The date and time at which the issue was reported.

Example: 2023-03-14T13:46:27-06:00

reported_by_idNullableId (integer)nullablerequired

Possible values: >= 1

reported_by_namestringnullablerequired

The name of the Contact associated with the User who reported this Issue.

fault_idNullableId (integer)nullablerequired

Possible values: >= 1

due_datedatenullablerequired

The date on which this Issue should be resolved by. Formatted according to ISO-8601 in User's local time zone.

Example: 2023-03-14

due_meter_valuestringnullablerequired

The meter value at which this Issue should be resolved by.

due_secondary_meter_valuefloatnullablerequired

The secondary meter value at which this Issue should be resolved by.

overduebooleanrequired

Indicates whether the Issue is overdue.

vehicle_idId (integer)required

Possible values: >= 1

vehicle_namestringrequired

The name of the Vehicle associated with this Issue.

is_sampleboolean

Indicates whether this Issue is sample data.

created_by_workflowbooleanrequired

Indicates whether this Issue was created by a workflow.

submitted_inspection_form_idNullableId (integer)nullablerequired

Possible values: >= 1

custom_fieldsobjectnullablerequired

*Full details on working with Custom Fields here.

valid_required_custom_fieldsbooleanrequired

dtc_alert_idNullableId (integer)nullablerequired

Possible values: >= 1

assigned_contacts object[]required

An array of assigned Contacts related to the Issue.

Array [

idinteger

created_atdate-time

updated_atdate-time

emailstringnullable

The Contact's email address.

namestringnullable

The Contact's full name.

first_namestringnullable

The Contact's first name.

middle_namestringnullable

The Contact's middle name.

last_namestringnullable

The Contact's last name.

images_countinteger

The number of images associated with this Contact.

Possible values: >= 0

documents_countinteger

The number of documents associated with this Contact.

Possible values: >= 0

comments_countinteger

The number of comments associated with this Contact.

Possible values: >= 0

group_idintegernullable

If this Contact belongs to a Group, this will be the Fleetio ID of that Group.

group_namestringnullable

If this Contact belongs to a Group, this will be the Group's name.

group_hierarchystringnullable

If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.

Example: Group 1|Group 2|Group 3

technicianbooleannullable

Whether or not the Contact is a Technician.

vehicle_operatorbooleannullable

Whether or not the Contact is a Vehicle Operator.

employeebooleannullable

Whether or not the Contact is an Employee.

birth_datedatenullable

The Contact's birth date.

Example: 2023-03-14

street_addressstringnullable

The Contact's street address.

Example: 123 Main St

street_address_line_2stringnullable

The Contact's street address line 2.

Example: Apt 1

citystringnullable

The Contact's city.

regionstringnullable

The Contact's region, state, or province.

postal_codestringnullable

The Contact's postal code, zip code, or equivalent.

countrystringnullable

The Contact's country.

employee_numberstringnullable

The Contact's employee number.

job_titlestringnullable

The Contact's job title.

Possible values: <= 255 characters

license_classstringnullable

The Contact's driver's license class.

license_numberstringnullable

The Contact's driver's license number.

license_statestringnullable

The locality which issued the Contact's license.

license_expirationdatenullable

The Contact's driver's license expiration date.

Example: 2023-03-14

home_phone_numberstringnullable

The Contact's home phone number.

mobile_phone_numberstringnullable

The Contact's mobile phone number.

work_phone_numberstringnullable

The Contact's work phone number.

other_phone_numberstringnullable

Any other phone number for this Contact.

start_datedatenullable

When the Contact started working for the company, if applicable.

leave_datedatenullable

When the Contact left or will leave the company, if applicable.

hourly_labor_ratefloatnullable

The Contact's hourly rate.

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

attachment_permissions objectnullable

default_image_urlstringnullable

The URL of the Contact's default image/profile photo, if any.

userobjectnullable

If the Contact is a Fleetio User, those details will be included here.

account_membership_idNullableId (integer)nullable

Possible values: >= 1

last_api_requestdate-timenullable

The last date and time this Contact's associated User made an API request. Null if Contact is not assocated with a User.

last_web_accessdate-timenullable

The last date and time this Contact's associated User signed into the web application. Null if Contact is not assocated with a User.

last_mobile_app_accessdate-timenullable

The last date and time this Contact's associated User used the mobile app. Null if Contact is not assocated with a User.

]

labels object[]required

attachment_permissions objectnullable

is_watchedbooleanrequired

Indicates whether the Issue is watched.

Default value: false

vehicle_image_urlstringnullablerequired

The URL to the image of the Vehicle associated with the Issue.

vehicle_image_url_mediumstringnullablerequired

The URL to a medium-sized Vehicle image associated with the Issue.

vehicle_image_url_smallstringnullablerequired

The URL to a small-sized Vehicle image associated with the Issue.

vehicle_image_url_largestringnullablerequired

The URL to a large-sized Vehicle image associated with the Issue.

watchers_countinteger

The count of watchers related to the Issue.

linked_work_orders object[]nullablerequired

source objectrequired

comments object[]

comments_countinteger

The number of comments made on this record.

Possible values: >= 0

documents object[]

documents_countinteger

The number of documents attached to this record.

Possible values: >= 0

images object[]

images_countinteger

The number of images attached to this record.

Possible values: >= 0

]

labor_costfloat

The total cost of labor for this line item.

parts_costfloat

The total cost of parts for this line item.

subtotalfloat

The pre-tax cost of this line item.

vmrs_reason_for_repair objectnullablerequired

vmrs_system_group objectnullablerequired

vmrs_system objectnullablerequired

vmrs_assembly objectnullablerequired

vmrs_component objectnullablerequired

]

service_tasks object[]required

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

namestringrequired

A name for this Service Task.

Possible values: <= 255 characters

descriptionstringnullablerequired

A description of this Service Task.

expected_duration_in_secondsintegernullable

The expected duration in seconds this Service Task should take to complete.

archived_atdate-timenullable

The date and time at which this Service Task was archived. null if this Service Task is active.

subtasks object[]required

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

namestring

The name of this subtask.

descriptionstringnullable

A description of this subtask.

expected_duration_in_secondsintegernullable

The expected duration in seconds this subtask should take to complete.

subtasksarray

The subtasks array at this level will always be empty.

default_vmrs_reason_for_repair objectnullable

default_vmrs_system_group objectnullable

default_vmrs_system objectnullable

default_vmrs_assembly objectnullable

default_vmrs_component objectnullable

]

usageinteger

Indicates the number of times this Service Task has been used. Available by setting the include_usage query parameter to 1.

default_vmrs_reason_for_repair objectnullablerequired

default_vmrs_system_group objectnullablerequired

default_vmrs_system objectnullablerequired

default_vmrs_assembly objectnullablerequired

default_vmrs_component objectnullablerequired

service_task_parts object[]

]

issues object[]required

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

numberstringrequired

A unique identifier for the Issue.

namestringrequired

The name of the Issue.

summarystringrequired

A summary of the Issue.

descriptionstringnullablerequired

A longer description of the Issue.

statestringrequired

The Issue's current state.

Possible values: [Open, Closed, Resolved]

reported_atdate-timenullablerequired

The date and time at which the issue was reported.

Example: 2023-03-14T13:46:27-06:00

reported_by_idNullableId (integer)nullablerequired

Possible values: >= 1

reported_by_namestringnullablerequired

The name of the Contact associated with the User who reported this Issue.

fault_idNullableId (integer)nullablerequired

Possible values: >= 1

due_datedatenullablerequired

The date on which this Issue should be resolved by. Formatted according to ISO-8601 in User's local time zone.

Example: 2023-03-14

due_meter_valuestringnullablerequired

The meter value at which this Issue should be resolved by.

due_secondary_meter_valuefloatnullablerequired

The secondary meter value at which this Issue should be resolved by.

overduebooleanrequired

Indicates whether the Issue is overdue.

vehicle_idId (integer)required

Possible values: >= 1

vehicle_namestringrequired

The name of the Vehicle associated with this Issue.

is_sampleboolean

Indicates whether this Issue is sample data.

created_by_workflowbooleanrequired

Indicates whether this Issue was created by a workflow.

submitted_inspection_form_idNullableId (integer)nullablerequired

Possible values: >= 1

custom_fieldsobjectnullablerequired

*Full details on working with Custom Fields here.

valid_required_custom_fieldsbooleanrequired

dtc_alert_idNullableId (integer)nullablerequired

Possible values: >= 1

assigned_contacts object[]required

An array of assigned Contacts related to the Issue.

Array [

idinteger

created_atdate-time

updated_atdate-time

emailstringnullable

The Contact's email address.

namestringnullable

The Contact's full name.

first_namestringnullable

The Contact's first name.

middle_namestringnullable

The Contact's middle name.

last_namestringnullable

The Contact's last name.

images_countinteger

The number of images associated with this Contact.

Possible values: >= 0

documents_countinteger

The number of documents associated with this Contact.

Possible values: >= 0

comments_countinteger

The number of comments associated with this Contact.

Possible values: >= 0

group_idintegernullable

If this Contact belongs to a Group, this will be the Fleetio ID of that Group.

group_namestringnullable

If this Contact belongs to a Group, this will be the Group's name.

group_hierarchystringnullable

If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.

Example: Group 1|Group 2|Group 3

technicianbooleannullable

Whether or not the Contact is a Technician.

vehicle_operatorbooleannullable

Whether or not the Contact is a Vehicle Operator.

employeebooleannullable

Whether or not the Contact is an Employee.

birth_datedatenullable

The Contact's birth date.

Example: 2023-03-14

street_addressstringnullable

The Contact's street address.

Example: 123 Main St

street_address_line_2stringnullable

The Contact's street address line 2.

Example: Apt 1

citystringnullable

The Contact's city.

regionstringnullable

The Contact's region, state, or province.

postal_codestringnullable

The Contact's postal code, zip code, or equivalent.

countrystringnullable

The Contact's country.

employee_numberstringnullable

The Contact's employee number.

job_titlestringnullable

The Contact's job title.

Possible values: <= 255 characters

license_classstringnullable

The Contact's driver's license class.

license_numberstringnullable

The Contact's driver's license number.

license_statestringnullable

The locality which issued the Contact's license.

license_expirationdatenullable

The Contact's driver's license expiration date.

Example: 2023-03-14

home_phone_numberstringnullable

The Contact's home phone number.

mobile_phone_numberstringnullable

The Contact's mobile phone number.

work_phone_numberstringnullable

The Contact's work phone number.

other_phone_numberstringnullable

Any other phone number for this Contact.

start_datedatenullable

When the Contact started working for the company, if applicable.

leave_datedatenullable

When the Contact left or will leave the company, if applicable.

hourly_labor_ratefloatnullable

The Contact's hourly rate.

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

attachment_permissions objectnullable

default_image_urlstringnullable

The URL of the Contact's default image/profile photo, if any.

userobjectnullable

If the Contact is a Fleetio User, those details will be included here.

account_membership_idNullableId (integer)nullable

Possible values: >= 1

last_api_requestdate-timenullable

The last date and time this Contact's associated User made an API request. Null if Contact is not assocated with a User.

last_web_accessdate-timenullable

The last date and time this Contact's associated User signed into the web application. Null if Contact is not assocated with a User.

last_mobile_app_accessdate-timenullable

The last date and time this Contact's associated User used the mobile app. Null if Contact is not assocated with a User.

]

labels object[]required

attachment_permissions objectnullable

is_watchedbooleanrequired

Indicates whether the Issue is watched.

Default value: false

vehicle_image_urlstringnullablerequired

The URL to the image of the Vehicle associated with the Issue.

vehicle_image_url_mediumstringnullablerequired

The URL to a medium-sized Vehicle image associated with the Issue.

vehicle_image_url_smallstringnullablerequired

The URL to a small-sized Vehicle image associated with the Issue.

vehicle_image_url_largestringnullablerequired

The URL to a large-sized Vehicle image associated with the Issue.

watchers_countinteger

The count of watchers related to the Issue.

linked_work_orders object[]nullablerequired

source objectrequired

comments object[]

comments_countinteger

The number of comments made on this record.

Possible values: >= 0

documents object[]

documents_countinteger

The number of documents attached to this record.

Possible values: >= 0

images object[]

images_countinteger

The number of images attached to this record.

Possible values: >= 0

]

meter_entry objectnullablerequired

secondary_meter_entry objectnullable

vmrs_repair_priority_class objectnullablerequired

labels object[]required

auto_integrate_ro_idNullableId (integer)nullablerequired

Possible values: >= 1

auto_integrate_ro_linkstringnullable

The Auto Integrate Repair Order link for this Service Entry.

auto_integrate_repair_order_statusstringnullablerequired

The Auto Integrate Repair Order status for this Service Entry.

Possible values: [approved, auto_approved, awaiting_reconciliation, completed, failed_reconciliation, invoiced, needs_approval, needs_reapproval, paid, rejected]

auto_integrate_repair_order_status_colorstringnullablerequired

The color applied to the Auto Integrate Repair Order status for this Service Entry.

invoice objectnullable

discountfloatnullable

The discount amount.

discount_typeDiscountType (string)nullable

The type of discount applied to this record.

Possible values: [fixed, percentage]

Default value: percentage

discount_percentagefloatnullable

The discount percentage. This field should be present when discount_type is set to percentage.

feesfloat

The fees amount. This is the sum of any ServiceEntryFeeLineItems present.

subtotalfloat

The pre-tax subtotal amount.

parts_subtotalfloat

The pre-tax subtotal amount for parts.

labor_subtotalfloat

The pre-tax subtotal amount for labor.

tax_1floatnullable

The primary tax amount.

tax_1_percentagefloatnullable

The primary tax percentage.

tax_1_typestringnullable

The primary tax type.

tax_2floatnullable

The secondary tax amount.

tax_2_percentagefloatnullable

The secondary tax percentage.

tax_2_typestringnullable

The secondary tax type.

parts_markup_typePartMarkupType (string)

The type of parts markup applied to the record Note that this is a readonly value that will default to percentage for non-premium plans

Possible values: [fixed, percentage]

parts_markupfloat

The parts markup amount. Note that this is a readonly value that will default to 0.0 for non-premium plans

Example: 1.23

parts_markup_percentagefloat

The parts markup percentage amount. This field should be present when parts_markup_type is set to percentage.

Note that this is a readonly value that will default to 0.0 for non-premium plans

Example: 1.23

labor_markup_typeLaborMarkupType (string)

The type of labor markup applied to the record Note that this is a readonly value that will default to percentage for non-premium plans

Possible values: [fixed, percentage]

labor_markupfloat

The labor markup amount. Note that this is a readonly value that will default to 0.0 for non-premium plans

Example: 1.23

labor_markup_percentagefloat

The labor markup percentage amount. This field should be present when labor_markup_type is set to percentage.

Note that this is a readonly value that will default to 0.0 for non-premium plans

Example: 1.23

total_amountfloat

The total amount.

comments object[]required

comments_countintegerrequired

The number of comments made on this record.

Possible values: >= 0

labor_time_in_secondsintegernullable

The 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[]

documents_countintegerrequired

The number of documents attached to this record.

Possible values: >= 0

images object[]required

images_countintegerrequired

The number of images attached to this record.

Possible values: >= 0

service_program_line_item objectnullablerequired

idinteger

created_atdate-time

updated_atdate-time

time_intervalinteger

The number of time units according to time_frequency between each occurrence of the Service Task(s) of this Service Program line item.

time_frequencyFrequency (string)nullable

Possible values: [day, week, month, year, days, weeks, months, years]

meter_intervalfloat

The meter interval of which this Service Program line item takes place.

secondary_meter_intervalfloatnullable

The secondary meter interval of which this Service Program line item takes place.

due_soon_time_threshold_intervalintegernullable

The number of time units according to due_soon_time_threshold_frequency between due_soon_at occurrences.

due_soon_time_threshold_frequencyFrequency (string)nullable

Possible values: [day, week, month, year, days, weeks, months, years]

due_soon_meter_thresholdfloatnullable

The meter value threshold to which this Service Program line item will be due soon.

due_soon_secondary_meter_thresholdfloatnullable

The 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.

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

namestring

The name of this Service Task.

descriptionstring

A description of this Service Task.

expected_duration_in_secondsintegernullable

The expected time to complete this Service Task in seconds.

subtasksundefined[]

The subtasks array within a parent subtasks array will always be empty.

default_vmrs_reason_for_repair objectnullable

default_vmrs_system_group objectnullable

default_vmrs_system object

default_vmrs_assembly object

default_vmrs_component object

]

service_program objectnullable

comments object[]required

watchers_countintegerrequired

The count of watchers associated with the record.

is_watchedbooleanrequired

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-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "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-07-29T15:51:28.071Z",
          "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-07-29T15:51:28.071Z",
              "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-07-29T15:51:28.071Z",
                "updated_at": "2024-07-29T15:51:28.071Z",
                "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-07-29",
                "leave_date": "2024-07-29",
                "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,
                "last_api_request": "2024-07-29T15:51:28.071Z",
                "last_web_access": "2024-07-29T15:51:28.071Z",
                "last_mobile_app_access": "2024-07-29T15:51:28.071Z"
              }
            ],
            "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-07-29T15:51:28.071Z"
              }
            ],
            "source": {
              "inspection_form": {
                "id": 0,
                "color": "string",
                "title": "string"
              },
              "inspection_submissions_count": 0,
              "last_inspection_submission_at": "2024-07-29T15:51:28.071Z",
              "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",
                "name": "string",
                "description": "string",
                "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-07-29T15:51:28.071Z",
        "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-07-29T15:51:28.071Z",
            "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-07-29T15:51:28.071Z",
            "updated_at": "2024-07-29T15:51:28.071Z",
            "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-07-29",
            "leave_date": "2024-07-29",
            "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,
            "last_api_request": "2024-07-29T15:51:28.071Z",
            "last_web_access": "2024-07-29T15:51:28.071Z",
            "last_mobile_app_access": "2024-07-29T15:51:28.071Z"
          }
        ],
        "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-07-29T15:51:28.071Z"
          }
        ],
        "source": {
          "inspection_form": {
            "id": 0,
            "color": "string",
            "title": "string"
          },
          "inspection_submissions_count": 0,
          "last_inspection_submission_at": "2024-07-29T15:51:28.071Z",
          "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",
            "name": "string",
            "description": "string",
            "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-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "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-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "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-07-29T15:51:28.071Z",
      "po_number": "string",
      "updated_at": "2024-07-29T15:51:28.071Z"
    },
    "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",
    "parts_markup_type": "fixed",
    "parts_markup": 1.23,
    "parts_markup_percentage": 1.23,
    "labor_markup_type": "fixed",
    "labor_markup": 1.23,
    "labor_markup_percentage": 1.23,
    "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",
        "name": "string",
        "description": "string",
        "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-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "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 (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

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 (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

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 (auto)
Example

Schema

errors object

{
  "errors": {}
}

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

Something unexpected happened

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

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"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

CURL

curl -L 'https://secure.fleetio.com/api/v1/service_reminders' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "service_task_id": 0,
  "meter_interval": 0,
  "secondary_meter_interval": 0,
  "secondary_meter": false,
  "time_interval": 0,
  "time_frequency": "days",
  "overridden": true,
  "next_due_meter_value": 0,
  "next_due_secondary_meter_value": 0,
  "next_due_at": "2023-03-14T13:46:27-06:00",
  "due_soon_meter_threshold": 0,
  "due_soon_secondary_meter_threshold": 0,
  "active": true,
  "due_soon_time_threshold_interval": 0,
  "due_soon_time_threshold_frequency": "days",
  "vehicle_id": 0,
  "starting_interval": true,
  "starting_meter_interval": 0,
  "starting_secondary_meter_interval": 0,
  "starting_time_interval": 0,
  "starting_time_frequency": "days",
  "snooze_until": "2023-03-14T13:46:27-06:00",
  "user_ids": [
    0
  ],
  "watcher_user_ids": [
    0
  ],
  "comments_attributes": [
    {
      "title": "string",
      "comment": "string"
    }
  ]
}'

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Body

{
  "service_task_id": 0,
  "meter_interval": 0,
  "secondary_meter_interval": 0,
  "secondary_meter": false,
  "time_interval": 0,
  "time_frequency": "days",
  "overridden": true,
  "next_due_meter_value": 0,
  "next_due_secondary_meter_value": 0,
  "next_due_at": "2023-03-14T13:46:27-06:00",
  "due_soon_meter_threshold": 0,
  "due_soon_secondary_meter_threshold": 0,
  "active": true,
  "due_soon_time_threshold_interval": 0,
  "due_soon_time_threshold_frequency": "days",
  "vehicle_id": 0,
  "starting_interval": true,
  "starting_meter_interval": 0,
  "starting_secondary_meter_interval": 0,
  "starting_time_interval": 0,
  "starting_time_frequency": "days",
  "snooze_until": "2023-03-14T13:46:27-06:00",
  "user_ids": [
    0
  ],
  "watcher_user_ids": [
    0
  ],
  "comments_attributes": [
    {
      "title": "string",
      "comment": "string"
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!

Create Service Reminder

https://secure.fleetio.com/api/v1/service_reminders

Request​

Body

Responses​

Authorization: Authorization

Request

Responses