Trimble Rate Sheets API

List rate sheets

GitHub OpenAPI

Operations 5

GET /rateSheets List rate sheets #
POST /rateSheets Create a rate sheet #
GET /rateSheets/{rateSheetId} Get a rate sheet #
PUT /rateSheets/{rateSheetId} Update a rate sheet #
DELETE /rateSheets/{rateSheetId} Delete a rate sheet #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/trimble:trimble-ratesheets-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

trimble-ratesheets-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: MasterData Rate Sheets API
  description: 'The Master Data management API allows for an external system to create, retrieve, update or delete TruckMate configuration data, such as Client, Vendor and Driver profiles, as well as sites, zones, commodity codes etc.


    Download latest released OpenAPI


    This documentation is based on the most currently released version of TruckMate. Documentation for previous versions can be accessed by navigating to the openapi.json endpoint for any given API (the service must be set up and running). For example: http://DOMAIN/openapi.json


    ---


    © 2026, Trimble Inc. All rights reserved. Unauthorized copying prohibited. Software functions, including our APIs and their specification, are subject to change without notice. Information contained herein is Trimble Confidential Information, used under license.


    ---'
  version: '1'
  x-tm-release: 26.3.125.0
tags:
- name: RateSheets
  description: List rate sheets
paths:
  /rateSheets:
    get:
      summary: List rate sheets
      description: Returns a paginated list of rate sheets.
      operationId: GetRateSheets
      security:
      - truckmateApiKeyAuth: []
      - tidJwtAuth: []
      tags:
      - RateSheets
      parameters:
      - name: expand
        in: query
        description: Expand applicable sub-resources separated by comma.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - multiPointRates
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRateSheets200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    post:
      summary: Create a rate sheet
      description: Creates a new rate sheet.
      operationId: PostRateSheet
      security:
      - truckmateApiKeyAuth: []
      tags:
      - RateSheets
      requestBody:
        description: A JSON object containing the properties of the rate sheet to be created.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefRateSheetPostRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostRateSheet201'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /rateSheets/{rateSheetId}:
    parameters:
    - name: rateSheetId
      in: path
      description: The unique identifier for the rate sheet.
      required: true
      schema:
        type: integer
    get:
      summary: Get a rate sheet
      description: Returns a single rate sheet.
      operationId: GetRateSheet
      security:
      - truckmateApiKeyAuth: []
      - tidJwtAuth: []
      tags:
      - RateSheets
      parameters:
      - name: expand
        in: query
        description: Expand applicable sub-resources separated by comma.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - multiPointRates
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rateSheet'
                - type: object
                  properties:
                    href:
                      type: string
                      readOnly: true
                      description: Self-referencing URL for this resource
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    put:
      summary: Update a rate sheet
      description: Updates an existing rate sheet.
      operationId: PutRateSheet
      security:
      - truckmateApiKeyAuth: []
      tags:
      - RateSheets
      requestBody:
        description: A JSON object containing the properties of the rate sheet to be updated.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefRateSheetPutRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rateSheet'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    delete:
      summary: Delete a rate sheet
      description: Deletes a rate sheet.
      operationId: DeleteRateSheet
      security:
      - truckmateApiKeyAuth: []
      tags:
      - RateSheets
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
components:
  parameters:
    offset:
      name: offset
      in: query
      description: Specifies the number of items to skip before beginning to select the records to return.
      required: false
      style: form
      explode: true
      schema:
        type: integer
        default: 0
    select:
      name: $select
      in: query
      description: Select allows to request a specified set of properties, see [Selecting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#_Toc31361040)
      required: false
      style: form
      explode: true
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: Specifies the maximum number of items to include in the response results.
      required: false
      style: form
      explode: true
      schema:
        type: integer
        default: 20
    orderBy:
      name: $orderBy
      in: query
      description: Field(s) to order returned resource by, with optional direction. E.g., "fieldName desc, fieldName2"
      required: false
      style: form
      explode: true
      schema:
        type: string
    filter:
      name: $filter
      in: query
      description: Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter). Note, not all features of oData filter syntax are supported.
      required: false
      style: form
      explode: true
      schema:
        type: string
  schemas:
    rateSheet:
      type: object
      properties:
        rateSheetId:
          type: integer
        rateName:
          type: string
          maxLength: 80
        effectiveDate:
          type:
          - string
          - 'null'
          description: 'DateTime: yyyy-MM-ddThh:mm:ss'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        expiryDate:
          type:
          - string
          - 'null'
          description: 'DateTime: yyyy-MM-ddThh:mm:ss'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        approved:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        rateUnit:
          type: string
          maxLength: 3
        rateFactor:
          type:
          - number
          - 'null'
        breakUnit:
          type: string
          maxLength: 3
        currency:
          type: string
          maxLength: 3
        allowBetweenZones:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        allowZoneTree:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        incrementalRating:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        useAsRating:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        sheetType:
          type: string
          enum:
          - pointToPoint
          - mileage
          - vendorSplit
          - contractBilling
          - list
          - multiPoint
          - ''
        createdBy:
          type: string
          maxLength: 128
        editUser:
          type: string
          maxLength: 128
        editDate:
          type:
          - string
          - 'null'
          description: 'DateTime: yyyy-MM-ddThh:mm:ss'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        multiPointRates:
          $ref: '#/components/schemas/RateSheetMultiPointRates'
    RateSheetBreak:
      type: object
      properties:
        breakIndex:
          type:
          - integer
          - 'null'
          minimum: 1
          maximum: 40
        description:
          type: string
          maxLength: 10
        breakValue:
          type:
          - number
          - 'null'
        isMinimum:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        isMaximum:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        isBase:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
      required:
      - breakIndex
    ARTError:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        code:
          type: string
          description: Error code (optional, deprecated; omitted in Mobile Comm)
          deprecated: true
        description:
          type: string
          description: Human-readable description (optional, deprecated; omitted in Mobile Comm)
          deprecated: true
    RefRateSheetPostRequest:
      type: object
      properties:
        sheetType:
          type: string
          enum:
          - multiPoint
        rateName:
          type: string
          maxLength: 80
        effectiveDate:
          type:
          - string
          - 'null'
          description: 'DateTime: yyyy-MM-ddThh:mm:ss'
          pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        expiryDate:
          type:
          - string
          - 'null'
          description: 'DateTime: yyyy-MM-ddThh:mm:ss'
          pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        approved:
          type: string
          enum:
          - 'False'
          - 'True'
        rateUnit:
          type: string
          maxLength: 3
        rateFactor:
          type:
          - number
          - 'null'
        breakUnit:
          type: string
          maxLength: 3
        currency:
          type: string
          maxLength: 3
        allowBetweenZones:
          type: string
          enum:
          - 'False'
          - 'True'
        allowZoneTree:
          type: string
          enum:
          - 'False'
          - 'True'
        incrementalRating:
          type: string
          enum:
          - 'False'
          - 'True'
        useAsRating:
          type: string
          enum:
          - 'False'
          - 'True'
        multiPointRates:
          $ref: '#/components/schemas/RateSheetMultiPointRates'
      required:
      - sheetType
    GetRateSheets200:
      type: object
      properties:
        href:
          type: string
          readOnly: true
          description: Self-referencing URL for this resource
        offset:
          type: integer
        limit:
          type: integer
        filter:
          type: string
        sort:
          type: string
        select:
          type: string
        count:
          type: integer
        rateSheets:
          type: array
          items:
            $ref: '#/components/schemas/rateSheet'
    RefRateSheetPutRequest:
      type: object
      properties:
        sheetType:
          type: string
          enum:
          - multiPoint
        rateName:
          type: string
          maxLength: 80
        effectiveDate:
          type:
          - string
          - 'null'
          description: 'DateTime: yyyy-MM-ddThh:mm:ss'
          pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        expiryDate:
          type:
          - string
          - 'null'
          description: 'DateTime: yyyy-MM-ddThh:mm:ss'
          pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        approved:
          type: string
          enum:
          - 'False'
          - 'True'
        rateUnit:
          type: string
          maxLength: 3
        rateFactor:
          type:
          - number
          - 'null'
        breakUnit:
          type: string
          maxLength: 3
        currency:
          type: string
          maxLength: 3
        allowBetweenZones:
          type: string
          enum:
          - 'False'
          - 'True'
        allowZoneTree:
          type: string
          enum:
          - 'False'
          - 'True'
        incrementalRating:
          type: string
          enum:
          - 'False'
          - 'True'
        useAsRating:
          type: string
          enum:
          - 'False'
          - 'True'
        multiPointRates:
          $ref: '#/components/schemas/RateSheetMultiPointRates'
    ARTErrors:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
          enum:
          - 400
          - 401
          - 403
          - 404
          - 405
          - 409
          - 429
          - 500
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ARTError'
    RateSheetRate:
      type: object
      properties:
        breakIndex:
          type:
          - integer
          - 'null'
        amount:
          type:
          - number
          - 'null'
    RateSheetRow:
      type: object
      properties:
        rowId:
          type: integer
          readOnly: true
        originZone:
          type: string
        destinationZone:
          type: string
        sequence:
          type:
          - integer
          - 'null'
        rates:
          type: array
          items:
            $ref: '#/components/schemas/RateSheetRate'
    PostRateSheet201:
      type: object
      properties:
        rateSheets:
          type: array
          items:
            $ref: '#/components/schemas/rateSheet'
    RateSheetMultiPointRates:
      type: object
      properties:
        breaks:
          type: array
          items:
            $ref: '#/components/schemas/RateSheetBreak'
        rows:
          type: array
          items:
            $ref: '#/components/schemas/RateSheetRow'
  securitySchemes:
    tidJwtAuth:
      type: http
      description: A time-limited JSON Web Token generated via separate POST request using TID
      scheme: bearer
    webuserJwtAuth:
      type: http
      description: A fresh JSON Web Token expires in four hours. It can be renewed by making a GET request to /login endpoint, or generated by making a POST request to /login endpoint
      scheme: bearer
    truckmateApiKeyAuth:
      type: http
      description: TruckMate API Key
      scheme: bearer
externalDocs:
  url: https://learn.transportation.trimble.com/