FLfleetio
Service Reminders

Update Service Reminder

Update a Service Reminder

patch/service_reminders/{id}

Request

Path parameters

idstring required

The id of the relevant record

Request body

service_task_idinteger
meter_intervalnumber float

The meter interval of which this Service Reminder should occur.

secondary_meter_intervalnumber float

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.

time_intervalinteger

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

time_frequency'days' | 'weeks' | 'months' | 'years'
overriddenboolean

Indicates whether the Service Reminder is overridden.

next_due_meter_valuenumber float

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

next_due_secondary_meter_valuenumber float

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

next_due_atstring date-time

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

due_soon_meter_thresholdnumber float

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

due_soon_secondary_meter_thresholdnumber float

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_frequency'days' | 'weeks' | 'months' | 'years'
vehicle_idinteger
starting_intervalboolean

Indicates whether the Service Reminder has a starting interval.

starting_meter_intervalnumber float

The starting meter interval for this Service Reminder.

starting_secondary_meter_intervalnumber float

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_frequency'days' | 'weeks' | 'months' | 'years'
snooze_untilstring 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_idsId[]

The IDs of any Users associated with the Service Reminder.

watcher_user_idsId[]

The IDs of any Users to watch the Service Reminder.

Example request

{
  "next_due_at": "2023-03-14T13:46:27-06:00",
  "snooze_until": "2023-03-14T13:46:27-06:00"
}

Response

OK

idinteger required
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

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

activeboolean required

Indicates whether the Service Reminder is currently active.

vehicle_idinteger required
service_task_idinteger nullable required
service_task_namestring nullable required

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

time_intervalinteger nullable required

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

time_frequency'day' | 'week' | 'month' | 'year' | 'days' | 'weeks' | 'months' | 'years' nullable required
next_due_atstring date-time nullable required

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

due_soon_atstring date-time nullable required

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_intervalinteger nullable required

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

due_soon_time_threshold_frequency'day' | 'week' | 'month' | 'year' | 'days' | 'weeks' | 'months' | 'years' nullable required
vehicle_archived_atstring date-time nullable required

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

forecasted_next_due_atstring date-time nullable required

The forecasted date and time for the next due service.

forecasted_due_soon_atstring date-time nullable required

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

comments_countinteger required

The number of Comments on the Service Reminder.

starting_intervalboolean nullable required

Indicates whether the Service Reminder has a starting interval.

starting_meter_intervalstring nullable required

The starting meter interval for this Service Reminder.

starting_secondary_meter_intervalstring nullable required

The starting secondary meter interval for this Service Reminder.

starting_time_intervalinteger nullable required

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

starting_time_frequency'day' | 'week' | 'month' | 'year' | 'days' | 'weeks' | 'months' | 'years' nullable required
snooze_untilstring date-time nullable required

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

service_reminder_status_namestring nullable required

The name of the Service Reminder status, if applicable.

secondary_meterboolean required

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

meter_intervalstring nullable required

The meter interval of which this Service Reminder takes place.

next_due_meter_valuestring nullable required

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

due_soon_meter_valuestring nullable required

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

due_soon_meter_thresholdstring date-time nullable required

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

meter_remaining_until_dueinteger nullable required

The remaining meter units until the Service Reminder is due.

secondary_meter_remaining_until_dueinteger nullable required

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

forecasted_primary_due_soon_atstring date-time nullable required

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

forecasted_primary_next_due_atstring date-time nullable required

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

forecasted_secondary_due_soon_atstring date-time nullable required

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

forecasted_secondary_next_due_atstring date-time nullable required

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

vehicle_namestring required

The name of the Vehicle associated with the Service Reminder.

vehicle_default_image_urlstring nullable required

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

watchers_countinteger required

The count of watchers associated with the record.

is_watchedboolean required

Indicates whether the record is being watched.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "next_due_at": "2023-03-14T13:46:27-06:00",
  "due_soon_at": "2023-03-14T13:46:27-06:00",
  "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",
  "snooze_until": "2023-03-14T13:46:27-06:00",
  "due_soon_meter_threshold": "2023-03-14T13:46:27-06:00",
  "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",
  "latest_occurrence": {
    "completed_at": "2023-03-14T13:46:27-06:00",
    "started_at": "2023-03-14T13:46:27-06:00",
    "date": "2023-03-14T13:46:27-06:00",
    "service_entry_line_items": [
      {
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "service_task": {
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00",
          "subtasks": [
            {
              "created_at": "2023-03-14T13:46:27-06:00",
              "updated_at": "2023-03-14T13:46:27-06:00"
            }
          ]
        },
        "issues": [
          {
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00",
            "reported_at": "2023-03-14T13:46:27-06:00",
            "due_date": "2023-03-14",
            "assigned_contacts": [
              {
                "group_hierarchy": "Group 1|Group 2|Group 3",
                "birth_date": "2023-03-14",
                "street_address": "123 Main St",
                "street_address_line_2": "Apt 1",
                "license_expiration": "2023-03-14"
              }
            ],
            "comments": [
              {
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00"
              }
            ],
            "documents": [
              {
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00"
              }
            ],
            "images": [
              {
                "created_at": "2023-03-14T13:46:27-06:00",
                "updated_at": "2023-03-14T13:46:27-06:00"
              }
            ]
          }
        ]
      }
    ],
    "service_tasks": [
      {
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "subtasks": [
          {
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00"
          }
        ]
      }
    ],
    "issues": [
      {
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "reported_at": "2023-03-14T13:46:27-06:00",
        "due_date": "2023-03-14",
        "assigned_contacts": [
          {
            "group_hierarchy": "Group 1|Group 2|Group 3",
            "birth_date": "2023-03-14",
            "street_address": "123 Main St",
            "street_address_line_2": "Apt 1",
            "license_expiration": "2023-03-14"
          }
        ],
        "comments": [
          {
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00"
          }
        ],
        "documents": [
          {
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00"
          }
        ],
        "images": [
          {
            "created_at": "2023-03-14T13:46:27-06:00",
            "updated_at": "2023-03-14T13:46:27-06:00"
          }
        ]
      }
    ],
    "meter_entry": {
      "auto_voided_at": "2023-03-14T13:46:27-06:00",
      "date": "2023-03-14"
    },
    "secondary_meter_entry": {
      "auto_voided_at": "2023-03-14T13:46:27-06:00",
      "date": "2023-03-14"
    },
    "parts_markup": 1.23,
    "parts_markup_percentage": 1.23,
    "labor_markup": 1.23,
    "labor_markup_percentage": 1.23,
    "comments": [
      {
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00"
      }
    ],
    "documents": [
      {
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00"
      }
    ],
    "images": [
      {
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00"
      }
    ]
  },
  "service_program_line_item": {
    "service_tasks": [
      {
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00"
      }
    ],
    "service_program": {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  },
  "comments": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.