PayItemTransaction

Returns a list of pay item transactions for a given job, foreman, date range, and other optional parameters.

Securitybearer

Request

query Parameters

jobId	string <uuid>
foremanId	string <uuid>
startDate	string <date-time>
endDate	string <date-time>
modifiedSince	string <date-time>
isActive	boolean
includeDeleted	boolean
cursor	string
limit	integer <int32> Default: 1000

Responses

200

Success

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

get/api/v1/payItemTransactions

Request samples

Response samples

application/json

{"results": [{"job": {"id": "15d98e0f-9b7d-423d-ad51-24394749a6d3",
"code": "BRIDGE",
"description": "Bridge over river"
},
"foreman": {"id": "9992d471-bede-4838-b967-54a4856247fd",
"code": "DOEJOHN",
"firstName": "JOHN",
"lastName": "DOE"
},
"date": "2024-01-01",
"revision": 1,
"isActive": true,
"groupInfo": {"id": "962e2370-fbe4-4123-b163-73e557b12ca9",
"status": "isSubmitted",
"changedBy": {"id": "8436b4bd-fd7b-44c8-8f02-f04d62945116",
"firstName": "First",
"lastName": "Last",
"email": "first.last@email.com"
},
"changeDate": "2024-01-01",
"isSentToBilling": false
},
"transactions": [{"payItemId": "9992d471-bede-4838-b967-54a4856247fd",
"payItemCode": "MASONRY",
"payItemDescription": "Mason work for the bridge",
"costCodeId": "15d98e0f-9b7d-423d-ad51-24394749a6d3",
"costCode": "LAY BRICKS",
"costCodeDescription": "Brick laying step",
"quantity": 100.5,
"isDeleted": false
}
]
}
],
"metadata": {"nextCursor": "gCpeihFB1whbiZt1qIf1TbhL8TPbeRP2"
}
}