Documentation Index

Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve Transactions by Code

Prev Next
Get
/em-rest-api/jersey/v1/tranWithPostTiment

Equipment Timesheet Transactions by CodeTimesheet API Documentation

Overview

This API retrieves EM transaction (timesheet) entries by company code with additional optional filters such as audit date, pagination, and unused result count flag.


Endpoint

GET /em-rest-api/jersey/v1/tranWithPostTiment

Query Parameters

Name Type Required Default Description
compCode string Yes Company code to filter results. (Must be non-empty)
auditDate string No Audit date in yyyy-MM-dd format; filters by create or update date.
limit integer No 50 Page size (records per page), minimum: 1, maximum: 1000
offset integer No 0 Page offset (zero-based), for pagination

Validation & Behavior

  • compCode is required. If missing or blank, returns:

    • 400 Bad Request

    • Code: GL-000261-ERR

  • limit is auto-corrected to the range 1–1000.

  • offset is auto-corrected to be zero or greater.

  • auditDate is compared against both creation and update dates.

  • Returns HTTP 500 and error message on SQL/internal failures.


Success Response

  • HTTP 200 OK

  • Content-Type: application/json

JSON Response Structure

{
  "items": [
    {
      "EmtrAmt": 200,
      "EmtrBchName": "DA 2023-05-05 T",
      "EmtrBchNum": 111035,
      "EmtrBchOraseq": 237664,
      "EmtrBillAmt": 400,
      "EmtrBillRate": 200,
      "EmtrBulkEqpFlag": "N",
      "EmtrCalledFromAppCode": "EM",
      "EmtrCatCode": null,
      "EmtrCatName": null,
      "EmtrCompCode": "ZZ",
      "EmtrCompName": "CMiC-ZZ Test Company Incorp",
      "EmtrComponCode": "ALL",
      "EmtrComponName": "No Components",
      "EmtrComponOraseq": 22806,
      "EmtrCurrActuallocCode": null,
      "EmtrCurrActuallocOraseq": null,
      "EmtrDesc": null,
      "EmtrDistComponOraseq": null,
      "EmtrDistDeptCode": "00",
      "EmtrDistEqpOraseq": null,
      "EmtrDistExpCode": null,
      "EmtrDistTrancodeOraseq": null,
      "EmtrDistTypeCode": "G",
      "EmtrDistWitmLineNumber": null,
      "EmtrDistWorkitemOraseq": null,
      "EmtrDistWorkorder": null,
      "EmtrDsrcCode": null,
      "EmtrDsrcCompCode": "ZZ",
      "EmtrEmtranOraseq": 237667,
      "EmtrEqpCode": "000784",
      "EmtrEqpName": "Eq test",
      "EmtrEqpOraseq": 92288,
      "EmtrEqpQty": 1,
      "EmtrIuCreateDate": "2023-05-05 12:03:08.0",
      "EmtrIuCreateUser": "DA",
      "EmtrIuUpdateDate": null,
      "EmtrIuUpdateUser": null,
      "EmtrJobCode": null,
      "EmtrJobName": null,
      "EmtrNum": 35494,
      "EmtrPhsCode": null,
      "EmtrPhsName": null,
      "EmtrPmCode": null,
      "EmtrPostDate": null,
      "EmtrPostFlag": null,
      "EmtrPyCrewCode": null,
      "EmtrPyCrewOraseq": null,
      "EmtrQty": 2,
      "EmtrRate": 100,
      "EmtrRateExistsFlag": "N",
      "EmtrRefCode": null,
      "EmtrRefDate": "2023-05-05 00:00:00.0",
      "EmtrRefDesc": null,
      "EmtrRowid": "AAAr0zAAHAAHze8AAE",
      "EmtrSrcCode": null,
      "EmtrSrcCompCode": "ZZ",
      "EmtrSrcDesc": null,
      "EmtrTacSetupFlag": "Y",
      "EmtrTenantId": "TN83T0936Q1590",
      "EmtrTrancodeCode": "102",
      "EmtrTrancodeName": "Insurance",
      "EmtrTrancodeOraseq": 22832,
      "EmtrUmCode": "HR",
      "EmtrUserField1": "ZZ",
      "EmtrUserField1Name": "CMiC-ZZ Test Company Incorp",
      "EmtrUserField2": "00",
      "EmtrUserField2Name": "Company Level33333",
      "EmtrUserField3": "1000.100",
      "EmtrUserField3Name": "Bank of America",
      "EmtrUserField4": null,
      "EmtrUserField4Name": null,
      "EmtrUserField5": null,
      "EmtrUserField5Name": "TAC Value Not On File",
      "EmtrUserField6": null,
      "EmtrUserField6Name": "TAC Value Not On File",
      "EmtrUserField7": null,
      "EmtrUserField7Name": null,
      "EmtrUserField8": null,
      "EmtrUserField8Name": "TAC Value Not On File",
      "EmtrUserFieldEdtFlag5": "Y",
      "EmtrUserFieldEdtFlag6": "Y",
      "EmtrUserFieldEdtFlag7": "Y",
      "EmtrUserFieldEdtFlag8": "Y",
      "EmtrVUuid": "FAF5369A08E60C6BE053AF811DACE732",
      "EmtrWbsSetupFlag": "N",
      "EmtrWbsvCode1": null,
      "EmtrWbsvCode10": null,
      "EmtrWbsvCode11": null,
      "EmtrWbsvCode12": null,
      "EmtrWbsvCode2": null,
      "EmtrWbsvCode3": null,
      "EmtrWbsvCode4": null,
      "EmtrWbsvCode5": null,
      "EmtrWbsvCode6": null,
      "EmtrWbsvCode7": null,
      "EmtrWbsvCode8": null,
      "EmtrWbsvCode9": null,
      "EmtrWbsvPciLineOraseq": null,
      "EmtrDistAccCode": "1000.100"
    }
  ]
}


