Payroll Document Records
payrollDocumentRecords Based on latest (2026.09)
Look up Payroll Document Records. Read-only.
- Operations
- GET (list)GET (one)
- Record key
DocumentsOfRecordId- Required on create
- no create on this resource
- At a glance
- 11 fields0 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/payrollDocumentRecords?fields=CreationDate,PublishDate,DocumentsOfRecordId,TaxReportingUnit,SystemDocumentType&limit=25&onlyData=true
{
"items": [
{
"CreationDate": "2026-01-31T09:00:00+00:00",
"PublishDate": "2026-01-31",
"DocumentsOfRecordId": 0,
"TaxReportingUnit": "<string, max 240>",
"SystemDocumentType": "<string, max 120>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 11
| Attribute | Type | Use |
|---|---|---|
CreationDate | date-time | Read-onlySearchable |
PublishDate | date | Read-onlySearchable |
DocumentsOfRecordId | number | Read-onlySearchable |
TaxReportingUnit | text · max 240 | Read-onlySearchable |
SystemDocumentType | text · max 120 | Read-onlySearchable |
PersonId | number | Read-onlySearchable |
DateFrom | date | Read-onlySearchable |
PeriodName | text · max 40 | Read-onlySearchable |
ObjectActionId | number | Read-onlySearchable |
DocumentName | text · max 120 | Read-onlySearchable |
DateTo | date | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/<name>. Add them to a GET with expand.
attachmentsGET Attachments · 32 fieldsCreationDateDescriptionFileNameFileWebImageUriUrlDmDocumentIdAttachedDocumentIdUploadedFileContentTypeDownloadInfoCreatedByUserNameUploadedFileLengthDmVersionNumberLastUpdatedByErrorStatusMessageUserNameCreatedByDatatypeCodePostProcessingActionTitleLastUpdatedByUserNameUploadedFileNameFileUrlContentRepositoryFileSharedFileContentsExpirationDateErrorStatusCodeDmFolderPathUploadedTextCategoryNameLastUpdateDateAsyncTrackerId
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/payrollDocumentRecordsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:CreationDate, notcreationdate. - Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through.