Payslips
payslips Based on latest (2026.09)
Look up Payslips, with balance history, payments and payslip balances. Actions include download attachments. Changes only through its actions.
The record key payslipsUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
- Operations
- GET (list)GET (one)1 action
- Record key
payslipsUniqID- Required on create
- no create on this resource
- At a glance
- 16 fields0 finders10 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/payslips?fields=Amount,AttachmentEntityName,CreationDate,CurrencyCode,DefaultCurrencyCode&limit=25&onlyData=true
{
"items": [
{
"Amount": 0,
"AttachmentEntityName": "<string, max 22>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"CurrencyCode": "<string, max 20>",
"DefaultCurrencyCode": "<string, max 20>"
}
],
"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 16
| Attribute | Type | Use |
|---|---|---|
Amount | number | Searchable |
AttachmentEntityName | text · max 22 | Searchable |
CreationDate | date-time | Read-onlySearchable |
CurrencyCode | text · max 20 | Searchable |
DefaultCurrencyCode | text · max 20 | Read-onlySearchable |
DocumentsOfRecordId | number | Searchable |
PaymentDate | date | Searchable |
PayrollRelationshipId | number | Searchable |
PayrollRelationshipNumber | text · max 30 | Read-onlySearchable |
PayslipViewDate | date | Searchable |
PeriodEndDate | date | Searchable |
PeriodStartDate | date | Searchable |
PersonId | number | Searchable |
RelActionId | number | Searchable |
StoreEnabled | text · max 600 | Searchable |
WeekDay | text · max 255 | 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 10
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/<name>. Add them to a GET with expand.
BalanceHistoryGET Payslips · 13 fieldsAmountBaseBalanceNameBaseCategoryNameCategoryNameContextDisplaySequencePayrollRelActionIdPayrollRelationshipIdPrepayRelActionIdPrimaryBaseClassNamePrimaryClassNameProcessDateReportingNamePaymentsGET Net Pay Distribution · 6 fieldsAccountNumberAmountCurrencyCodePaymentMethodNamePaymentReferencePaymentTypePayslipBalancesGET Payslips Summary · 10 fieldsAmountBaseBalanceNameBaseCategoryNameCategoryNameContextDisplaySequencePayrollRelActionIdPrimaryBaseClassNamePrimaryClassNameReportingNamePayslipSummaryGET Payslips Summary · 10 fieldsAmountBaseBalanceNameBaseCategoryNameCategoryNameContextDisplaySequencePayrollRelActionIdPrimaryBaseClassNamePrimaryClassNameReportingNameNetPayDistributionGET Net Pay Distribution · 6 fieldsAccountNumberAmountCurrencyCodePaymentMethodNamePaymentReferencePaymentTypedocumentsGET Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameAttachmentsPreviewGET Attachment Previews · 4 fields · 1 findersImageHeightImageSourceImageWidthPageNumAttachmentGET Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameAttachmentsPreviewGET Attachment Previews · 4 fields · 1 findersImageHeightImageSourceImageWidthPageNumpayslipHistoryGET Payslip History · 9 fieldsAmountBalanceNameClassNameContextPayrollRelActionIdPayrollRelationshipIdPrepayRelActionIdProcessDateSecClassName
Actions 1
POST …/action/downloadAttachments·dorIDList
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/payslipsand 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.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:Amount, notamount. onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- 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.