openapi: 3.2.0
info:
  contact:
    email: support@dealerware.com
    name: Dealerware Support
    url: https://support.dealerware.com
  description: MOB-API
  termsOfService: support@dealerware.com
  title: MOB Fleets API
  version: 1.0.0
servers:
- url: https://api.dealerware.com
  description: Production server
- url: https://api.dw-tst.com
  description: Staging server
security:
- Auth0: []
tags:
- name: Fleets
  description: Fleet actions and resources
paths:
  /admin/dealerships/{dealership_id}/fleets/trim_types_in_fleets:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    get:
      tags:
      - Fleets
      summary: Returns a given dealerships vehicle trims for all her fleets
      operationId: getDealershipTrimTypesInFleets
      parameters:
      - name: dealership_id
        in: path
        required: true
        description: the dealership ID
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminDealershipFleetsTrimTypesInFleetRequest'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /admin/dealerships/{id}/fleets/contracts_vehicles:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    get:
      summary: Fetch the fleets for a location, along with the contracts (within the given…
      operationId: getAdminDealershipFleetsContractsAndVehicles
      tags:
      - Fleets
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the dealership
        schema:
          type: integer
      - name: start_at
        description: The timestamp for the start of the range to fetch contracts for (inclusive)
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-15T00:00:00Z'
      - name: end_at
        description: The timestamp for the end of the range to fetch contracts for (inclusive)
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-21T00:00:00Z'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/AdminDealershipFleetsContractsVehiclesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /admin/dealerships/{id}/vehicles:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    post:
      summary: Creates a new Vehicle for a Dealership and assigns it to a list of Fleets
      operationId: postDealershipVehicle
      tags:
      - Fleets
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the dealership
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminVehicleRequest'
      responses:
        '201':
          $ref: '#/components/responses/Success'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '406':
          $ref: '#/components/responses/NotAcceptable'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /admin/fleets/{id}:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    get:
      summary: Gets a fleet
      operationId: getFleet
      tags:
      - Fleets
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the fleet
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/AdminFleetResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '406':
          $ref: '#/components/responses/NotAcceptable'
    put:
      summary: Updates a fleet
      operationId: putFleet
      tags:
      - Fleets
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the fleet
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminFleetRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/AdminFleetResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '406':
          $ref: '#/components/responses/NotAcceptable'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
    delete:
      summary: 'Deletes a fleet. NOTE: Temporarily Disabled. See SC-5730'
      operationId: deleteFleet
      tags:
      - Fleets
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the fleet
        schema:
          type: integer
      responses:
        '204':
          description: success
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '406':
          $ref: '#/components/responses/NotAcceptable'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /admin/fleets/{id}/availability:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    get:
      summary: Get active fleet size and required vehicles needed within a time range
      operationId: getFleetAvailability
      tags:
      - Fleets
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the fleet
        schema:
          type: integer
      - name: start_at
        description: The timestamp for the start of the availability range
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-15T20:12:26Z'
      - name: end_at
        description: The timestamp for the end of the availability range
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-15T20:12:26Z'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/AdminAvailabilityResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '406':
          $ref: '#/components/responses/NotAcceptable'
  /admin/fleets/{id}/availability/intervals:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    get:
      summary: Get availability by 30-minute interval for every interval between start and…
      operationId: getFleetAvailabilityIntervals
      tags:
      - Fleets
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the fleet
        schema:
          type: integer
      - name: start_at
        description: The timestamp for the start of the availability range
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-15T20:12:26Z'
      - name: end_at
        description: The timestamp for the end of the availability range
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-15T20:12:26Z'
      - name: exclude_contract_id
        description: If provided, the contract associated with the ID will be excluded from availability calculations. This is used for "modify" contract calculations
        in: query
        required: false
        schema:
          type: number
          example: 12345
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdminFleetAvailabilityIntervalResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /admin/fleets/{id}/availability/intervals/continuous:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    get:
      summary: Get availability from a static time by 30-minute interval for every interval…
      operationId: getFleetAvailabilityIntervalsContinuous
      tags:
      - Fleets
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the fleet
        schema:
          type: integer
      - name: reservation_start_at
        description: The timestamp for the start of reservation, which availability is calculated from
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-15T20:12:26Z'
      - name: start_at
        description: The timestamp for the start of the availability range
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-15T20:12:26Z'
      - name: end_at
        description: The timestamp for the end of the availability range
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-15T20:12:26Z'
      - name: exclude_contract_id
        description: If provided, the contract associated with the ID will be excluded from availability calculations. This is used for "modify" contract calculations
        in: query
        required: false
        schema:
          type: number
          example: 12345
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdminFleetAvailabilityIntervalResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /admin/fleets/{id}/availability/intervals/continuous/daily:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    get:
      summary: Get availability from a static time by day for every day between start and end…
      operationId: getFleetAvailabilityIntervalsContinuousDaily
      tags:
      - Fleets
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the fleet
        schema:
          type: integer
      - name: reservation_start_at
        description: The timestamp for the start of reservation, which availability is calculated from
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-15T20:12:26Z'
      - name: start_at
        description: The timestamp for the start of the availability range
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-15T00:00:00Z'
      - name: end_at
        description: The timestamp for the end of the availability range
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-21T00:00:00Z'
      - name: exclude_contract_id
        description: If provided, the contract associated with the ID will be excluded from availability calculations. This is used for "modify" contract calculations
        in: query
        required: false
        schema:
          type: number
          example: 12345
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdminFleetAvailabilityIntervalResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /admin/fleets/{id}/availabiliy/intervals/daily:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    get:
      summary: Get availability by day for every day between start and end, inclusive
      operationId: getFleetAvailabilityIntervalsDaily
      tags:
      - Fleets
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the fleet
        schema:
          type: integer
      - name: start_at
        description: The timestamp for the start of the availability range
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-15T00:00:00Z'
      - name: end_at
        description: The timestamp for the end of the availability range
        in: query
        required: true
        schema:
          type: string
          format: date-time
          example: '2020-06-21T00:00:00Z'
      - name: exclude_contract_id
        description: If provided, the contract associated with the ID will be excluded from availability calculations. This is used for "modify" contract calculations
        in: query
        required: false
        schema:
          type: number
          example: 12345
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdminFleetAvailabilityIntervalResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /admin/fleets/{id}/contracts:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    post:
      summary: Creates a new Contract associated with a Fleet
      operationId: postFleetContract
      tags:
      - Fleets
      parameters:
      - name: platform
        in: header
        required: false
        description: Header to let us know platform contract was booked on
        schema:
          type: string
      - name: app_name
        in: header
        required: false
        description: Header to let us know name of application
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: The id of the fleet
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminFleetContractRequest'
      responses:
        '201':
          $ref: '#/components/responses/CreatedWithLocationHeader'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '406':
          $ref: '#/components/responses/NotAcceptable'
  /admin/fleets/{id}/vehicles:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    post:
      summary: Creates a new Vehicle associated with a Fleet
      operationId: postFleetVehicles
      tags:
      - Fleets
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the fleet
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminVehicleRequest-2'
      responses:
        '201':
          $ref: '#/components/responses/Success'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '406':
          $ref: '#/components/responses/NotAcceptable'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /admin/vehicles/{id}:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    put:
      summary: Updates a Vehicle's Fleets
      operationId: putVehicleFleets
      tags:
      - Fleets
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the vehicle
        schema:
          type: integer
      requestBody:
        required: true
        description: Either `fleet_id` or `fleet_ids` must be present in the request body. If both are present, `fleet_ids` will be used.
        content:
          application/json:
            schema:
              type: object
              properties:
                fleet_id:
                  type: integer
                fleet_ids:
                  type: array
                  items:
                    type: integer
            example:
              fleet_ids:
              - 12
              - 34
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
components:
  schemas:
    AdminFleetRequest:
      type: object
      properties:
        name:
          type: string
          example: Loaner
        agreement_id:
          type:
          - number
          - 'null'
          example: 5
          description: Omit or pass null to keep the current agreement; pass an ID to assign one
        program_type:
          type: string
          example: rental
          description: A string representing the type of program the fleet is in (courtesy, rental, etc)
        require_insurance_sufficiency:
          type: string
          enum:
          - none
          - loaner
          - rental
          - loaner_rental
          example: loaner_rental
          description: Specifies when insurance sufficiency checks are required (none, loaner, rental, or loaner_rental)
    AdminFleetAvailabilityIntervalResponse:
      type: object
      required:
      - start_at
      - end_at
      - fleet_id
      - available
      - active_vehicle_count
      - required_vehicle_count
      properties:
        start_at:
          type: string
          format: date-time
          example: '2020-06-15T20:12:26Z'
          description: The beginning of the interval
        end_at:
          type: string
          format: date-time
          example: '2020-06-15T20:12:26Z'
          description: The beginning of the interval
        fleet_id:
          type: number
          example: 123
          description: The id for this fleet
        available:
          type: boolean
          description: True if there is availability for this interval, false otherwise
        active_vehicle_count:
          type: integer
          example: 30
          description: The count of active vehicles in a fleet
        required_vehicle_count:
          type: integer
          example: 10
          description: The count of minimum vehicles required to service all bookings within a time range
    AdminAvailabilityResponse:
      type: object
      properties:
        active_vehicle_count:
          type: integer
          example: 30
          description: The count of active vehicles in a fleet
        required_vehicle_count:
          type: integer
          example: 10
          description: The count of minimum vehicles required to service all bookings within a time range
    AdminDealershipFleetsTrimTypesInFleetRequest:
      type: array
      items:
        type: object
        properties:
          name:
            type: string
            example: Fleet 1
          fleet_id:
            type: integer
            example: 104
          trims:
            type:
            - array
            - 'null'
            items:
              type: object
              properties:
                trim_id:
                  type: integer
                  example: 1
                make:
                  type:
                  - string
                  - 'null'
                  example: Ford
                model:
                  type:
                  - string
                  - 'null'
                  example: F-150
                count:
                  type:
                  - string
                  - 'null'
                  example: 104
    AdminDealershipFleetsContractsVehiclesResponse:
      type: object
      properties:
        vehicle_groups:
          type: array
          items:
            type: object
            properties:
              id:
                type: number
                example: 1
                description: ID of the vehicle group
              contracts:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: number
                      example: 1
                      description: ID of the contract
                    status:
                      type: string
                      example: pending
                      description: the status of the contract
                    vehicle_id:
                      type:
                      - number
                      - 'null'
                      example: 1
                      description: the ID of the vehicle associated with this contract, null if no vehicle is yet assigned
                    customer:
                      type: object
                      properties:
                        id:
                          type: number
                          example: 1
                          description: the ID of the customer associated with this reservation
                        full_name:
                          type: string
                          example: Frodo Baggins
                          description: the full name of the customer associated with this reservation
                    scheduled_pickup_at:
                      type: string
                      format: date-time
                      example: '2022-05-19T16:22:26Z'
                    scheduled_dropoff_at:
                      type: string
                      format: date-time
                      example: '2022-08-10T14:15:30Z'
                    actual_pickup_at:
                      type:
                      - string
                      - 'null'
                      format: date-time
                      example: '2022-05-19T16:22:26Z'
                    actual_dropoff_at:
                      type:
                      - string
                      - 'null'
                      format: date-time
                      example: '2022-08-10T14:15:30Z'
              vehicles:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: number
                      example: 1
                      description: the ID of the vehicle
                    trim:
                      type: object
                      properties:
                        make:
                          type: string
                          example: Toyota
                        model:
                          type: string
                          example: Corolla
                        power_train:
                          type: string
                          example: mechanical
                        year:
                          type: number
                          example: 1999
    AdminVehicleRequest:
      type: object
      required:
      - available_on
      - fleet_ids
      - license
      - license_subregion
      - stock_number
      - vin
      properties:
        available_on:
          type: string
          format: date
          example: '2020-01-01'
        color:
          type: string
          example: grey
        fleet_ids:
          type: array
          items:
            type: integer
          example:
          - 12
          - 42
        license:
          type: string
          example: ABC123
          description: Required vehicle plate. Trimmed and converted to ASCII uppercase before validation. The result must contain 1–8 ASCII letters, digits, spaces, or hyphens, with single spaces or hyphens allowed only between groups of letters or digits. Separators count toward the length. Invalid characters are rejected; format acceptance does not guarantee Bestpass registration. For example, padded lowercase ab-123 becomes AB-123; AB--123 and ABCD-1234 are invalid.
        license_subregion:
          type: string
          example: TX
        stock_number:
          type: string
          example: VV111
        vin:
          type: string
          pattern: '[A-HJ-NPR-Z0-9]{17}'
          example: 1FT7W2BT4DEB5192
        defleet_vehicles:
          type: boolean
          example: true
    AdminFleetResponse:
      type: object
      required:
      - id
      - name
      - agreement_id
      - created_at
      - contractable
      - external_availability_group
      - repair_order_number_required
      - exclude_rate
      - pdf_agreement_url
      - program_type
      - source_of_business
      - reservation_time_cap
      - reservation_time_cap_warning
      - allow_charge_later
      - allow_manual_signature
      - require_customer_vin
      - guided_walkaround_enforced
      - require_insurance_sufficiency
      - misc
      properties:
        id:
          type: integer
          example: 123
        name:
          type: string
          example: Loaner
        agreement_id:
          type:
          - integer
          - 'null'
          example: 5
          description: the ID of the agreement to assign to the fleet
        created_at:
          type: string
          format: date-time
          example: '2024-01-01T12:00:00Z'
          description: the date and time when the fleet was created
        contractable:
          type: boolean
          example: true/false
          description: whether or not this fleet is allowed to start a contract
        external_availability_group:
          type:
          - boolean
          - 'null'
          example: false
          description: whether the fleet is an external availability group
        repair_order_number_required:
          type: boolean
          example: false
          description: whether repair order numbers are required for this fleet
        exclude_rate:
          type:
          - boolean
          - 'null'
          example: false
          description: whether the fleet should use rates
        pdf_agreement_url:
          type:
          - string
          - 'null'
          example: https://www.example.com/agreement.pdf
          description: the pdf of the agreement to assign to the fleet
        program_type:
          type:
          - string
          - 'null'
          example: rental
          description: A string representing the type of program the fleet is in (courtesy, rental, etc)
        source_of_business:
          type:
          - string
          - 'null'
          enum:
          - customer
          - internal
          - warranty
          example: customer
          description: Source of business classification for the fleet
        reservation_time_cap:
          type:
          - integer
          - 'null'
          example: 60
          description: the maximum amount of time a reservation should be active for, in days
        reservation_time_cap_warning:
          type:
          - integer
          - 'null'
          example: 5
          description: the number of days before a reservation hits the cap that a warning should be sent
        allow_charge_later:
          type: boolean
          example: true
        allow_manual_signature:
          type: boolean
          example: false
        require_customer_vin:
          type: boolean
          example: false
        guided_walkaround_enforced:
          type: boolean
          example: false
        require_insurance_sufficiency:
          type: string
          enum:
          - none
          - loaner
          - rental
          - loaner_rental
          example: loaner_rental
          description: Specifies when insurance sufficiency checks are required (none, loaner, rental, or loaner_rental)
        sales_lead_enabled:
          type: boolean
          example: false
          description: whether Service to Sales lead generation is enabled for the fleet
        sales_lead_offset_hours:
          type: integer
          example: 3
          description: how many hours after service intake a sales lead should be created (1-12)
        sales_lead_cms_config_email:
          type:
          - string
          - 'null'
          example: leads@dealer.com
          description: email address the Service to Sales lead configuration should notify
        misc:
          type: object
          example: {}
          description: a JSON object for storing miscellaneous data
    AdminVehicleRequest-2:
      type: object
      required:
      - license
      properties:
        available_on:
          type: string
          format: date
          example: '2020-01-01'
        color:
          type: string
          example: grey
        license:
          type: string
          example: ABC123
          description: Required vehicle plate. Trimmed and converted to ASCII uppercase before validation. The result must contain 1–8 ASCII letters, digits, spaces, or hyphens, with single spaces or hyphens allowed only between groups of letters or digits. Separators count toward the length. Invalid characters are rejected; format acceptance does not guarantee Bestpass registration. For example, padded lowercase ab-123 becomes AB-123; AB--123 and ABCD-1234 are invalid.
        license_subregion:
          type: string
          example: TX
        stock_number:
          type: string
          example: VV111
        vin:
          type: string
          pattern: '[A-HJ-NPR-Z0-9]{17}'
          example: 1FT7W2BT4DEB5192
    AdminFleetContractRequest:
      type: object
      required:
      - dropoff_at
      - pickup_at
      - customer_id
      properties:
        service_advisor_id:
          description: The id of the service advisor associated with the contract
          type: integer
        customer_id:
          description: The id of the customer who the reservation is for
          type: integer
        daily_rate_override:
          description: The daily rate to charge for this contract, if different from the default rate for the vehicle. Must have the accounting and/or admin role to set this field.
          type:
          - number
          - 'null'
          example: 29.95
        dropoff_at:
          description: The time the vehicle is expected to be dropped off, in UTC
          type: string
          format: date-time
          example: '2021-06-15T20:22:26Z'
        external_deposit_amount:
          type:
          - number
          - 'null'
          example: 100
          description: The amount of the external deposit, if any, that was collected for this contract
        pickup_at:
          description: The time the vehicle is expected to be picked up, in UTC
          type: string
          format: date-time
          example: '2021-06-19T20:22:26Z'
        purchase_order:
          description: The purchase order number
          type: string
        repair_order:
          description: The repair order number, or notes/source of business
          type: string
        service_vehicle:
          description: Identifier for vehicle being serviced
          type: string
        vehicle_id:
          description: Optional. When included, assigns the corresponding vehicle to this contract after creation
          type: number
  responses:
    UnprocessableEntity:
      description: Unprocessable Content
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Invalid resource id
              code:
                type: integer
                example: 6789
    NoContent:
      description: No Content
    UnsupportedMediaType:
      description: Unsupported Media Type
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Accepted media types is limited to JSON (application/json)
              code:
                type: integer
                example: 6789
    Success:
      description: Success
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Invalid authorization token
              code:
                type: integer
                example: 6789
    CreatedWithLocationHeader:
      headers:
        Location:
          $ref: '#/components/headers/Location'
      description: Created
    NotAcceptable:
      description: Not Acceptable
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Missing headers in request
              code:
                type: integer
                example: 6789
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Request is forbidden
              code:
                type: integer
                example: 6789
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Resource with id :id not found
              code:
                type: integer
                example: 6789
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Bad Request
              code:
                type: integer
                example: 6789
  headers:
    Location:
      description: Location of created resource
      schema:
        type: string
  securitySchemes:
    Auth0:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://dealerware.auth0.com/oauth/token
          scopes: {}
x-provenance:
  method: searched
  source: https://developer.dealerware.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.dealerware.com/reference/admincustomerget-1.md
  - https://developer.dealerware.com/reference/createblacklist-1.md
  - https://developer.dealerware.com/reference/deleteadmincontractcancel-1.md
  - https://developer.dealerware.com/reference/deleteadmincontractsplitbill-1.md
  - https://developer.dealerware.com/reference/deleteadmincontractsplitbillpayment-1.md
  - https://developer.dealerware.com/reference/deleteadmincontractswarranty-1.md
  - https://developer.dealerware.com/reference/deleteadmindealershipwebhook.md
  - https://developer.dealerware.com/reference/deleteadmindriver-1.md
  - https://developer.dealerware.com/reference/deletecontractnote-1.md
  - https://developer.dealerware.com/reference/deletecustomerfromblacklist-1.md
  - https://developer.dealerware.com/reference/deletedealershipcustomernotes.md
  - https://developer.dealerware.com/reference/deletedealershipcustomers-1.md
  - https://developer.dealerware.com/reference/deleteemployeeactivation-1.md
  - https://developer.dealerware.com/reference/deletefleet-1.md
  - https://developer.dealerware.com/reference/deleteissue-1.md
  - https://developer.dealerware.com/reference/getadmincontractadjustments-1.md
  - https://developer.dealerware.com/reference/getadmincontractauthorization-1.md
  - https://developer.dealerware.com/reference/getadmincontractcustomer-1.md
  - https://developer.dealerware.com/reference/getadmincontractpayments-1.md
  - https://developer.dealerware.com/reference/getadmincontractpricing-1.md
  - https://developer.dealerware.com/reference/getadmincontractsdrivers-1.md
  - https://developer.dealerware.com/reference/getadmincontractsplitbill-1.md
  - https://developer.dealerware.com/reference/getadmincontractsplitbilladjustment-1.md
  - https://developer.dealerware.com/reference/getadmincontractstoggles-1.md
  - https://developer.dealerware.com/reference/getadmincontractvehiclesavailable-1.md
  - https://developer.dealerware.com/reference/getadmincontractvehiclesavailablesearch-1.md
  - https://developer.dealerware.com/reference/getadmincustomercreditcards-1.md
  - https://developer.dealerware.com/reference/getadmincustomeremployer-1.md
  - https://developer.dealerware.com/reference/getadmincustomerinsurance-1.md
  - https://developer.dealerware.com/reference/getadmincustomernotificationsfailed.md
  - https://developer.dealerware.com/reference/getadmincustomerscontracts-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcontracts-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcontractsmanifesttoday-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcontractssearch-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcustomernotes.md
  - https://developer.dealerware.com/reference/getadmindealershipcustomers-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcustomersmessagesprofiles-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcustomersremoteprofilesearch-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcustomerssearch-1.md
  - https://developer.dealerware.com/reference/getadmindealershipemployees-1.md
  - https://developer.dealerware.com/reference/getadmindealershipemployeessearch-1.md
  - https://developer.dealerware.com/reference/getadmindealershipfleetscontractsandvehicles-1.md
  - https://developer.dealerware.com/reference/getadmindealershipserviceadvisors-1.md
  - https://developer.dealerware.com/reference/getadmindealershipwebhook.md
  - https://developer.dealerware.com/reference/getadmindealershipwebhooks.md
  - https://developer.dealerware.com/reference/getadmindriver-1.md
  - https://developer.dealerware.com/reference/getcontract-1.md
  - https://developer.dealerware.com/reference/getcontractnotes-1.md
  - https://developer.dealerware.com/reference/getcontractscontactless-1.md
  - https://developer.dealerware.com/reference/getcontractscontactlessdriver-1.md
  - https://developer.dealerware.com/reference/getcontractssaleslead.md
  - https://developer.dealerware.com/reference/getcontractwarranty-1.md
  - https://developer.dealerware.com/reference/getdealership-1.md
  - https://developer.dealerware.com/reference/getdealershipaddress-1.md
  - https://developer.dealerware.com/reference/getdealershipavailability-1.md
  - https://developer.dealerware.com/reference/getdealershipavailabilityintervals-1.md
  - https://developer.dealerware.com/reference/getdealershipavailabilityintervalscontinuous-1.md
  - https://developer.dealerware.com/reference/getdealershipavailabilityintervalscontinuousdaily-1.md
  - https://developer.dealerware.com/reference/getdealershipavailabilityintervalsdaily-1.md
  - https://developer.dealerware.com/reference/getdealershipcalendarbookingchannels.md
  - https://developer.dealerware.com/reference/getdealershipcalendarcontracts-1.md
  - https://developer.dealerware.com/reference/getdealershipcalendarvehicles-1.md
  - https://developer.dealerware.com/reference/getdealershipcontractavailablevehicles.md
  - https://developer.dealerware.com/reference/getdealershipemployeeroles-1.md
  - https://developer.dealerware.com/reference/getdealershipfleetpricing-1.md
  - https://developer.dealerware.com/reference/getdealershipfleets-1.md
  - https://developer.dealerware.com/reference/getdealershipkpis-1.md
  - https://developer.dealerware.com/reference/getdealershipmakesandmodels-1.md
  - https://developer.dealerware.com/reference/getdealershipreportreceivables-1.md
  - https://developer.dealerware.com/reference/getdealershipreportrevenue-1.md
  - https://developer.dealerware.com/reference/getdealershipreportrevenuesummary-1.md
  - https://developer.dealerware.com/reference/getdealershipreporttransactions-1.md
  - https://developer.dealerware.com/reference/getdealershipreporttransactionsfilteredsorted-1.md
  - https://developer.dealerware.com/reference/getdealershiproles-1.md
  - https://developer.dealerware.com/reference/getdealerships-1.md
  - https://developer.dealerware.com/reference/getdealershipsearch-1.md
  - https://developer.dealerware.com/reference/getdealershipsettings-1.md
  - https://developer.dealerware.com/reference/getdealershiptelematicssettings-1.md
  - https://developer.dealerware.com/reference/getdealershiptrimtypesinfleets-1.md
  - https://developer.dealerware.com/reference/getdealershipvehicles-1.md
  - https://developer.dealerware.com/reference/getdealershipvehiclessearch-1.md
  - https://developer.dealerware.com/reference/getdocument-1.md
  - https://developer.dealerware.com/reference/getemployee-1.md
  - https://developer.dealerware.com/reference/getfleet-1.md
  - https://developer.dealerware.com/reference/getfleetavailability-1.md
  - https://developer.dealerware.com/reference/getfleetavailabilityintervals-1.md
  - https://developer.dealerware.com/reference/getfleetavailabilityintervalscontinuous-1.md
  - https://developer.dealerware.com/reference/getfleetavailabilityintervalscontinuousdaily-1.md
  - https://developer.dealerware.com/reference/getfleetavailabilityintervalsdaily-1.md
  - https://developer.dealerware.com/reference/getfleetsettings-1.md
  - https://developer.dealerware.com/reference/getgeolocationradialdistance-1.md
  - https://developer.dealerware.com/reference/getmappablefields-1.md
  - https://developer.dealerware.com/reference/getprogramavailability-1.md
  - https://developer.dealerware.com/reference/getprogramavailabilityintervals-1.md
  - https://developer.dealerware.com/reference/getrentalagreementpdf-1.md
  - https://developer.dealerware.com/reference/getreservationcustomer-1.md
  - https://developer.dealerware.com/reference/getshortremoteprofile.md
  - https://developer.dealerware.com/reference/getuser-1.md
  - https://developer.dealerware.com/reference/getuserdealershiproles-1.md
  - https://developer.dealerware.com/reference/getuserpreferences.md
  - https://developer.dealerware.com/reference/getvehicle-1.md
  - https://developer.dealerware.com/reference/getvehicleevents-1.md
  - https://developer.dealerware.com/reference/getvehiclegroupdefleetsettings.md
  - https://developer.dealerware.com/reference/getvehicleissues-1.md
  - https://developer.dealerware.com/reference/getvehicletelemetry-1.md
  - https://developer.dealerware.com/reference/patchadminvehicle.md
  - https://developer.dealerware.com/reference/patchdealershipandfleetsettings-1.md
  - https://developer.dealerware.com/reference/postadmincontractbillingadjustment-1.md
  - https://developer.dealerware.com/reference/postadmincontractreceiptpdf-1.md
  - https://developer.dealerware.com/reference/postadmincontractsdrivers-1.md
  - https://developer.dealerware.com/reference/postadmincontractsettlement-1.md
  - https://developer.dealerware.com/reference/postadmincontractsplitbill-1.md
  - https://developer.dealerware.com/reference/postadmincontractsplitbilladjustment-1.md
  - https://developer.dealerware.com/reference/postadmincontractsplitbillpayment-1.md
  - https://developer.dealerware.com/reference/postadmincontractsplitbillpdf-1.md
  - https://developer.dealerware.com/reference/postadmincustomeremployer-1.md
  - https://developer.dealerware.com/reference/postadmincustomerinsurance-1.md
  - https://developer.dealerware.com/reference/postadmincustomernotificationreplay.md
  - https://developer.dealerware.com/reference/postadmindealershipcustomer-1.md
  - https://developer.dealerware.com/reference/postadmindealershipcustomermessage-1.md
  - https://developer.dealerware.com/reference/postadmindealershipcustomernote.md
  - https://developer.dealerware.com/reference/postadmindealershipcustomersremoteprofileqrcode.md
  - https://developer.dealerware.com/reference/postadmindealershipemployee-1.md
  - https://developer.dealerware.com/reference/postadmindealershipwebhook.md
  - https://developer.dealerware.com/reference/postcontactlessdriversignature-1.md
  - https://developer.dealerware.com/reference/postcontractcontactlessmessages-1.md
  - https://developer.dealerware.com/reference/postcontractnote-1.md
  - https://developer.dealerware.com/reference/postcontractscontactlesssignatures-1.md
  - https://developer.dealerware.com/reference/postcontractssaleslead.md
  - https://developer.dealerware.com/reference/postcontractswarranty-1.md
  - https://developer.dealerware.com/reference/postdealeronboardingvehicles-1.md
  - https://developer.dealerware.com/reference/postdealershipfleets-1.md
  - https://developer.dealerware.com/reference/postdealershipvehicle-1.md
  - https://developer.dealerware.com/reference/postdealervehiclescheckingonboardingstatus-1.md
  - https://developer.dealerware.com/reference/postdriversignature-1.md
  - https://developer.dealerware.com/reference/postemployeeactivation-1.md
  - https://developer.dealerware.com/reference/postfleetcontract-1.md
  - https://developer.dealerware.com/reference/postfleetvehicles-1.md
  - https://developer.dealerware.com/reference/postlogin-1.md
  - https://developer.dealerware.com/reference/postreportingdata.md
  - https://developer.dealerware.com/reference/postreportingmetadata.md
  - https://developer.dealerware.com/reference/postuserconfirmations-1.md
  - https://developer.dealerware.com/reference/postuserpasswordforgot-1.md
  - https://developer.dealerware.com/reference/postvehicleissue-1.md
  - https://developer.dealerware.com/reference/putadmincontractfinish-1.md
  - https://developer.dealerware.com/reference/putadmincontractpaymentmethod-1.md
  - https://developer.dealerware.com/reference/putadmincontractsplitbill-1.md
  - https://developer.dealerware.com/reference/putadmincontractstart-1.md
  - https://developer.dealerware.com/reference/putadmincontractswarranty-1.md
  - https://developer.dealerware.com/reference/putadmincontractunassignvehicle-1.md
  - https://developer.dealerware.com/reference/putadmincontractvehicle-1.md
  - https://developer.dealerware.com/reference/putadmincustomeremployer-1.md
  - https://developer.dealerware.com/reference/putadmincustomerupdate-1.md
  - https://developer.dealerware.com/reference/putadmindealershipwebhook.md
  - https://developer.dealerware.com/reference/putadmindriver-1.md
  - https://developer.dealerware.com/reference/putcontract-1.md
  - https://developer.dealerware.com/reference/putcontractnote-1.md
  - https://developer.dealerware.com/reference/putdealershipaddress-1.md
  - https://developer.dealerware.com/reference/putdealershipcustomernote.md
  - https://developer.dealerware.com/reference/putdealershipemployeeroles-1.md
  - https://developer.dealerware.com/reference/putdealershiptelematicssettings-1.md
  - https://developer.dealerware.com/reference/putemployee-1.md
  - https://developer.dealerware.com/reference/putfleet-1.md
  - https://developer.dealerware.com/reference/putfleetsettings-1.md
  - https://developer.dealerware.com/reference/putissue-1.md
  - https://developer.dealerware.com/reference/putreservationcustomer-1.md
  - https://developer.dealerware.com/reference/putuser-1.md
  - https://developer.dealerware.com/reference/putuserpassword-1.md
  - https://developer.dealerware.com/reference/putuserpasswordreset-1.md
  - https://developer.dealerware.com/reference/putuserpreference-1.md
  - https://developer.dealerware.com/reference/putvehiclefleet-1.md
  - https://developer.dealerware.com/reference/putvehiclefleets-1.md
  - https://developer.dealerware.com/reference/querydnr-1.md
  - https://developer.dealerware.com/reference/updateadmincustomerinsurance-1.md
  merge:
    pages: 174
    deduped: 1048
    conflicts_kept_first: 0