Error Responses

  • { "code": "GL-000261-ERR", "param": "compCode", "message": "Request body cannot be empty."}

  • { "message": "Internal server error."}


Field Reference Table

Field Type Description
EmtrAmt number Transaction amount
EmtrBchName string Batch name
EmtrBchNum integer Batch number
EmtrBchOraseq integer Batch unique ID
EmtrBillAmt number Bill amount
EmtrBillRate number Bill rate
EmtrBulkEqpFlag string Bulk equipment flag (Y/N)
EmtrCalledFromAppCode string Application code
EmtrCatCode string Category code
EmtrCatName string Category name
EmtrCompCode string Company code
EmtrCompName string Company name
EmtrComponCode string Component code
EmtrComponName string Component name
EmtrComponOraseq integer Component unique ID
EmtrCurrActuallocCode string Current actual location code
EmtrCurrActuallocOraseq integer Current actual location ID
EmtrDesc string Description
EmtrDistComponOraseq integer Distribution component ID
EmtrDistDeptCode string Distribution department code
EmtrDistEqpOraseq integer Distribution equipment ID
EmtrDistExpCode string Distribution expense code
EmtrDistTrancodeOraseq integer Distribution transaction code ID
EmtrDistTypeCode string Distribution type code
EmtrDistWitmLineNumber integer Distribution work item line number
EmtrDistWorkitemOraseq integer Distribution work item ID
EmtrDistWorkorder string Distribution work order
EmtrDsrcCode string Source code
EmtrDsrcCompCode string Source company code
EmtrEmtranOraseq integer EM Transaction unique ID
EmtrEqpCode string Equipment code
EmtrEqpName string Equipment name
EmtrEqpOraseq integer Equipment unique ID
EmtrEqpQty number Equipment quantity
EmtrIuCreateDate string Creation date (yyyy-MM-dd HH:mm:ss.s)
EmtrIuCreateUser string Creating user
EmtrIuUpdateDate string Last update date
EmtrIuUpdateUser string Last update user
EmtrJobCode string Job code
EmtrJobName string Job name
EmtrNum integer Entry number
EmtrPhsCode string Phase code
EmtrPhsName string Phase name
EmtrPmCode string PM code
EmtrPostDate string Posting date
EmtrPostFlag string Posting flag
EmtrPyCrewCode string Payroll crew code
EmtrPyCrewOraseq integer Payroll crew unique ID
EmtrQty number Quantity
EmtrRate number Rate
EmtrRateExistsFlag string Rate exists flag
EmtrRefCode string Reference code
EmtrRefDate string Reference date (yyyy-MM-dd HH:mm:ss.s)
EmtrRefDesc string Reference description
EmtrRowid string Row identifier
EmtrSrcCode string Source code
EmtrSrcCompCode string Source company code
EmtrSrcDesc string Source description
EmtrTacSetupFlag string TAC setup flag
EmtrTenantId string Tenant ID
EmtrTrancodeCode string Transaction code
EmtrTrancodeName string Transaction name
EmtrTrancodeOraseq integer Transaction code unique ID
EmtrUmCode string Unit of measure code
EmtrUserField1-8 string User Defined Field 1-8
EmtrUserField1Name-8Name string User Defined Field Names 1-8
EmtrUserFieldEdtFlag5-8 string Edit flag for user fields 5-8
EmtrVUuid string Unique identifier (UUID)
EmtrWbsSetupFlag string WBS setup flag
EmtrWbsvCode1-12 string WBS codes 1-12
EmtrWbsvPciLineOraseq integer WBS PCI Line unique ID
EmtrDistAccCode string Distribution account code

Security
HTTP
Type basic

Basic authentication

Query parameters
compCode
string
ExampleZZ
auditDate
string
Example2020-01-05
offset
integer
Example0
limit
integer
Example5
Responses
200

Successful response

Copyright © 2024 CMiC All Rights Reserved