Trimble Currency Rates API

openapi: 3.2.0
info:
  title: Finance REST Currency Rates API
  description: 'Secure, authorized access to TruckMate''s financial data, including Payroll, Accounts Payable (AP), Accounts Receivable (AR), and General Ledger (GL) data.


    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: Currency Rates
  description: Retrieves, creates, updates and deletes TruckMate currency rates. Currency rate information can be viewed in the GL Chart of Accounts application > Currency tab and Driver Pay Contracts application > Exchange Rates button.
paths:
  /currencyRates:
    get:
      summary: Retrieves currency rates
      description: 'Retrieves currency rate records.


        Currency rate information can be viewed in the GL Chart of Accounts application > Currency tab and


        Driver Pay Contracts application > Exchange Rates button.


        This endpoint is available in TruckMate 24.4 and higher.'
      operationId: GetCurrencyRates
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Currency Rates
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: expand
        in: query
        description: Expand applicable sub-resources separated by comma.
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/currencyRateLocation'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCurrencyRates200'
        '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'
    post:
      summary: Create a currency rate
      description: 'Creates one or more currency rate records.


        Currency rate information can be viewed in the GL Chart of Accounts application > Currency tab and


        Driver Pay Contracts application → Exchange Rates button.


        This endpoint is available in TruckMate 24.4 and higher.'
      operationId: PostCurrencyRates
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Currency Rates
      requestBody:
        description: Request body containing the currency rate or list of currency rates to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostDPCurrencyRateList'
      parameters:
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/currencyRateLocation'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCurrencyRates201'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /currencyRates/{currencyRateId}:
    parameters:
    - name: currencyRateId
      in: path
      description: Currency rate identifier
      required: true
      schema:
        type: integer
    get:
      summary: Retrieves a currency rate
      description: 'Retrieves a currency rate record.


        Currency rate information can be viewed in the GL Chart of Accounts application > Currency tab and


        Driver Pay Contracts application > Exchange Rates button.


        This endpoint is available in TruckMate 24.4 and higher.'
      operationId: GetCurrencyRate
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Currency Rates
      parameters:
      - $ref: '#/components/parameters/select'
      - name: expand
        in: query
        description: Expand applicable sub-resources separated by comma.
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/currencyRateLocation'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/currencyRate'
                - 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'
    put:
      summary: Update a currency rate
      description: 'Updates one or more properties for the specified currency rate record.


        Currency rate information can be viewed in the GL Chart of Accounts application > Currency tab and


        Driver Pay Contracts application > Exchange Rates button.


        This endpoint is available in TruckMate 24.4 and higher.'
      operationId: PutCurrencyRate
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Currency Rates
      requestBody:
        description: Request body containing the currency rate properties to update.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutDPCurrencyRate'
      parameters:
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/currencyRateLocation'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/currencyRate'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    delete:
      summary: Delete a currency rate
      description: 'Deletes a currency rate record.


        Currency rate information can be viewed in the GL Chart of Accounts application > Currency tab and


        Driver Pay Contracts application > Exchange Rates button.


        This endpoint is available in TruckMate 24.4 and higher.'
      operationId: DeleteCurrencyRate
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Currency Rates
      parameters:
      - $ref: '#/components/parameters/currencyRateLocation'
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          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
    currencyRateLocation:
      name: location
      in: query
      description: Specify the type of currency rate records.
      required: true
      style: form
      explode: true
      schema:
        type: string
        enum:
        - generalLedger
        - driverPay
    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:
    PutDPCurrencyRate:
      type: object
      properties:
        currencyCode:
          type: string
          maxLength: 3
        exchangeDate:
          type: string
          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))?$
        exchangeRate:
          type: number
        payType:
          type: string
          enum:
          - drop
          - pick
          - both
    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
    PostCurrencyRates201:
      type: object
      properties:
        currencyRates:
          type: array
          items:
            $ref: '#/components/schemas/currencyRate'
    PostDPCurrencyRateList:
      type: array
      items:
        $ref: '#/components/schemas/PostDPCurrencyRate'
    currencyRate:
      type: object
      properties:
        currencyCode:
          type:
          - string
          - 'null'
          maxLength: 3
        exchangeDate:
          type:
          - string
          - 'null'
          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))?$
        exchangeRate:
          type:
          - number
          - 'null'
        payType:
          type:
          - string
          - 'null'
          enum:
          - drop
          - pick
          - both
          - ''
          - null
        currencyRateId:
          type: integer
    PostDPCurrencyRate:
      type: object
      properties:
        currencyCode:
          type: string
          maxLength: 3
        exchangeDate:
          type: string
          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))?$
        exchangeRate:
          type: number
        payType:
          type: string
          enum:
          - drop
          - pick
          - both
      required:
      - currencyCode
      - exchangeRate
    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'
    GetCurrencyRates200:
      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
        currencyRates:
          type: array
          items:
            $ref: '#/components/schemas/currencyRate'
  securitySchemes:
    tidJwtAuth:
      type: http
      description: A time-limited JSON Web Token generated via separate POST request using TID
      scheme: bearer
    truckmateApiKeyAuth:
      type: http
      description: TruckMate API Key
      scheme: bearer
externalDocs:
  url: https://learn.transportation.trimble.com/