Trimble Checks API

openapi: 3.2.0
info:
  title: Finance REST Checks 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: Checks
  description: Retrieves, creates, updates and deletes TruckMate checks and check bills. Checks can be viewed in the AP Invoice Entry application.
paths:
  /checks:
    get:
      summary: Retrieves checks
      description: 'Retrieves check records.


        Checks can be viewed in the Instant Checks application.


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


        Check bill records can only be created for payType vendor.


        Checks can be viewed in the Instant Checks application.


        This endpoint is available in TruckMate 25.1 and higher.'
      operationId: PostChecks
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Checks
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCheckList'
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostChecks201'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /checks/{checkId}:
    parameters:
    - name: checkId
      in: path
      description: Check identifier
      required: true
      schema:
        type: integer
    get:
      summary: Retrieves a check
      description: 'Retrieves the specified check record.


        Checks can be viewed in the Instant Checks application.


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


        Check bills can only be created for payType vendor.


        Changes are not allowed for posted checks.


        Checks can be viewed in the Instant Checks application.


        This endpoint is available in TruckMate 25.1 and higher.'
      operationId: PutCheck
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Checks
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutCheck'
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/check'
        '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 check
      description: 'Deletes the specified check record.


        Void or posted checks cannot be deleted.


        Checks can be viewed in the Instant Checks application.


        This endpoint is available in TruckMate 25.1 and higher.'
      operationId: DeleteCheck
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Checks
      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'
  /checks/{checkId}/bills:
    parameters:
    - name: checkId
      in: path
      description: Check identifier
      required: true
      schema:
        type: integer
    get:
      summary: Retrieves check bills
      description: 'Retrieves check bill records.


        Check bill information can be viewed in the Instant Checks Application > Bills Tab.


        This endpoint is available in TruckMate 24.3 and higher.'
      operationId: ChecksGetBills
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Checks
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChecksGetBills200'
        '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: Add a check bill
      description: 'Adds one or more check bill records to the specified check.


        Check bill records cannot be created for a posted check.


        Check bill records can only be created for payType vendor.


        The following app config option determines if overpayment using the billAmount is allowed:


        - CHEQUE.EXE > Allow AP Invoice Over-Pmt


        Check bill information can be viewed in the Instant Checks Application > Bills Tab.


        App config options can be viewed in the Application Configurator application.


        This endpoint is available in TruckMate 25.1 and higher.'
      operationId: ChecksPostBills
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Checks
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCheckBillList'
      parameters:
      - name: onlyPostedResults
        in: query
        description: An array of JSON objects containing the properties of the custom defined field to be created
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/select'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChecksPostBills201'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /checks/{checkId}/bills/{checkBillId}:
    parameters:
    - name: checkId
      in: path
      description: Check identifier
      required: true
      schema:
        type: integer
    - name: checkBillId
      in: path
      description: Check bill identifier
      required: true
      schema:
        type: integer
    get:
      summary: Retrieves a check bill
      description: 'Retrieves the specified check bill record.


        Check bill information can be viewed in the Instant Checks Application > Bills Tab.


        This endpoint is available in TruckMate 24.3 and higher.'
      operationId: ChecksGetBill
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Checks
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/checkBill'
                - 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 check bill
      description: 'Updates one or more properties for the specified check bill record.


        Check bill information can be viewed in the Instant Checks Application > Bills Tab.


        Check bill records cannot be updated for a posted check.


        The following app config option determines if overpayment using the billAmount is allowed:


        - CHEQUE.EXE > Allow AP Invoice Over-Pmt


        Check bill information can be viewed in the Instant Checks Application > Bills Tab.


        App config options can be viewed in the Application Configurator application.


        This endpoint is available in TruckMate 25.1 and higher.'
      operationId: ChecksPutBills
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Checks
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutCheckBill'
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkBill'
        '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 check bill
      description: 'Deletes the specified check bill record.


        Check bill records cannot be deleted for a posted or void check.


        Check bill information can be viewed in the Instant Checks Application > Bills Tab.


        This endpoint is available in TruckMate 25.1 and higher.'
      operationId: ChecksDeleteBill
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Checks
      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
    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
    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
    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:
    PostCheckBill:
      type: object
      properties:
        accountsPayableId:
          type: integer
        billAmount:
          type: number
        billReference:
          type: string
          maxLength: 40
        billDiscountGlAccount:
          type: string
          maxLength: 50
        billDiscountAmount:
          type: number
      required:
      - accountsPayableId
    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'
    checkBill:
      type: object
      properties:
        checkId:
          type: integer
        checkBillId:
          type: integer
        accountsPayableId:
          type: integer
        billAmount:
          type:
          - number
          - 'null'
        billFunctionalAmount:
          type:
          - number
          - 'null'
        billGlAccount:
          type:
          - string
          - 'null'
          maxLength: 50
        billDiscountGlAccount:
          type:
          - string
          - 'null'
          maxLength: 50
        billDiscountAmount:
          type:
          - number
          - 'null'
        billReference:
          type:
          - string
          - 'null'
          maxLength: 40
        transactionAmount:
          type:
          - number
          - 'null'
        vendorBillNumber:
          type:
          - string
          - 'null'
          maxLength: 20
    ChecksPostBills201:
      type: object
      properties:
        bills:
          type: array
          items:
            $ref: '#/components/schemas/checkBill'
    check:
      type: object
      properties:
        checkId:
          type: integer
        payType:
          type:
          - string
          - 'null'
          enum:
          - driver
          - vendor
          - client
          - payroll
          - ''
          - null
        payTo:
          type:
          - string
          - 'null'
          maxLength: 10
        name:
          type:
          - string
          - 'null'
          maxLength: 50
        address1:
          type:
          - string
          - 'null'
          maxLength: 40
        address2:
          type:
          - string
          - 'null'
          maxLength: 40
        city:
          type:
          - string
          - 'null'
          maxLength: 30
        province:
          type:
          - string
          - 'null'
          maxLength: 4
        postalCode:
          type:
          - string
          - 'null'
          maxLength: 10
        country:
          type:
          - string
          - 'null'
          maxLength: 10
        contact:
          type:
          - string
          - 'null'
          maxLength: 40
        payFrom:
          type:
          - string
          - 'null'
          enum:
          - bank
          - vendor
          - ''
          - null
        payFromVendor:
          type:
          - string
          - 'null'
          maxLength: 10
        checkNumber:
          type:
          - string
          - 'null'
          maxLength: 15
        checkAmount:
          type:
          - number
          - 'null'
        checkFunctionalAmount:
          type:
          - number
          - 'null'
        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))?$
        checkReference:
          type:
          - string
          - 'null'
          maxLength: 40
        glAccount:
          type:
          - string
          - 'null'
          maxLength: 50
          oneOf:
          - enum:
            - ''
          - pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+){0,4}$
        checkPosted:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        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))?$
        transactionCleared:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        transactionClearedDate:
          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))?$
        transactionVoided:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        transactionVoidedId:
          type:
          - integer
          - 'null'
        replacementCheckId:
          type:
          - integer
          - 'null'
        splitCheckId:
          type:
          - integer
          - 'null'
        tripNumber:
          type: integer
        user1:
          type:
          - string
          - 'null'
          maxLength: 20
        user2:
          type:
          - string
          - 'null'
          maxLength: 20
        user3:
          type:
          - string
          - 'null'
          maxLength: 20
        checkType:
          type:
          - string
          - 'null'
          maxLength: 30
        bills:
          type: array
          items:
            $ref: '#/components/schemas/checkBill'
    PostCheck:
      type: object
      properties:
        payType:
          type: string
          enum:
          - driver
          - vendor
          - client
          - payroll
        payTo:
          type: string
          maxLength: 10
        payFrom:
          type: string
          enum:
          - bank
          - vendor
        glAccount:
          type: string
          maxLength: 50
          pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+){0,4}$
        payFromVendor:
          type: string
          maxLength: 10
        checkNumber:
          type: string
          maxLength: 15
        checkAmount:
          type: number
        checkReference:
          type: string
          maxLength: 40
        checkDate:
          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))?$
        tripNumber:
          type: integer
        user1:
          type: string
          maxLength: 20
        user2:
          type: string
          maxLength: 20
        user3:
          type: string
          maxLength: 20
        bills:
          type: array
          items:
            $ref: '#/components/schemas/PostCheckBill'
      required:
      - payType
      - payFrom
    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
    PutCheckBill:
      type: object
      properties:
        accountsPayableId:
          type: integer
        billAmount:
          type: number
        billReference:
          type: string
          maxLength: 40
        billDiscountGlAccount:
          type: string
          maxLength: 50
        billDiscountAmount:
          type: number
    PostChecks201:
      type: object
      properties:
        checks:
          type: array
          items:
            $ref: '#/components/schemas/check'
    PostCheckList:
      type: array
      items:
        $ref: '#/components/schemas/PostCheck'
    GetChecks200:
      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
        checks:
          type: array
          items:
            $ref: '#/components/schemas/check'
    PutCheck:
      type: object
      properties:
        payType:
          type: string
          enum:
          - driver
          - vendor
          - client
          - payroll
        payTo:
          type: string
          maxLength: 10
        payFrom:
          type: string
          enum:
          - bank
          - vendor
        glAccount:
          type: string
          maxLength: 50
          pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+){0,4}$
        payFromVendor:
          type: string
          maxLength: 10
        checkNumber:
          type: string
          maxLength: 15
        checkAmount:
          type: number
        checkReference:
          type: string
          maxLength: 40
        checkDate:
          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))?$
        tripNumber:
          type: integer
        user1:
          type: string
          maxLength: 20
        user2:
          type: string
          maxLength: 20
        user3:
          type: string
          maxLength: 20
        bills:
          type: array
          items:
            $ref: '#/components/schemas/PostCheckBill'
    ChecksGetBills200:
      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
        bills:
          type: array
          items:
            $ref: '#/components/schemas/checkBill'
    PostCheckBillList:
      type: array
      items:
        $ref: '#/components/schemas/PostCheckBill'
  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/