Decisiv Registered Assets API

openapi: 3.2.0
info:
  title: Decisiv Registered Assets 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 Registered Assets 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: Registered Assets
paths:
  /asset_management/{srm_account_id}/v1/registered_assets:
    get:
      operationId: listRegisteredAssets
      description: Lists all registered assets from the requested account.
      summary: List all Registered Assets from the requested account
      tags:
      - Registered Assets
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: filter[serial_number]
        in: query
        required: false
        schema:
          type: string
          minLength: 8
          maxLength: 9
        description: List `registered assets` matching the *exact* `serial_number` attribute.
      - name: filter[unit_number]
        in: query
        required: false
        schema:
          type: string
        description: List `registered assets` matching the *exact* `unit_number` attribute.
      - name: filter[chassis_id]
        in: query
        required: false
        schema:
          type: string
        description: List `registered assets` matching the *exact* `chassis_id` attribute.
      - name: filter[vin]
        in: query
        required: false
        schema:
          type: string
          minLength: 17
          maxLength: 17
        description: List `registered assets` matching the *exact* `vin` attribute.
      - name: filter[depot.id]
        in: query
        required: false
        schema:
          type: string
        description: List `registered assets` matching the *exact* `depot.id` attribute.
      - name: filter[license.number]
        in: query
        required: false
        schema:
          type: string
        description: List `registered assets` matching the *exact* `license.number` attribute.
      - name: page[number]
        in: query
        required: false
        schema:
          type: number
        description: Sets the desired `page` when encountering larger result sets
      - name: page[size]
        in: query
        required: false
        schema:
          type: number
        description: Sets the desired maximum number of results per page
      - name: include
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - depot
            - srm_verified_asset
            - extended_asset_attributes
        description: The relationships to be included.
      - name: sort
        in: query
        required: false
        schema:
          type: string
        examples:
          Ascending:
            value: year
            summary: Single attribute ascending
          Descending:
            value: -year
            summary: Single attribute descending
          Multiple:
            value: -year,make
            summary: Multiple attributes combined
        description: 'Sort `registered_assets` by one or more attributes separated by commas; prefix with `-` for descending order. Valid attributes: `year`, `make`, `model`'
      responses:
        '200':
          description: Returns list of registered assets
          content:
            application/vnd.api+json:
              example:
                data:
                - id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768
                  type: registered_assets
                  attributes:
                    vin: 1FDWE3FNXMDC03939
                    serial_number: MDC03939
                    unit_number: '42'
                    chassis_id: XMDC03939
                    fleet_info: Fleet 42
                    make: Ford
                    model: E350
                    year: 2021
                    engine:
                      make: Ford
                      model: 7.3L V-10
                      displacement: 6.8 l
                      serial_number: '123456789'
                    odometer_value: 61342
                    odometer_unit: mi
                    engine_hours: 1363
                    stand_by_hours: null
                    switch_on_hours: null
                    notes: My notes about this vehicle
                    license:
                      number: HMB-0000
                      state: PA
                      country: US
                      expiration: '2029-06-18'
                    vmrs_asset_status: '02'
                    vmrs:
                      asset_type:
                        code_key: '2'
                        code: D
                    metadata:
                      series: 24SK
                      sale_date: '2021-01-06'
                      car_class_code: FSTK
                      vehicle_status: TC
                      country_iso_code: USA
                      vehicle_use_code: DR
                      car_class_description: 24FT Huge Truck
                      physical_location_ps_org_id: '12345'
                    gvwr:
                      value: '100'
                      unit_of_measure: kg
                  relationships:
                    depot:
                      data:
                        type: depots
                        id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44
                    srm_verified_asset:
                      data:
                        type: srm_verified_assets
                        id: a6cfb121-5e78-4ec4-a7ea-223900c76607
                    extended_asset_attributes:
                      data: []
                - id: 3810e97f-5b23-4c7b-a605-8ad93c192d45
                  type: registered_assets
                  attributes:
                    serial_number: CRR-8842
                    unit_number: REEFER-01
                    make: Carrier
                    model: X4 7300
                    year: 2022
                    engine_hours: 1140
                    stand_by_hours: 20
                    switch_on_hours: 2000
                    notes: Refrigeration unit
                    vmrs_asset_status: '01'
                    vmrs:
                      asset_type:
                        code_key: '2'
                        code: R
                    metadata:
                      series: REEFER-X
                  relationships:
                    depot:
                      data:
                        type: depots
                        id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44
                    srm_verified_asset:
                      data: null
                    extended_asset_attributes:
                      data: []
              schema:
                $ref: '#/components/schemas/registered_assets'
        '400':
          description: This response may occur when an invalid request has been provided to the server.  The request may be corrected by the consumer and resubmitted. / Account filter is missing
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_response'
              examples:
                ? This response may occur when an invalid request has been provided to the server.  The request may be corrected by the consumer and resubmitted.
                : value:
                    errors:
                    - title: Filter not allowed
                      detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}'
                      code: decisiv:filters:001
                      status: '400'
                      source:
                        parameter: filter[filter_name]
                Account filter is missing:
                  value:
                    errors:
                    - title: Required filter is missing
                      detail: 'Required filter must be provided. Valid required filters: srm_account_id'
                      code: decisiv:filters:006
                      status: '400'
                      source:
                        parameter: filter[srm_account_id]
                Invalid depot filter format:
                  value:
                    errors:
                    - title: Invalid Filter Format
                      detail: Invalid format for `depot.id`
                      code: decisiv:filters:009
                      status: '400'
                      source:
                        parameter: filter[depot.id]
        '401':
          description: This response may occur when the access token provided within the Authorization token 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: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
          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: This response may occur when the requested resource is not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '404'
                  code: decisiv:resource:001
                  title: Resource Identifier - Not Found
                  detail: The parent resource could not be found
                  source:
                    parameter: srm_account_id
              schema:
                $ref: '#/components/schemas/errors_response'
        '409':
          description: This response may occur when the request conflict with the current state of the target resource.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '409'
                  code: decisiv:registered_asset:009
                  title: Resource Identifier - Deactivated Asset
                  detail: Operations on deactivated assets are inaccessible through this interface.
                  source:
                    parameter: srm_account_id
              schema:
                $ref: '#/components/schemas/errors_response'
        '424':
          description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Failed Dependency
                  detail: Failed Dependency
                  code: '424'
                  status: '424'
              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'
    post:
      summary: Create a new Registered Asset
      operationId: createRegisteredAsset
      description: Creates a new Registered Asset for the requested account.
      tags:
      - Registered Assets
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: X-DECISIV-SILENCE-EVENTS
        in: header
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - asset:registered
            - decisiv:asset_management:asset:registered
        description: Corresponding webhook events which can be muted for the given transaction
      responses:
        '200':
          description: Returns the created registered asset
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768
                  type: registered_assets
                  attributes:
                    vin: 1FDWE3FNXMDC03939
                    serial_number: MDC03939
                    unit_number: '42'
                    chassis_id: XMDC03939
                    fleet_info: Fleet 42
                    make: Ford
                    model: E350
                    year: 2021
                    engine:
                      make: Ford
                      model: 7.3L V-10
                      displacement: 6.8 l
                      serial_number: '123456789'
                    odometer_value: 61342
                    odometer_unit: mi
                    engine_hours: 1363
                    stand_by_hours: null
                    switch_on_hours: null
                    notes: My notes about this vehicle
                    license:
                      number: HMB-0000
                      state: PA
                      country: US
                      expiration: '2029-06-18'
                    vmrs_asset_status: '02'
                    vmrs:
                      asset_type:
                        code_key: '2'
                        code: D
                    metadata:
                      series: 24SK
                      sale_date: '2021-01-06'
                      car_class_code: FSTK
                      vehicle_status: TC
                      country_iso_code: USA
                      vehicle_use_code: DR
                      car_class_description: 24FT Huge Truck
                      physical_location_ps_org_id: '12345'
                    gvwr:
                      value: '100'
                      unit_of_measure: kg
                  relationships:
                    depot:
                      data:
                        type: depots
                        id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44
                    srm_verified_asset:
                      data:
                        type: srm_verified_assets
                        id: a6cfb121-5e78-4ec4-a7ea-223900c76607
                    extended_asset_attributes:
                      data: []
              schema:
                $ref: '#/components/schemas/registered_asset'
        '400':
          description: Account filter is missing / Missing required field - serial_number / Missing required field - make / Missing required field - model / Missing required field - year / Missing depot relationship / Invalid depot UUID format / GVWR invalid type / GVWR missing key / Engine serial number invalid type / Engine serial number exceeds max length / Invalid silence event value / Invalid request attribute
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_response'
              examples:
                Account filter is missing:
                  value:
                    errors:
                    - title: Required filter is missing
                      detail: 'Required filter must be provided. Valid required filters: srm_account_id'
                      code: decisiv:filters:006
                      status: '400'
                      source:
                        parameter: filter[srm_account_id]
                Missing required field - serial_number:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:001
                      title: Missing required attribute key
                      detail: Required key not provided in request body
                      source:
                        pointer: /data/attributes/serial_number
                Missing required field - make:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:001
                      title: Missing required attribute key
                      detail: Required key not provided in request body
                      source:
                        pointer: /data/attributes/make
                Missing required field - model:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:001
                      title: Missing required attribute key
                      detail: Required key not provided in request body
                      source:
                        pointer: /data/attributes/model
                Missing required field - year:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:001
                      title: Missing required attribute key
                      detail: Required key not provided in request body
                      source:
                        pointer: /data/attributes/year
                Missing depot relationship:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:relationships:002
                      title: Missing required relationship
                      detail: The required relationship {{relationship_name}} is missing
                      source:
                        pointer: /data/relationships/depot
                Invalid depot UUID format:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:011
                      title: Invalid Attribute Pattern
                      detail: Attribute value must match pattern '{{pattern}}'
                      source:
                        pointer: /data/relationships/depot/data/id
                GVWR invalid type:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:002
                      title: Missing required attribute value
                      detail: Required key must be populated
                      source:
                        pointer: /data/attributes/gvwr
                GVWR missing key:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:001
                      title: Missing required attribute key
                      detail: Required key not provided in request body
                      source:
                        pointer: /data/attributes/gvwr
                Engine serial number invalid type:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:002
                      title: Missing required attribute value
                      detail: Required key must be populated
                      source:
                        pointer: /data/attributes/engine/serial_number
                Engine serial number exceeds max length:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:014
                      title: Character Limit Exceeded
                      detail: Field length can not exceed {{limit}} characters
                      source:
                        pointer: /data/attributes/engine/serial_number
                Invalid silence event value:
                  value:
                    errors:
                    - title: Bad Request
                      detail: Invalid value for X-DECISIV-SILENCE-EVENTS header
                      code: decisiv:silence_webhook_events:001
                      status: '400'
                Invalid request attribute:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:009
                      title: Attribute Not Allowed
                      detail: invalid_attribute is not allowed
                      source:
                        pointer: /data/attributes/invalid_attribute
        '401':
          description: This response may occur when the access token provided within the Authorization token 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: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
          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: This response may occur when the requested resource is not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '404'
                  code: decisiv:resource:001
                  title: Resource Identifier - Not Found
                  detail: The parent resource could not be found
                  source:
                    parameter: id
              schema:
                $ref: '#/components/schemas/errors_response'
        '422':
          description: Missing identifier / Invalid VIN length / Invalid VIN check digit / Invalid VIN character I / Invalid VIN character O / Invalid VIN character Q / Invalid VIN character format / Serial number below minimum length / Serial number exceeds maximum length / Serial number VIN mismatch / Invalid year range / Missing odometer unit / Invalid odometer unit / Invalid metadata key / Invalid metadata value / Too many metadata keys / GVWR invalid unit / GVWR value required / GVWR unit_of_measure required / Depot not in fleet / Depot belongs to different fleet / Invalid country / Empty country / Empty state / Invalid license state / State does not match country / License expiration date / Invalid vmrs asset status / Invalid vmrs.asset_type.code / Invalid vmrs.asset_type.code_key
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_response'
              examples:
                Missing identifier:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:registered_asset:010
                      title: Missinsg Required Fields
                      detail: 'At least one of the following fields should be present: vin, chassis_id, unit_number'
                      source:
                        pointer: /data/attributes
                Invalid VIN length:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:vins:002
                      title: Invalid length
                      detail: Provided VIN attribute must be 17 digits in length
                      source:
                        pointer: /data/attributes/vin
                Invalid VIN check digit:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:vins:001
                      title: Invalid check digit
                      detail: Provided VIN attribute has an invalid check digit.
                      source:
                        pointer: /data/attributes/vin
                Invalid VIN character I:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:vins:003
                      title: Invalid character I
                      detail: Provided VIN attribute has an invalid character I.
                      source:
                        pointer: /data/attributes/vin
                Invalid VIN character O:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:vins:004
                      title: Invalid character O
                      detail: Provided VIN attribute has an Invalid character O.
                      source:
                        pointer: /data/attributes/vin
                Invalid VIN character Q:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:vins:005
                      title: Invalid character Q
                      detail: Provided VIN attribute has an Invalid character Q.
                      source:
                        pointer: /data/attributes/vin
                Invalid VIN character format:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:vins:006
                      title: Invalid format
                      detail: Provided VIN attribute has an invalid format.
                      source:
                        pointer: /data/attributes/vin
                Serial number below minimum length:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:request_attributes:015
                      title: Field Length Within Limit
                      detail: Field length must be at least {{limit}} characters
                      source:
                        pointer: /data/attributes/serial_number
                Serial number exceeds maximum length:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:request_attributes:014
                      title: Character Limit Exceeded
                      detail: Field length can not exceed {{limit}} characters
                      source:
                        pointer: /data/attributes/serial_number
                Serial number VIN mismatch:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:vin_based_asset:002
                      title: Invalid Serial Number
                      detail: Provided serial number must match the last 8-9 digits of the provided vin attribute
                      source:
                        pointer: /data/attributes/serial_number
                Invalid year range:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:request_attributes:016
                      title: Invalid Year
                      detail: Provided year value is outside of the supported range - {{range}}
                      source:
                        pointer: /data/attributes/year
                Missing odometer unit:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:registered_asset:011
                      title: Required odometer_unit value.
                      detail: An odometer_unit value is required when providing an odometer reading.
                      source:
                        pointer: /data/attributes/odometer_unit
                Invalid odometer unit:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:registered_asset:012
                      title: Invalid odometer_unit value.
                      detail: 'Invalid value for odometer_unit. Valid values: {{valid_odometer_units}}'
                      source:
                        pointer: /data/attributes/odometer_unit
                Invalid metadata key:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:metadata:001
                      title: Invalid Metadata key
                      detail: null
                      source:
                        pointer: /data/attributes/metadata
                Invalid metadata value:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:metadata:002
                      title: Invalid Metadata value
                      detail: null
                      source:
                        pointer: /data/attributes/metadata
                Too many metadata keys:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:metadata:003
                      title: Metadata object is too big
                      detail: null
                      source:
                        pointer: /data/attributes/metadata
                GVWR invalid unit:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:base:unexpected_value:103
                      title: Unexpected Value
                      detail: Value provided for unit_of_measure is not supported. Valid values are kg, lb
                      source:
                        pointer: /data/attributes/gvwr/unit_of_measure
                GVWR value required:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:request_attributes:001
                      title: Missing required attribute key
                      detail: Required key not provided in request body
                      source:
                        pointer: /data/attributes/gvwr/value
                GVWR unit_of_measure required:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:request_attributes:001
                      title: Missing required attribute key
                      detail: Required key not provided in request body
                      source:
                        pointer: /data/attributes/gvwr/unit_of_measure
                Depot not in fleet:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:registered_asset:100
                      title: Depot Identifier Not Found
                      detail: Depot Identifier does not exist for this Asset Management Account
                      source:
                        pointer: /data/relationships/depot/data/id
                Depot belongs to different fleet:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:request_attributes:003
                      title: Identifier Not Found
                      detail: This object is not from the same account
                      source:
                        pointer: /data/relationships/depot/data/id
                Invalid country:
                  value:
                    errors:
                  

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