Trimble User Fields Data API

Retrieves user field records for finance-related sources.

GitHub OpenAPI

Operations 2

GET /userFieldsData Retrieves user fields #
PUT /userFieldsData Update a user field #

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-user-fields-data-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-user-fields-data-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Finance REST User Fields Data 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: User Fields Data
  description: Retrieves user field records for finance-related sources.
paths:
  /userFieldsData:
    get:
      summary: Retrieves user fields
      description: 'Retrieves user field records for the specified source type.


        User fields for apInvoices can be viewed in the AP Invoice Entry application.


        User fields for driverStatements can be viewed in the Driver Pay Audit application → Pay Statement History.


        This endpoint is available in TruckMate 25.4 and higher.'
      operationId: GetFinanceUserFieldsData
      security:
      - truckmateApiKeyAuth: []
      tags:
      - User Fields Data
      parameters:
      - $ref: '#/components/parameters/sourceType'
      - name: sourceId
        in: query
        description: sourceId
        required: false
        schema:
          type: integer
      - name: userField
        in: query
        description: userField
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFinanceUserFieldsData200'
        '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'
    put:
      summary: Update a user field
      description: 'Updates a user field record for the specified source type.


        User fields for apInvoices can be viewed in the AP Invoice Entry application.


        User fields for driverStatements can be viewed in the Driver Pay Audit application → Pay Statement History.'
      operationId: PutFinanceUserFieldsData
      security:
      - truckmateApiKeyAuth: []
      tags:
      - User Fields Data
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutUserFieldsDataDto'
      parameters:
      - $ref: '#/components/parameters/sourceType'
      - name: sourceId
        in: query
        description: sourceId
        required: true
        schema:
          type: integer
      - name: userField
        in: query
        description: userField
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutFinanceUserFieldsData200'
        '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
    sourceType:
      name: sourceType
      in: query
      description: Specify the type of user fields
      required: true
      style: form
      explode: true
      schema:
        type: string
        enum:
        - driverStatements
        - apInvoices
    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
  schemas:
    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
    userFieldData:
      type: object
      properties:
        sourceId:
          type: integer
        sourceType:
          type:
          - string
          - 'null'
          enum:
          - driverStatements
          - apInvoices
          - ''
          - null
        userField:
          type:
          - string
          - 'null'
          maxLength: 30
        userData:
          type:
          - string
          - 'null'
          maxLength: 80
    PutUserFieldsDataDto:
      type: object
      properties:
        userData:
          type: string
          maxLength: 80
    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'
    PutFinanceUserFieldsData200:
      type: object
      properties:
        userFieldsData:
          type: array
          items:
            $ref: '#/components/schemas/userFieldData'
    GetFinanceUserFieldsData200:
      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
        userFieldsData:
          type: array
          items:
            $ref: '#/components/schemas/userFieldData'
    GetUserFieldsDatas200:
      type: object
      properties:
        href:
          type: string
          readOnly: true
          description: Self-referencing URL for this resource
        offset:
          type: integer
        limit:
          type: integer
        count:
          type: integer
        userFieldsData:
          type: array
          items:
            $ref: '#/components/schemas/userFieldData'
  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
    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
externalDocs:
  url: https://learn.transportation.trimble.com/