Decisiv VMRS API

openapi: 3.2.0
info:
  title: Decisiv VMRS API
  version: 0.48.24
  contact:
    name: Decisiv Support
    email: support@decisiv.com
    url: https://www.decisiv.com
  license:
    name: Proprietary
    identifier: proprietary
    url: https://www.decisiv.com/terms-of-use/
  termsOfService: https://www.decisiv.com/terms-of-use
  description: 'Operations tagged VMRS across 2 of this provider''s published API definitions: decisiv-asset-management-openapi.yml, decisiv-service-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://srm-api.staging.decisivapps.com
- url: https://srm-api.decisivapps.com
security:
- OAuth2AuthorizationCode: []
  AccessToken: []
- OAuth2Password: []
  AccessToken: []
tags:
- name: VMRS
paths:
  /asset_management/{srm_account_id}/v1/vmrs/asset_types:
    get:
      operationId: listVmrsAssetTypes
      description: 'Returns the catalog of VMRS Code Key 2 ("Equipment Category" / asset type)

        reference values. Use this to populate dropdowns and validate

        `vmrs_asset_type` values before sending them on asset write endpoints.


        The response payload is byte-identical to the equivalent route under

        `service_management` — both URLs are served by the same backend

        controller. Results are sorted alphabetically by `code` (ascending),

        with `description` as a deterministic tiebreaker.

        '
      summary: List all VMRS Asset Types (Code Key 2)
      tags:
      - VMRS
      parameters:
      - name: srm_account_id
        in: path
        required: true
        description: The SRM Account ID.
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
        description: Sets the desired `page` when encountering larger result sets.
      - name: page[size]
        in: query
        required: false
        schema:
          type: integer
          default: 25
          minimum: 1
        description: Sets the desired maximum number of results per page.
      responses:
        '200':
          description: Returns the list of VMRS Asset Types.
          content:
            application/vnd.api+json:
              example:
                data:
                - id: '01'
                  type: decisiv_vmrs_asset_types
                  attributes:
                    code_key: '2'
                    code_key_name: Equipment Category
                    code: '01'
                    description: Truck
                - id: '02'
                  type: decisiv_vmrs_asset_types
                  attributes:
                    code_key: '2'
                    code_key_name: Equipment Category
                    code: '02'
                    description: Tractor
                - id: D
                  type: decisiv_vmrs_asset_types
                  attributes:
                    code_key: '2'
                    code_key_name: Equipment Category
                    code: D
                    description: Agricultural Equipment
                meta:
                  record-count: 78
              schema:
                $ref: '#/components/schemas/vmrs_asset_types'
        '401':
          description: This response may occur when the access token provided within the Authorization header has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: The authenticated user does not have the `vmrs:ReadAssetTypes` permission for the requested account.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: Account not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '404'
                  title: Record not found
                  source:
                    parameter: srm_account_id
              schema:
                $ref: '#/components/schemas/errors_response'
        '428':
          description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '428'
                  code: decisiv:access:003
                  title: Precondition required
                  detail: OAuth Application does not have appropriate provisioning to access this resource
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /asset_management/{srm_account_id}/v1/vmrs/reasons_for_repair:
    get:
      operationId: listVmrsReasonsForRepair
      description: 'Returns the catalog of VMRS Code Key 14 ("Reason for Repair") reference

        values. Use this to populate dropdowns and validate reason-for-repair

        values before sending them on case/line item write endpoints.


        The response payload is byte-identical to the equivalent route under

        `service_management` — both URLs are served by the same backend

        controller. Results are sorted by `code` (ascending), with `reason` as a

        deterministic tiebreaker. Each record also carries a `category` attribute

        (the VMRS `repair_type` grouping the reason belongs to).

        '
      summary: List all VMRS Reasons for Repair (Code Key 14)
      tags:
      - VMRS
      parameters:
      - name: srm_account_id
        in: path
        required: true
        description: The SRM Account ID.
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
        description: Sets the desired `page` when encountering larger result sets.
      - name: page[size]
        in: query
        required: false
        schema:
          type: integer
          default: 25
          minimum: 1
        description: Sets the desired maximum number of results per page.
      responses:
        '200':
          description: Returns the list of VMRS Reasons for Repair.
          content:
            application/vnd.api+json:
              example:
                data:
                - id: '01'
                  type: decisiv_vmrs_reasons_for_repair
                  attributes:
                    code_key: '14'
                    code_key_name: Reason for Repair
                    code: '01'
                    description: Breakdown
                    category: Maintenance
                - id: '22'
                  type: decisiv_vmrs_reasons_for_repair
                  attributes:
                    code_key: '14'
                    code_key_name: Reason for Repair
                    code: '22'
                    description: Vandalism
                    category: Outside Influence
                - id: '70'
                  type: decisiv_vmrs_reasons_for_repair
                  attributes:
                    code_key: '14'
                    code_key_name: Reason for Repair
                    code: '70'
                    description: Tow-in
                    category: Management Decision
                meta:
                  record-count: 60
              schema:
                $ref: '#/components/schemas/vmrs_reasons_for_repair'
        '401':
          description: This response may occur when the access token provided within the Authorization header has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: The authenticated user does not have the `vmrs:ReadReasonsForRepair` permission for the requested account.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: Account not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '404'
                  title: Record not found
                  source:
                    parameter: srm_account_id
              schema:
                $ref: '#/components/schemas/errors_response'
        '428':
          description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '428'
                  code: decisiv:access:003
                  title: Precondition required
                  detail: OAuth Application does not have appropriate provisioning to access this resource
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /asset_management/{srm_account_id}/v1/vmrs/repair_priorities:
    get:
      operationId: listVmrsRepairPriorities
      description: 'Returns the catalog of VMRS Code Key 16 ("Repair Priority Class")

        reference values. Use this to populate dropdowns and validate

        repair-priority values before sending them on case/line item write

        endpoints.


        The response payload is byte-identical to the equivalent route under

        `service_management` — both URLs are served by the same backend

        controller. Results are sorted by `code` (ascending).

        '
      summary: List all VMRS Repair Priorities (Code Key 16)
      tags:
      - VMRS
      parameters:
      - name: srm_account_id
        in: path
        required: true
        description: The SRM Account ID.
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
        description: Sets the desired `page` when encountering larger result sets.
      - name: page[size]
        in: query
        required: false
        schema:
          type: integer
          default: 25
          minimum: 1
        description: Sets the desired maximum number of results per page.
      responses:
        '200':
          description: Returns the list of VMRS Repair Priorities.
          content:
            application/vnd.api+json:
              example:
                data:
                - id: '1'
                  type: decisiv_vmrs_repair_priorities
                  attributes:
                    code_key: '16'
                    code_key_name: Repair Priority Class
                    code: '1'
                    description: Scheduled
                - id: '2'
                  type: decisiv_vmrs_repair_priorities
                  attributes:
                    code_key: '16'
                    code_key_name: Repair Priority Class
                    code: '2'
                    description: Non-Scheduled
                - id: '3'
                  type: decisiv_vmrs_repair_priorities
                  attributes:
                    code_key: '16'
                    code_key_name: Repair Priority Class
                    code: '3'
                    description: Emergency
                meta:
                  record-count: 3
              schema:
                $ref: '#/components/schemas/vmrs_repair_priorities'
        '401':
          description: This response may occur when the access token provided within the Authorization header has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: The authenticated user does not have the `vmrs:ReadRepairPriorities` permission for the requested account.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: Account not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '404'
                  title: Record not found
                  source:
                    parameter: srm_account_id
              schema:
                $ref: '#/components/schemas/errors_response'
        '428':
          description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '428'
                  code: decisiv:access:003
                  title: Precondition required
                  detail: OAuth Application does not have appropriate provisioning to access this resource
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /asset_management/{srm_account_id}/v1/vmrs/repair_sites:
    get:
      operationId: listVmrsRepairSites
      description: 'Returns the catalog of VMRS Code Key 17 ("Repair Site") reference values.

        Use this to populate dropdowns and validate repair-site values before

        sending them on case/line item write endpoints.


        The response payload is byte-identical to the equivalent route under

        `service_management` — both URLs are served by the same backend

        controller. Results are sorted by `code` (ascending).

        '
      summary: List all VMRS Repair Sites (Code Key 17)
      tags:
      - VMRS
      parameters:
      - name: srm_account_id
        in: path
        required: true
        description: The SRM Account ID.
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
        description: Sets the desired `page` when encountering larger result sets.
      - name: page[size]
        in: query
        required: false
        schema:
          type: integer
          default: 25
          minimum: 1
        description: Sets the desired maximum number of results per page.
      responses:
        '200':
          description: Returns the list of VMRS Repair Sites.
          content:
            application/vnd.api+json:
              example:
                data:
                - id: '1'
                  type: decisiv_vmrs_repair_sites
                  attributes:
                    code_key: '17'
                    code_key_name: Repair Site
                    code: '1'
                    description: Facility (Fleet)
                - id: '2'
                  type: decisiv_vmrs_repair_sites
                  attributes:
                    code_key: '17'
                    code_key_name: Repair Site
                    code: '2'
                    description: Field
                - id: '3'
                  type: decisiv_vmrs_repair_sites
                  attributes:
                    code_key: '17'
                    code_key_name: Repair Site
                    code: '3'
                    description: Terminal
                meta:
                  record-count: 3
              schema:
                $ref: '#/components/schemas/vmrs_repair_sites'
        '401':
          description: This response may occur when the access token provided within the Authorization header has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: The authenticated user does not have the `vmrs:ReadRepairSites` permission for the requested account.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: Account not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '404'
                  title: Record not found
                  source:
                    parameter: srm_account_id
              schema:
                $ref: '#/components/schemas/errors_response'
        '428':
          description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '428'
                  code: decisiv:access:003
                  title: Precondition required
                  detail: OAuth Application does not have appropriate provisioning to access this resource
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /asset_management/{srm_account_id}/v1/vmrs/components:
    get:
      operationId: listVmrsComponents
      description: 'Returns the catalog of VMRS Code Key 33 ("Component") reference values.

        Use this to populate dropdowns and validate `component` values before

        sending them on case/line item write endpoints.


        The response payload is byte-identical to the equivalent route under

        `service_management` — both URLs are served by the same backend

        controller. Results are sorted by `code` (ascending).

        '
      summary: List all VMRS Components (Code Key 33)
      tags:
      - VMRS
      parameters:
      - name: srm_account_id
        in: path
        required: true
        description: The SRM Account ID.
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
        description: Sets the desired `page` when encountering larger result sets.
      - name: page[size]
        in: query
        required: false
        schema:
          type: integer
          default: 25
          minimum: 1
        description: Sets the desired maximum number of results per page.
      responses:
        '200':
          description: Returns the list of VMRS Components.
          content:
            application/vnd.api+json:
              example:
                data:
                - id: 000-000-000
                  type: decisiv_vmrs_components
                  attributes:
                    code_key: '33'
                    code_key_name: Component
                    code: 000-000-000
                    description: Cab, Climate Control, Instrumentation, & Aerodynamic Devices Group
                - id: 001-000-000
                  type: decisiv_vmrs_components
                  attributes:
                    code_key: '33'
                    code_key_name: Component
                    code: 001-000-000
                    description: Air Conditioning, Heating & Ventilating System
                meta:
                  record-count: 2
              schema:
                $ref: '#/components/schemas/vmrs_components'
        '401':
          description: This response may occur when the access token provided within the Authorization header has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: The authenticated user does not have the `vmrs:ReadComponents` permission for the requested account.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: Account not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '404'
                  title: Record not found
                  source:
                    parameter: srm_account_id
              schema:
                $ref: '#/components/schemas/errors_response'
        '428':
          description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '428'
                  code: decisiv:access:003
                  title: Precondition required
                  detail: OAuth Application does not have appropriate provisioning to access this resource
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /asset_management/{srm_account_id}/v1/vmrs/operator_reports:
    get:
      operationId: listVmrsOperatorReports
      description: 'Returns the catalog of VMRS Code Key 82 ("Operator Vehicle/Equipment

        Condition Report") reference values. Use this to populate dropdowns and

        validate `operator_reports` values before sending them on line item /

        estimate write endpoints.


        The response payload is byte-identical to the equivalent route under

        `service_management` — both URLs are served by the same backend

        controller. Results are sorted by `code` (ascending).

        '
      summary: List all VMRS Operator Reports (Code Key 82)
      tags:
      - VMRS
      parameters:
      - name: srm_account_id
        in: path
        required: true
        description: The SRM Account ID.
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
        description: Sets the desired `page` when encountering larger result sets.
      - name: page[size]
        in: query
        required: false
        schema:
          type: integer
          default: 25
          minimum: 1
        description: Sets the desired maximum number of results per page.
      responses:
        '200':
          description: Returns the list of VMRS Operator Reports.
          content:
            application/vnd.api+json:
              example:
                data:
                - id: '001'
                  type: decisiv_vmrs_operator_reports
                  attributes:
                    code_key: '82'
                    code_key_name: Operator Vehicle/Equipment Condition Report
                    code: '001'
                    description: Aim/Alignment (Out of Adjustment)
                - id: '050'
                  type: decisiv_vmrs_operator_reports
                  attributes:
                    code_key: '82'
                    code_key_name: Operator Vehicle/Equipment Condition Report
                    code: '050'
                    description: Brakes, Grabbing
                - id: '190'
                  type: decisiv_vmrs_operator_reports
                  attributes:
                    code_key: '82'
                    code_key_name: Operator Vehicle/Equipment Condition Report
                    code: '190'
                    description: ABS, Light Stays On
                meta:
                  record-count: 136
              schema:
                $ref: '#/components/schemas/vmrs_operator_reports'
        '401':
          description: This response may occur when the access token provided within the Authorization header has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: The authenticated user does not have the `vmrs:ReadOperatorReports` permission for the requested account.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: Account not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '404'
                  title: Record not found
                  source:
                    parameter: srm_account_id
              schema:
                $ref: '#/components/schemas/errors_response'
        '428':
          description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '428'
                  code: decisiv:access:003
                  title: Precondition required
                  detail: OAuth Application does not have appropriate provisioning to access this resource
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /asset_management/{srm_account_id}/v1/vmrs/positions:
    get:
      operationId: listVmrsPositions
      description: 'Returns the catalog of VMRS Code Key 79 ("Position") reference values.

        Use this to populate dropdowns and validate `positions` values before

        sending them on line item / estimate write endpoints.


        Results are sorted by `code` (ascending).

        '
      summary: List all VMRS Positions (Code Key 79)
      tags:
      - VMRS
      parameters:
      - name: srm_account_id
        in: path
        required: true
        description: The SRM Account ID.
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
        description: Sets the desired `page` when encountering larger result sets.
      - name: page[size]
        in: query
        required: false
        schema:
          type: integer
          default: 25
          minimum: 1
        description: Sets the desired maximum number of results per page.
      responses:
        '200':
          description: Returns the list of VMRS Positions.
          content:
            application/vnd.api+json:
        

# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/decisiv/refs/heads/main/openapi/decisiv-vmrs-api-openapi.yml