Skip to main content

Create Vehicle Assignment

Creates a new Vehicle Assignment

Request Body

  • contact_employee_number string

    Possible values: <= 255 characters

    If the Contact being assigned has an employee number, it can be included here.

  • contact_id integer required

    Possible values: >= 1

  • vehicle_id integer required

    Possible values: >= 1

  • started_at date-time

    The date and time of this Vehicle Assignment. Dates in the future are accepted. We recommend using ISO-8601 formatted dates to avoid ambiguity.

  • ended_at date-time

    The date and time of this Vehicle Assignment ending. We recommend using ISO-8601 formatted dates to avoid ambiguity.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • starting_meter_entry_attributes object

    A Vehicle Assignment may be associated with a starting Meter Entry

  • value float

    The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.

  • void boolean

    If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.

  • ending_meter_entry_attributes object

    A Vehicle Assignment may also be associated with an ending Meter Entry

  • value float

    The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.

  • void boolean

    If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.

  • comments_attributes object[]
  • title string

    The title of the comment.

  • comment string

    The comment text.

Responses

OK

Response Headers

    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.

    • vehicle_id integer

      Possible values: >= 1

    • contact_id integer

      Possible values: >= 1

    • started_at date-time

      The date and time of this Vehicle Assignment. Dates in the future are accepted. We recommend using ISO-8601 formatted dates to avoid ambiguity.

    • ended_at date-time

      The date and time of this Vehicle Assignment ending. We recommend using ISO-8601 formatted dates to avoid ambiguity.

    • current boolean

      Default value: false

      Whether this Vehicle Assignment is current/active.

    • future boolean

      Default value: false

      Whether this Vehicle Assignment is set to take place in the future.

    • custom_fields object

      *Full details on working with Custom Fields here.

    • starting_meter_entry_value string

      The meter value at the start of this Vehicle Assignment.

    • ending_meter_entry_value string

      The meter value at the end of this Vehicle Assignment.

    • comments_count integer

      The number of comments on this Vehicle Assignment.

    • contact_full_name string
    • contact_image_url string

      The URL pointing to the Contact's image.

    • attachment_permissions object
    • read_photos boolean

      Indicates whether the user has read permission for photos.

    • manage_photos boolean

      Indicates whether the user has permission to manage (eg. upload, delete) photos.

    • read_documents boolean

      Indicates whether the user has read permission for documents.

    • manage_documents boolean

      Indicates whether the user has permission to manage (eg. upload, delete) documents.

    • comments object[]

      Any Comments made on this Vehicle Assignment.

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

    • commentable_type CommentableType

      Possible 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 integer

      Possible values: >= 1

    • user_id integer

      Possible values: >= 1

    • title string deprecated

      The title of the Comment.

    • comment string

      The content of the Comment message body.

    • user_full_name string

      The full name of the User who created the Comment.

    • user_image_url string

      The image url for the User who created the Comment.

    • rich_content object
    • html_content string

      The comment message body rendered as HTML.

    • with_mentions boolean

      Indicates if the message body contains @mentions.

    Loading...