Calculation Entries
calculationEntries Based on latest (2026.09)
Create, change, delete and look up Calculation Entries, with CIR component and calculation card component.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE1 action
- Record key
DirCardId- Required on create
- none marked
- At a glance
- 27 fields1 finders7 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/calculationEntries?fields=AssociableTru,BaseDisplayName,CardDefLegislationCode,CardNavigationFlow,CardRedwoodFlow&limit=25&onlyData=true
{
"items": [
{
"AssociableTru": "<string, max 1>",
"BaseDisplayName": "<string, max 80>",
"CardDefLegislationCode": "<string, max 30>",
"CardNavigationFlow": "<string, max 255>",
"CardRedwoodFlow": "<string, max 255>"
}
],
"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 27
| Attribute | Type | Use |
|---|---|---|
AssociableTru | text · max 1 | Read-onlySearchable |
BaseDisplayName | text · max 80 | Read-onlySearchable |
CardDefLegislationCode | text · max 30 | Read-onlySearchable |
CardNavigationFlow | text · max 255 | Optional on createUpdatableSearchable |
CardRedwoodFlow | text · max 255 | Optional on createUpdatableSearchable |
CreatedBy | text · max 100 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
DefaultCurrencyCode | text · max 20 | Optional on createUpdatableSearchable |
Description | text · max 240 | Read-onlySearchable |
DirCardDefinitionId | number | Read-onlySearchable |
DirCardId | number | Read-onlySearchable |
DisplayName | text · max 80 | Read-onlySearchable |
EffectiveEndDate | date | Read-onlySearchable |
EffectiveStartDate | date | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 100 | Read-onlySearchable |
LegislationCode | text · max 30 | Read-onlySearchable |
LegislativeDataGroupId | number | Optional on createUpdatableSearchable |
NavigationUse | text · max 1 | Read-onlySearchable |
PayrollRelationshipId | number | Read-onlySearchable |
PayrollStatUnitId | number | Read-onlySearchable |
PersonId | number | Read-onlySearchable |
ReportingCardFlag | yes/no · max 1 | Read-onlySearchable |
SourceId | number | Read-onlySearchable |
SourceType | text · max 30 | Read-onlySearchable |
TaxReportingUnit | text · max 18 | Read-onlySearchable |
UserExtensibleFlag | yes/no · max 1 | 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.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByEffectiveDatedFinder·pEffectiveDatepEffectiveDatedFlag
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 7
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/calculationEntries/{DirCardId}/child/<name>. Add them to a GET with expand.
CIRComponentGET · POST · PATCH · DELETE Calculation Card Component · 74 fields · 1 findersActiveFlagAssignmentIdAssignmentNumberAssociableTruAttachmentEntityNameBIPFormLinksBaseClassificationNameBaseComponentNameBaseComponentNameFilterBaseDeductionGroupNameCIREffectiveDateCIRModeCardEffectiveEndDateCardEffectiveStartDateCardLevelCardSequenceClassificationIdComponentDiscriminatorComponentEffectiveEndDateComponentEffectiveStartDateComponentSequenceContext1Context2Context3Context4Context5Context6DeductionGroupIdDeductionGroupNameDirCardCompDefIdDirCardCompDefNameDirCardCompIdDirCardDefinitionBaseNameDirCardDefinitionIdDirCardDefinitionNameDirCardIdDynamicAttributeNamesDynamicDataDynamicDataDetailsEffectiveDatedFlagEffectiveEndDateEffectiveStartDateElementTypeIdGUIDGroupBaseComponentNameGroupComponentNameGroupDirCardCompDefIdGroupIdentifierNamesGroupNameIgnoreCompsWithoutOvdOrFlexesIgnoreTUContextCompsLegislativeDataGroupIdLegislativeDataGroupNameLevelCodeOverrideNamesParentDirCardCompDefIdParentDirCardCompIdPayrollRelationshipIdPayrollRelationshipNumberPayrollStatUnitIdPayrollStatutoryUnitNameRangeEndDateRangeModeRangeStartDateRoleSecBaseClassificationNameSecondaryClassificationIdSourceIdSourceSystemIdSourceSystemOwnerSourceTypeSubprioritySystemPersonTypeTaxReportingUnitNameCIRComponentAssociationGET · POST · PATCH · DELETE Calculation Card Component Associations · 28 fieldsAssociableTruBaseComponentNameBaseDisplayNameComponentNameCreatedByCreationDateDirCardCompDefIdDirCardCompIdDirCardDefinitionIdDirCardIdDirRepCardIdDisplayNameEffectiveEndDateEffectiveStartDateGUIDLastUpdateDateLastUpdateLoginLastUpdatedByLegisCodeLegislationDiscriminatorLegislativeDataGroupIdObjectVersionNumberPayrollStatUnitIdSourceSystemIdSourceSystemOwnerTaxGroupNameTaxUnitIdTruBatchIdCIRComponentAssociationDetailsGET · POST · PATCH · DELETE Calculation Card Component Association Details · 29 fieldsAssignmentNumberAssociableTruBaseComponentNameBaseDisplayNameComponentNameCreatedByCreationDateDirCardCompDefIdDirCardCompIdDirCardDefinitionIdDirCardIdDirRepCardIdDirRepCardUsageIdDisplayNameEffectiveEndDateEffectiveStartDateGUIDLastUpdateDateLastUpdateLoginLastUpdatedByLegisCodeLegislationDiscriminatorObjectVersionNumberPayrollRelationshipIdRelationshipGroupIdSourceSystemIdSourceSystemOwnerTierIndicatorWorkAtHomeCIRComponentAttachmentsGET · POST · PATCH · DELETE Calculation Card Component Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameCIRComponentDateRangesGET · POST · PATCH · DELETE Calculation Card Component Overrides · 67 fields · 1 findersAssignmentIdAssignmentNumberAttributeCheckSumBaseClassificationNameBaseComponentNameBaseComponentNameFilterBaseDeductionGroupNameCIREffectiveDateCIRModeCardEffectiveEndDateCardEffectiveStartDateCardLevelCardSequenceClassificationIdComponentDiscriminatorComponentSequenceContext1Context2Context3Context4Context5Context6DeductionGroupIdDeductionGroupNameDirCardCompDefIdDirCardCompDefNameDirCardCompDrIdDirCardCompIdDirCardDefinitionBaseNameDirCardDefinitionIdDirCardDefinitionNameDirCardIdDynamicAttributeNamesDynamicDataDynamicDataDetailsEffectiveEndDateEffectiveStartDateElementTypeIdGUIDGroupBaseComponentNameGroupComponentNameGroupDirCardCompDefIdIgnoreCompsWithoutOvdOrFlexesIgnoreTUContextCompsLegislativeDataGroupIdLegislativeDataGroupNameLevelCodeOverrideFlexAttributeDetailsParentDirCardCompDefIdParentDirCardCompIdPayrollRelationshipIdPayrollRelationshipNumberPayrollStatUnitIdPayrollStatutoryUnitNameRangeEndDateRangeModeRangeStartDateRoleSecBaseClassificationNameSecondaryClassificationIdSourceIdSourceSystemIdSourceSystemOwnerSourceTypeSubprioritySystemPersonTypeTaxReportingUnitNameCalculationCardComponentGET Calculation Card Components · 40 fieldsActiveInactiveFlagAssociableTermAssociableTruBaseComponentNameCompEndDateCompLastUpdateDateCompLastUpdatedByCompStartDateComponentNameComponentSequenceContextValue1ContextValue2ContextValue3ContextValue4ContextValue5ContextValue6DeductionGroupBaseNameDeductionGroupIdDeductionGroupNameDirCardCompDefIdDirCardCompIdDirCardDefinitionIdDirCardIdElementTypeIdEndDateGroupComponentCountGroupDirCardCompDefIdGroupFlagGroupIdentifierGroupNameGroupSequenceKeepOpenLegCodeMultipleAllowedObjectVersionNumberParentDirCardCompIdRequiredStartDateSubprioritySysEffectiveDateAttachmentsGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserName
Actions 1
POST …/{DirCardId}/child/CIRComponent/{CIRComponentUniqID}/action/updateComponentActiveInActiveFlag·activeInactiveFlag
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/calculationEntriesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByEffectiveDatedFinderfor the agent's main search: its variables become clean tool parameters. - 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:CardNavigationFlow, notcardnavigationflow. - 23 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- 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. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.