Trimble Driver Payments API

Retrieves, creates, updates and deletes TruckMate driver payments. Driver payments can be viewed in the Driver Pay Audit application > Payments tab.

GitHub OpenAPI

Operations 5

GET /driverPayments Retrieves driver payments #
POST /driverPayments Create a new driver payment #
GET /driverPayments/{driverPaymentId} Retrieves a driver payment #
PUT /driverPayments/{driverPaymentId} Update a driver payment #
DELETE /driverPayments/{driverPaymentId} Delete a driver payment #

Documentation

Specifications

Schemas & Data

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-driver-payments-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-driver-payments-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Finance REST Driver Payments 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: Driver Payments
  description: Retrieves, creates, updates and deletes TruckMate driver payments. Driver payments can be viewed in the Driver Pay Audit application > Payments tab.
paths:
  /driverPayments:
    get:
      summary: Retrieves driver payments
      description: 'Retrieves driver payment records.


        Driver payments can be viewed in the Driver Pay Audit application > Payments tab.


        This endpoint is available in TruckMate 24.3 and higher.'
      operationId: GetDriverPayments
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Driver Payments
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/orderBy'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDriverPayments200'
        '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 new driver payment
      description: 'Creates one or more driver payment records.


        driverId must have a valid Driver Pay Contract.


        Driver payments can be viewed in the Driver Pay Audit application > Payments tab.


        This endpoint is available in TruckMate 25.1 and higher.'
      operationId: PostDriverPayments
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Driver Payments
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostDriverPayList'
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostDriverPayments201'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /driverPayments/{driverPaymentId}:
    parameters:
    - name: driverPaymentId
      in: path
      description: driver payment identifier
      required: true
      schema:
        type: integer
    get:
      summary: Retrieves a driver payment
      description: 'Retrieves the specified driver payment record.


        Driver payments can be viewed in the Driver Pay Audit application > Payments tab.


        This endpoint is available in TruckMate 24.3 and higher.'
      operationId: GetDriverPayment
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Driver Payments
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/driverPayment'
                - 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 driver payment
      description: 'Updates one or more properties of the specified driver payment record.


        Driver payments can be viewed in the Driver Pay Audit application > Payments tab.


        This endpoint is available in TruckMate 25.1 and higher.'
      operationId: PutDriverPayment
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Driver Payments
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutDriverPay'
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/driverPayment'
        '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'
    delete:
      summary: Delete a driver payment
      description: 'Deletes the specified driver payment record.


        Driver payments can be viewed in the Driver Pay Audit application > Payments tab.


        This endpoint is available in TruckMate 25.1 and higher.'
      operationId: DeleteDriverPayment
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Driver Payments
      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
    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
    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
    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:
    GetDriverPayments200:
      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
        driverPayments:
          type: array
          items:
            $ref: '#/components/schemas/driverPayment'
    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
    PostDriverPayments201:
      type: object
      properties:
        driverPayments:
          type: array
          items:
            $ref: '#/components/schemas/driverPayment'
    PutDriverPay:
      type: object
      properties:
        driverId:
          type: string
          maxLength: 10
        paymentCode:
          type: string
          maxLength: 10
        paymentDescription:
          type: string
          maxLength: 80
        paymentState:
          type: string
          enum:
          - approved
          - hold
          - unapproved
        paymentDate:
          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))?$
          deprecated: true
        legDate:
          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))?$
        taxable:
          type: string
          enum:
          - 'False'
          - 'True'
        currencyCode:
          type: string
          maxLength: 3
        dropQuantity:
          type: integer
        dropRate:
          type: number
        emptyMilesQuantity:
          type: number
        emptyMilesRate:
          type: number
        hoursQuantity:
          type: number
        hoursRate:
          type: number
        layoverQuantity:
          type: integer
        layoverRate:
          type: number
        loadedMilesQuantity:
          type: number
        loadedMilesRate:
          type: number
        otherQuantity:
          type: number
        otherRate:
          type: number
        pickQuantity:
          type: integer
        pickRate:
          type: number
        percentage:
          type: number
        tarped:
          type: string
          enum:
          - 'False'
          - 'True'
        chassisId:
          type: string
          maxLength: 10
        containerId:
          type: string
          maxLength: 15
        powerUnitId:
          type: string
          maxLength: 10
        trailerId:
          type: string
          maxLength: 10
        tripNumber:
          type: integer
        legSequence:
          type: integer
        freightBillNumber:
          type: string
          maxLength: 20
        orderId:
          type: integer
        originZone:
          type: string
          maxLength: 10
        destinationZone:
          type: string
          maxLength: 10
        user1:
          type: string
          maxLength: 40
        user2:
          type: string
          maxLength: 40
        user3:
          type: string
          maxLength: 40
        user4:
          type: string
          maxLength: 40
        user5:
          type: string
          maxLength: 40
        user6:
          type: string
          maxLength: 40
        user7:
          type: string
          maxLength: 40
        user8:
          type: string
          maxLength: 40
        user9:
          type: string
          maxLength: 40
        user10:
          type: string
          maxLength: 40
    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'
    PostDriverPayList:
      type: array
      items:
        $ref: '#/components/schemas/PostDriverPay'
    driverPayment:
      type: object
      properties:
        driverPaymentId:
          type: integer
        driverId:
          type: string
          maxLength: 10
        paymentCode:
          type:
          - string
          - 'null'
          maxLength: 10
        paymentDescription:
          type:
          - string
          - 'null'
          maxLength: 80
        paymentOverridden:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        paymentState:
          type:
          - string
          - 'null'
          enum:
          - approved
          - onCheque
          - exported
          - hold
          - owed
          - posted
          - quote
          - unapproved
          - paid
          - wait
          - ''
          - null
        paymentDate:
          type:
          - string
          - 'null'
          deprecated: true
          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))?$
        legDate:
          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))?$
        taxable:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        grossPayDeduction:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        currencyCode:
          type:
          - string
          - 'null'
          maxLength: 3
        paymentTotal:
          type:
          - number
          - 'null'
        paymentFunctionalTotal:
          type:
          - number
          - 'null'
        approvedDate:
          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))?$
        paid:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        datePaid:
          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))?$
        checkDate:
          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))?$
        glAccount:
          type:
          - string
          - 'null'
          maxLength: 50
          oneOf:
          - enum:
            - ''
          - pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+){0,4}$
        contractId:
          type: integer
        ruleId:
          type: integer
        rule2Id:
          type: integer
        statementId:
          type:
          - integer
          - 'null'
        dropQuantity:
          type:
          - integer
          - 'null'
        dropRate:
          type:
          - number
          - 'null'
        emptyMilesQuantity:
          type:
          - number
          - 'null'
        emptyMilesRate:
          type:
          - number
          - 'null'
        hoursQuantity:
          type:
          - number
          - 'null'
        hoursRate:
          type:
          - number
          - 'null'
        layoverQuantity:
          type:
          - integer
          - 'null'
        layoverRate:
          type:
          - number
          - 'null'
        loadedMilesQuantity:
          type:
          - number
          - 'null'
        loadedMilesRate:
          type:
          - number
          - 'null'
        otherQuantity:
          type:
          - number
          - 'null'
        otherRate:
          type:
          - number
          - 'null'
        percentage:
          type:
          - number
          - 'null'
        pickQuantity:
          type:
          - integer
          - 'null'
        pickRate:
          type:
          - number
          - 'null'
        tarped:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        chassisId:
          type: string
          maxLength: 10
        containerId:
          type: string
          maxLength: 15
        powerUnitId:
          type: string
          maxLength: 10
        trailerId:
          type: string
          maxLength: 10
        teamDrivers:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        tripNumber:
          type: integer
        legSequence:
          type:
          - integer
          - 'null'
        stopNumber:
          type:
          - integer
          - 'null'
        freightBillNumber:
          type:
          - string
          - 'null'
          maxLength: 20
        billTotalCharges:
          type:
          - number
          - 'null'
        orderId:
          type:
          - integer
          - 'null'
        originZone:
          type:
          - string
          - 'null'
          maxLength: 10
        originZoneDescription:
          type:
          - string
          - 'null'
          maxLength: 30
        destinationZone:
          type:
          - string
          - 'null'
          maxLength: 10
        destinationZoneDescription:
          type:
          - string
          - 'null'
          maxLength: 30
        user1:
          type:
          - string
          - 'null'
          maxLength: 40
        user2:
          type:
          - string
          - 'null'
          maxLength: 40
        user3:
          type:
          - string
          - 'null'
          maxLength: 40
        user4:
          type:
          - string
          - 'null'
          maxLength: 40
        user5:
          type:
          - string
          - 'null'
          maxLength: 40
        user6:
          type:
          - string
          - 'null'
          maxLength: 40
        user7:
          type:
          - string
          - 'null'
          maxLength: 40
        user8:
          type:
          - string
          - 'null'
          maxLength: 40
        user9:
          type:
          - string
          - 'null'
          maxLength: 40
        user10:
          type:
          - string
          - 'null'
          maxLength: 40
        transactionDate:
          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))?$
    PostDriverPay:
      type: object
      properties:
        driverId:
          type: string
          maxLength: 10
        paymentCode:
          type: string
          maxLength: 10
        paymentDescription:
          type: string
          maxLength: 80
        paymentState:
          type: string
          enum:
          - approved
          - unapproved
        paymentDate:
          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))?$
          deprecated: true
        legDate:
          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))?$
        taxable:
          type: string
          enum:
          - 'False'
          - 'True'
        currencyCode:
          type: string
          maxLength: 3
        dropQuantity:
          type: integer
        dropRate:
          type: number
        emptyMilesQuantity:
          type: number
        emptyMilesRate:
          type: number
        hoursQuantity:
          type: number
        hoursRate:
          type: number
        layoverQuantity:
          type: integer
        layoverRate:
          type: number
        loadedMilesQuantity:
          type: number
        loadedMilesRate:
          type: number
        otherQuantity:
          type: number
        otherRate:
          type: number
        pickQuantity:
          type: integer
        pickRate:
          type: number
        percentage:
          type: number
        tarped:
          type: string
          enum:
          - 'False'
          - 'True'
        chassisId:
          type: string
          maxLength: 10
        containerId:
          type: string
          maxLength: 15
        powerUnitId:
          type: string
          maxLength: 10
        trailerId:
          type: string
          maxLength: 10
        tripNumber:
          type: integer
        legSequence:
          type: integer
        freightBillNumber:
          type: string
          maxLength: 20
        orderId:
          type: integer
        originZone:
          type: string
          maxLength: 10
        destinationZone:
          type: string
          maxLength: 10
        user1:
          type: string
          maxLength: 40
        user2:
          type: string
          maxLength: 40
        user3:
          type: string
          maxLength: 40
        user4:
          type: string
          maxLength: 40
        user5:
          type: string
          maxLength: 40
        user6:
          type: string
          maxLength: 40
        user7:
          type: string
          maxLength: 40
        user8:
          type: string
          maxLength: 40
        user9:
          type: string
          maxLength: 40
        user10:
          type: string
          maxLength: 40
      required:
      - driverId
  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/