REST API for Oracle Fusion Cloud HCM

Update a calculation card component

patch

/hcmRestApi/resources/11.13.18.05/calculationEntries/{DirCardId}/child/CIRComponent/{CIRComponentUniqID}

Request

Path Parameters

CIRComponentUniqID(required): string

This is the hash key of the attributes which make up the composite key--- EffectiveStartDate, EffectiveEndDate and DirCardCompId ---for the Calculation Card Component resource and used to uniquely identify an instance of Calculation Card Component. The client should not generate the hash key value. Instead, the client should query on the Calculation Card Component collection resource with a filter on the primary key values in order to navigate to a specific instance of Calculation Card Component.

For example: CIRComponent?q=EffectiveStartDate=<value1>;EffectiveEndDate=<value2>;DirCardCompId=<value3>
DirCardId(required): integer(int64)

The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

Effective-Of: string

This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
Metadata-Context: string

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version: string

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

ActiveFlag: boolean

Maximum Length: 60

Indicates whether the calculation card component is active.
AssignmentId: integer

Assignment ID of the employee.
AssignmentNumber: string

Assignment number of the employee.
AssociableTru: string

Maximum Length: 30

Associated tax reporting units.
AttachmentEntityName: string

Maximum Length: 40

Entity name of the attachment.
BaseClassificationName: string

Maximum Length: 160

Base classification name.
BaseComponentName: string

Maximum Length: 80

Base component name of the calculation card component.
BaseComponentNameFilter: string

Regular expression used to filter components by base component name for the specified calculation card definition ID.
BaseDeductionGroupName: string

Maximum Length: 240

Base deduction group name of the calculation card component.
BIPFormLinks: string

BIP form links of the calculation card component.
CardEffectiveEndDate: string (date)

Effective end date of the calculation card for component.
CardEffectiveStartDate: string (date)

Effective start date of the calculation card for component.
CardLevel: string

Maximum Length: 30

Card level of the calculation card.
CardSequence: integer (int64)

Card sequence of the calculation card.
CIRComponentAssociation: array Calculation Card Component Associations

Title: Calculation Card Component Associations

The CIRComponentAssociation resource returns list of associations associated with a calculation card.
CIRComponentAttachments: array Calculation Card Component Attachments

Title: Calculation Card Component Attachments

The CIRComponentAttachmentsVO resource returns attachments associated with a calculation card.
CIRComponentDateRanges: array Calculation Card Component Overrides

Title: Calculation Card Component Overrides

The resource CIRComponentDateRanges returns overrides associated with a calculation card component with different date ranges.
CIREffectiveDate: string (date)

Effective start date of the calculation card component.
CIRMode: string

Default Value: LOADER

Represents the current mode of the component.
ClassificationId: number

Classification ID of the calculation card component.
ComponentDiscriminator: string

Maximum Length: 255

Value that identifies the specific type of calculation card component.
ComponentEffectiveEndDate: string (date)

Effective end date of the calculation card component.
ComponentEffectiveStartDate: string (date)

Effective start date of the calculation card component for component.
ComponentSequence: integer (int64)

Sequence value of the calculation card component.
Context1: string

Maximum Length: 150

Reference Value 1.
Context2: string

Maximum Length: 150

Reference Value 2.
Context3: string

Maximum Length: 150

Reference Value 3.
Context4: string

Maximum Length: 150

Reference Value 4.
Context5: string

Maximum Length: 150

Reference Value 5.
Context6: string

Maximum Length: 150

Reference Value 6.
DeductionGroupId: integer (int64)

Deduction group ID of the calculation card component.
DeductionGroupName: string

Maximum Length: 240

Deduction group name of the calculation card component.
DirCardCompDefId: integer (int64)

Definition ID of the calculation card component.
DirCardCompDefName: string

Maximum Length: 80

Definition name of the calculation card component.
DirCardCompId: integer (int64)

Calculation card component ID.
DirCardDefinitionBaseName: string

Maximum Length: 80

Definition base name of the calculation card.
DirCardDefinitionId: integer (int64)

Definition ID of the calculation card.
DirCardDefinitionName: string

Maximum Length: 80

Definition name of the calculation card.
DirCardId: integer (int64)

Unique identifier for the calculation card.
DynamicAttributeNames: string

Attribute names of the calculation card component.
DynamicData: string

Attribute used to submit calculation card component data.
DynamicDataDetails: string

Read-only representation of the calculation card component metadata and values.
EffectiveDatedFlag: boolean

Maximum Length: 255

Effective dated indicator.
EffectiveEndDate: string (date)

Effective end date of the calculation card component for component.
EffectiveStartDate: string (date)

Effective start date of the card component for component.
ElementTypeId: integer (int64)

Element type ID of the calculation card component.
GroupBaseComponentName: string

Maximum Length: 80

Group base component name of the calculation card component.
GroupComponentName: string

Maximum Length: 80

Group component name of the calculation card component.
GroupDirCardCompDefId: integer

Group component definition ID of the calculation card component.
GroupIdentifierNames: string

Group identifier names of the calculation card component.
GroupName: string

Group name of the calculation card component.
GUID: string

GUID details for the component.
IgnoreCompsWithoutOvdOrFlexes: string

Default Value: N

Indicates whether calculation card components without overrides or flexfields are ignored.
IgnoreTUContextComps: string

Default Value: Y

Indicates whether calculation card components with tax unit context are ignored.
LegislativeDataGroupId: integer (int64)

Legislative data group ID of the employee payroll relationship.
LegislativeDataGroupName: string

Maximum Length: 240

Legislative data group name of the employee payroll relationship.
LevelCode: string

Maximum Length: 30

Level code for the component.
OverrideNames: string

Overrides names of the calculation card component.
ParentDirCardCompDefId: integer

Component definition ID of the calculation card components parent component.
ParentDirCardCompId: integer (int64)

Component ID of the calculation card components parent component.
PayrollRelationshipId: integer

Payroll relationship ID of the employee.
PayrollRelationshipNumber: string

Payroll relationship number of the employee.
PayrollStatUnitId: integer

Identifier for the payroll statutory unit.
PayrollStatutoryUnitName: string

Name of the payroll statutory unit.
RangeEndDate: string (date)

Range end date for the component.
RangeMode: string

RangeMode controls certain date effective operations for the update or delete of calculation card component.
RangeStartDate: string (date)

Range start date for the component.
Role: string

Default Value: MGR

Role of user.
SecBaseClassificationName: string

Maximum Length: 160

Secondary base classification name of the calculation card component.
SecondaryClassificationId: number

Secondary classification ID of the calculation card component.
SourceId: integer (int64)

Payroll relationship ID of the employee for component.
SourceSystemId: string

Source system identifier for the component.
SourceSystemOwner: string

Details of the source system owner for the component.
SourceType: string

Maximum Length: 30

Type of source associated with the calculation card component.
Subpriority: integer

Title: Subprocessing Order

Subprocessing order of the calculation card component.
SystemPersonType: string

System person type.
TaxReportingUnitName: string

Tax reporting unit name assigned to the calculation card.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":60,
            "type":"boolean",
            "description":"Indicates whether the calculation card component is active.",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestDisplayType":"CHECKBOX",
                "DLoadCIRRestDisplayAttrList":"[MeaningWithTag]",
                "DLoadCIRRestReturnAttrName":"Code",
                "DLoadCIRCheckboxCheckedValue":"Y",
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.deductions.personalRecords.protectedUiModel.cir.view.CIRHcmLookupTypeVO",
                "DLoadCIRRestListQueryCriteria":"findByCodeMeaningAndTag",
                "DLoadCIRRestListBindMap":"[LookupTypeBindVar:'YES_NO']",
                "DLoadCIRCheckboxUnCheckedValue":"N",
                "DLoadHidden":"true",
                "DLoadCIRCustomOjTransform":"Y"
            },
            "x-oj":{
                "transform":{
                    "path":"vx/oracle_hcm_calculationentriesusextUI/ui/self/applications/americas-calculation-cards/resources/js/cirdynamicobjectutils",
                    "name":"transformCIRUIHints"
                }
            }
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Assignment ID of the employee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadForeignIntegration":"Assignment;AssignmentId;PER_ALL_ASSIGNMENTS_M;ASSIGNMENT_ID",
                "ForeignVOAttributeName":"AssignmentId",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.registrations.publicView.PayrollAssignmentPVO\",\"findByAssignmentNumber\",\"AssignmentNumber:pAssignmentNumber\",\"findByAssignmentId\",\"AssignmentId:pAssignmentId\");",
                "DLoadSpreadsheetHideAttribute":"true"
            }
        },
        "AssignmentNumber":{
            "type":"string",
            "description":"Assignment number of the employee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_REL_GROUPS_DN__PayrollAssignmentPEO",
                "DLoadLOVReturnAttributes":"AssignmentNumber",
                "DLoadLOVDisplayAttributes":"[AssignmentNumber]",
                "DLoadCIRAttributeTableAndColumn":"PAY_REL_GROUPS_DN.ASSIGNMENT_NUMBER",
                "DLoadCIRAttributeWhereClause":"PAY_REL_GROUPS_DN.GROUP_TYPE = 'A';PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_CIR_CARD_COMPONENTS_VL.SOURCE_ID",
                "HcmComparable":"True",
                "DLoadLOVViewDefName":"oracle.apps.hcm.payrolls.registrations.publicView.PayrollAssignmentPVO",
                "DLoadCIRDependentAttributeWhereClause":"PayrollRelationshipNumber:PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_REL_GROUPS_DN__PayrollAssignmentPEO"
            }
        },
        "AssociableTru":{
            "maxLength":30,
            "type":"string",
            "description":"Associated tax reporting units.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "AttachmentEntityName":{
            "maxLength":40,
            "type":"string",
            "description":"Entity name of the attachment.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BIPFormLinks":{
            "type":"string",
            "description":"BIP form links of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseClassificationName":{
            "maxLength":160,
            "type":"string",
            "description":"Base classification name.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Base component name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "BaseComponentNameFilter":{
            "type":"string",
            "description":"Regular expression used to filter components by base component name for the specified calculation card definition ID.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseDeductionGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Base deduction group name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "CIRComponentAssociation":{
            "title":"Calculation Card Component Associations",
            "type":"array",
            "description":"The CIRComponentAssociation resource returns list of associations associated with a calculation card.",
            "items":{
                "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentAssociation-item-patch-request"
            }
        },
        "CIRComponentAttachments":{
            "title":"Calculation Card Component Attachments",
            "type":"array",
            "description":"The CIRComponentAttachmentsVO resource returns attachments associated with a calculation card.",
            "items":{
                "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentAttachments-item-patch-request"
            }
        },
        "CIRComponentDateRanges":{
            "title":"Calculation Card Component Overrides",
            "type":"array",
            "description":"The resource CIRComponentDateRanges returns overrides associated with a calculation card component with different date ranges.",
            "items":{
                "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentDateRanges-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "CIREffectiveDate":{
            "type":"string",
            "description":"Effective start date of the calculation card component.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "CIRMode":{
            "type":"string",
            "description":"Represents the current mode of the component.",
            "nullable":true,
            "default":"LOADER",
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "CardEffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card for component.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "CardEffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card for component.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "CardLevel":{
            "maxLength":30,
            "type":"string",
            "description":"Card level of the calculation card.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "CardSequence":{
            "type":"integer",
            "description":"Card sequence of the calculation card.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ClassificationId":{
            "type":"number",
            "description":"Classification ID of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "ComponentDiscriminator":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the specific type of calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.bo.view.DIRCardComponentBO",
                "includeInCompactView":true,
                "DLoadCIRElementClassificationRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentElementClassificationVO",
                "DLoadHidden":"true",
                "dependencies":[
                    "Context1",
                    "Context2",
                    "Context3",
                    "Context4",
                    "Context5",
                    "Context6",
                    "DirCardCompDefId"
                ]
            }
        },
        "ComponentEffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card component.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "ComponentEffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card component for component.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "ComponentSequence":{
            "type":"integer",
            "description":"Sequence value of the calculation card component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            }
        },
        "Context1":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 1.",
            "nullable":true
        },
        "Context2":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 2.",
            "nullable":true
        },
        "Context3":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 3.",
            "nullable":true
        },
        "Context4":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 4.",
            "nullable":true
        },
        "Context5":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 5.",
            "nullable":true
        },
        "Context6":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 6.",
            "nullable":true
        },
        "DeductionGroupId":{
            "type":"integer",
            "description":"Deduction group ID of the calculation card component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentDeductionGroupVO",
                "includeInCompactView":true,
                "precision":18,
                "DLoadHidden":"true",
                "dependencies":[
                    "DirCardDefinitionBaseName",
                    "DirCardDefinitionId"
                ]
            }
        },
        "DeductionGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Deduction group name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "DirCardCompDefId":{
            "type":"integer",
            "description":"Definition ID of the calculation card component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentDefVO",
                "includeInCompactView":true,
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.DIRCardCompDefVO\",\"DirCardCompDefName:ComponentName;LegislativeDataGroupId;DirCardDefinitionId\",\"DirCardCompDefId\");",
                "dependencies":[
                    "BaseComponentNameFilter",
                    "DeductionGroupId",
                    "IgnoreTUContextComps",
                    "Role"
                ]
            }
        },
        "DirCardCompDefName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DirCardCompId":{
            "type":"integer",
            "description":"Calculation card component ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.ComponentDirCardCompIdHelper\");",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DirCardDefinitionBaseName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition base name of the calculation card.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "DirCardDefinitionId":{
            "type":"integer",
            "description":"Definition ID of the calculation card.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.DIRCardDefinitionVO\",\"DirCardDefinitionName:DisplayName;LegislativeDataGroupId:LegislativeDataGroupId\",\"DirCardDefinitionId:DirCardDefinitionId\");"
            }
        },
        "DirCardDefinitionName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition name of the calculation card.",
            "nullable":true
        },
        "DirCardId":{
            "type":"integer",
            "description":"Unique identifier for the calculation card.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.ComponentDirCardIdHelper\");"
            }
        },
        "DynamicAttributeNames":{
            "type":"string",
            "description":"Attribute names of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "DynamicData":{
            "type":"string",
            "description":"Attribute used to submit calculation card component data.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "DynamicDataDetails":{
            "type":"string",
            "description":"Read-only representation of the calculation card component metadata and values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "EffectiveDatedFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Effective dated indicator.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card component for component.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the card component for component.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"Element type ID of the calculation card component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            }
        },
        "GUID":{
            "type":"string",
            "description":"GUID details for the component.",
            "nullable":true,
            "x-queryable":false
        },
        "GroupBaseComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Group base component name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "GroupComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Group component name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "GroupDirCardCompDefId":{
            "type":"integer",
            "description":"Group component definition ID of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "GroupIdentifierNames":{
            "type":"string",
            "description":"Group identifier names of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true",
                "DLoadCIRCustomOjTransform":"Y"
            },
            "x-oj":{
                "transform":{
                    "path":"vx/oracle_hcm_calculationentriesusextUI/ui/self/applications/americas-calculation-cards/resources/js/cirdynamicobjectutils",
                    "name":"transformCIRUIHints"
                }
            }
        },
        "GroupName":{
            "type":"string",
            "description":"Group name of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "IgnoreCompsWithoutOvdOrFlexes":{
            "type":"string",
            "description":"Indicates whether calculation card components without overrides or flexfields are ignored.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "IgnoreTUContextComps":{
            "type":"string",
            "description":"Indicates whether calculation card components with tax unit context are ignored.",
            "nullable":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Legislative data group ID of the employee payroll relationship.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.LegislativeDataGroupVO\",\"LegislativeDataGroupName:Name\",\"LegislativeDataGroupId:LegislativeDataGroupId\");"
            }
        },
        "LegislativeDataGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Legislative data group name of the employee payroll relationship.",
            "nullable":true,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PER_CHOOSE_LEGISLATIVE_DATA_GROUP_DATA__PER_LEGISLATIVE_DATA_GROUPS__LegislativeDataGroupPEO",
                "DLoadLOVReturnAttributes":"Name",
                "DLoadLOVDisplayAttributes":"[Name]",
                "DLoadLOVViewDefName":"oracle.apps.hcm.legislativeDataGroups.publicView.LegislativeDataGroupPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PER_CHOOSE_LEGISLATIVE_DATA_GROUP_DATA__PER_LEGISLATIVE_DATA_GROUPS__LegislativeDataGroupPEO"
            }
        },
        "LevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Level code for the component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "OverrideNames":{
            "type":"string",
            "description":"Overrides names of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "ParentDirCardCompDefId":{
            "type":"integer",
            "description":"Component definition ID of the calculation card components parent component.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "ParentDirCardCompId":{
            "type":"integer",
            "description":"Component ID of the calculation card components parent component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "DLoadHidden":"true"
            }
        },
        "PayrollRelationshipId":{
            "type":"integer",
            "description":"Payroll relationship ID of the employee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "PayrollRelationshipNumber":{
            "type":"string",
            "description":"Payroll relationship number of the employee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_PAY_RELATIONSHIPS_DN__PayrollRelationshipPEO",
                "DLoadLOVReturnAttributes":"PayrollRelationshipNumber",
                "DLoadLOVDisplayAttributes":"[PayrollRelationshipNumber]",
                "DLoadCIRAttributeTableAndColumn":"PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_NUMBER",
                "DLoadCIRAttributeWhereClause":"PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_CIR_CARD_COMPONENTS_VL.SOURCE_ID",
                "HcmComparable":"True",
                "DLoadLOVViewDefName":"oracle.apps.hcm.payrolls.registrations.publicView.PayrollRelationshipPVO",
                "DLoadCIRDependentAttributeWhereClause":"AssignmentNumber:PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_PAY_RELATIONSHIPS_DN__PayrollRelationshipPEO"
            }
        },
        "PayrollStatUnitId":{
            "type":"integer",
            "description":"Identifier for the payroll statutory unit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "PayrollStatutoryUnitName":{
            "type":"string",
            "description":"Name of the payroll statutory unit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_CHOOSE_PAYROLL_STATUTORY_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT",
                "DLoadLOVReturnAttributes":"Name",
                "DLoadLOVDisplayAttributes":"[Name]",
                "DLoadCIRAttributeTableAndColumn":"XLE_ENTITY_PROFILES.NAME",
                "DLoadCIRAttributeWhereClause":"XLE_ENTITY_PROFILES.LEGAL_ENTITY_ID=HR_ALL_ORGANIZATION_UNITS_F_VL.LEGAL_ENTITY_ID AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=HR_ORG_UNIT_CLASSIFICATIONS_F.ORGANIZATION_ID AND HR_ORG_UNIT_CLASSIFICATIONS_F.CLASSIFICATION_CODE='HCM_PSU' AND HR_ORG_UNIT_CLASSIFICATIONS_F.STATUS='A' AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=PAY_CIR_CARDS_VL.SOURCE_ID AND PAY_CIR_CARDS_VL.SOURCE_TYPE='PSU'",
                "DLoadCIRAttributeTables":"HR_ALL_ORGANIZATION_UNITS_F_VL;HR_ORG_UNIT_CLASSIFICATIONS_F",
                "DLoadLOVViewDefName":"oracle.apps.hcm.common.pay.publicView.parameters.PayrollStatutoryUnitPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_CHOOSE_PAYROLL_STATUTORY_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT"
            }
        },
        "RangeEndDate":{
            "type":"string",
            "description":"Range end date for the component.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "sortable":false
            }
        },
        "RangeMode":{
            "type":"string",
            "description":"RangeMode controls certain date effective operations for the update or delete of calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RangeStartDate":{
            "type":"string",
            "description":"Range start date for the component.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "sortable":false
            }
        },
        "Role":{
            "type":"string",
            "description":"Role of user.",
            "nullable":true,
            "default":"MGR",
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "SecBaseClassificationName":{
            "maxLength":160,
            "type":"string",
            "description":"Secondary base classification name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "SecondaryClassificationId":{
            "type":"number",
            "description":"Secondary classification ID of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "SourceId":{
            "type":"integer",
            "description":"Payroll relationship ID of the employee for component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.CardSourceIdHelper\");"
            }
        },
        "SourceSystemId":{
            "type":"string",
            "description":"Source system identifier for the component.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemOwner":{
            "type":"string",
            "description":"Details of the source system owner for the component.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of source associated with the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "Subpriority":{
            "title":"Subprocessing Order",
            "type":"integer",
            "description":"Subprocessing order of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "SystemPersonType":{
            "type":"string",
            "description":"System person type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "TaxReportingUnitName":{
            "type":"string",
            "description":"Tax reporting unit name assigned to the calculation card.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_CHOOSE_TAX_REPORTING_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT",
                "DLoadLOVReturnAttributes":"TruName",
                "DLoadLOVDisplayAttributes":"[TruName]",
                "DLoadCIRAttributeTableAndColumn":"XLE_ETB_PROFILES.NAME",
                "DLoadCIRAttributeWhereClause":"XLE_ETB_PROFILES.ESTABLISHMENT_ID = HR_ALL_ORGANIZATION_UNITS_F_VL.ESTABLISHMENT_ID AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID = HR_ORG_UNIT_CLASSIFICATIONS_F.ORGANIZATION_ID AND HR_ORG_UNIT_CLASSIFICATIONS_F.CLASSIFICATION_CODE = 'HCM_TRU' AND HR_ORG_UNIT_CLASSIFICATIONS_F.STATUS = 'A' AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=PAY_CIR_CARDS_VL.SOURCE_ID AND PAY_CIR_CARDS_VL.SOURCE_TYPE='TRU'",
                "DLoadCIRAttributeTables":"HR_ALL_ORGANIZATION_UNITS_F_VL;HR_ORG_UNIT_CLASSIFICATIONS_F",
                "DLoadLOVViewDefName":"oracle.apps.hcm.common.pay.publicView.parameters.TaxReportingUnitPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_CHOOSE_TAX_REPORTING_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT"
            }
        }
    }
}

Nested Schema : Calculation Card Component Associations

Type: array

Title: Calculation Card Component Associations

The CIRComponentAssociation resource returns list of associations associated with a calculation card.

Show Source

Array of: object calculationEntries-CIRComponent-CIRComponentAssociation-item-patch-request

{
    "title":"Calculation Card Component Associations",
    "type":"array",
    "description":"The CIRComponentAssociation resource returns list of associations associated with a calculation card.",
    "items":{
        "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentAssociation-item-patch-request"
    }
}

Nested Schema : Calculation Card Component Attachments

Type: array

Title: Calculation Card Component Attachments

The CIRComponentAttachmentsVO resource returns attachments associated with a calculation card.

Show Source

Array of: object schema

{
    "title":"Calculation Card Component Attachments",
    "type":"array",
    "description":"The CIRComponentAttachmentsVO resource returns attachments associated with a calculation card.",
    "items":{
        "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentAttachments-item-patch-request"
    }
}

Nested Schema : Calculation Card Component Overrides

Type: array

Title: Calculation Card Component Overrides

The resource CIRComponentDateRanges returns overrides associated with a calculation card component with different date ranges.

Show Source

Array of: object schema

{
    "title":"Calculation Card Component Overrides",
    "type":"array",
    "description":"The resource CIRComponentDateRanges returns overrides associated with a calculation card component with different date ranges.",
    "items":{
        "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentDateRanges-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : calculationEntries-CIRComponent-CIRComponentAssociation-item-patch-request

Type: object

Show Source

CIRComponentAssociationDetails: array Calculation Card Component Association Details

Title: Calculation Card Component Association Details

The CIRComponentAssociationDetails resource returns details of the calculation card association.
DirCardCompId: integer (int64)

Title: Component Base Name

Unique identifier for the calculation card component.
EffectiveEndDate: string (date)

Effective end date of the calculation card association.
EffectiveStartDate: string (date)

Effective start date of the calculation card association.
GUID: string

GUID for the component association.
LegisCode: string

Legislation code for component association.
ObjectVersionNumber: integer (int32)

Current object version number for the calculation card component association.
PayrollStatUnitId: integer

Payroll statutory unit ID.
SourceSystemId: string

Source system identifier for component association.
SourceSystemOwner: string

Source system owner for component association.
TaxGroupName: string

Maximum Length: 255

Tax group name of the calculation card association.
TaxUnitId: integer (int64)

Title: Tax Reporting Unit

Tax unit ID of the calculation card association.
TruBatchId: string

Maximum Length: 80

Tax reporting unit batch ID.

{
    "type":"object",
    "properties":{
        "CIRComponentAssociationDetails":{
            "title":"Calculation Card Component Association Details",
            "type":"array",
            "description":"The CIRComponentAssociationDetails resource returns details of the calculation card association.",
            "items":{
                "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentAssociation-CIRComponentAssociationDetails-item-patch-request"
            }
        },
        "DirCardCompId":{
            "title":"Component Base Name",
            "type":"integer",
            "description":"Unique identifier for the calculation card component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card association.",
            "format":"date",
            "nullable":false
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card association.",
            "format":"date",
            "nullable":false
        },
        "GUID":{
            "type":"string",
            "description":"GUID for the component association.",
            "nullable":true,
            "x-queryable":false
        },
        "LegisCode":{
            "type":"string",
            "description":"Legislation code for component association.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Current object version number for the calculation card component association.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "PayrollStatUnitId":{
            "type":"integer",
            "description":"Payroll statutory unit ID.",
            "nullable":true
        },
        "SourceSystemId":{
            "type":"string",
            "description":"Source system identifier for component association.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemOwner":{
            "type":"string",
            "description":"Source system owner for component association.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxGroupName":{
            "maxLength":255,
            "type":"string",
            "description":"Tax group name of the calculation card association.",
            "nullable":true
        },
        "TaxUnitId":{
            "title":"Tax Reporting Unit",
            "type":"integer",
            "description":"Tax unit ID of the calculation card association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestDisplayType":"CHOICE",
                "DLoadCIRRestDisplayAttrList":"[Name]",
                "DLoadCIRRestReturnAttrName":"OrganizationId",
                "DLoadCIRRestVoName":"oracle.apps.hcm.common.pay.publicModel.view.TaxReportingUnitPVO",
                "controlType":"choice",
                "DLoadCIRRestListQueryCriteria":"[findActiveByDate,findByPsuOrganizationId,findByLdgId]",
                "DLoadCIRRestListBindMap":"[pDate:'{DEPENDENT.EffectiveStartDate}';pPsuOrganizationId:'{DEPENDENT.PayrollStatUnitId}';pLdgId:'{DEPENDENT.LegislativeDataGroupId}']",
                "precision":18,
                "displayMode":"displayAttribute"
            }
        },
        "TruBatchId":{
            "maxLength":80,
            "type":"string",
            "description":"Tax reporting unit batch ID.",
            "nullable":true
        }
    }
}

Nested Schema : Calculation Card Component Association Details

Type: array

Title: Calculation Card Component Association Details

The CIRComponentAssociationDetails resource returns details of the calculation card association.

Show Source

Array of: object schema

{
    "title":"Calculation Card Component Association Details",
    "type":"array",
    "description":"The CIRComponentAssociationDetails resource returns details of the calculation card association.",
    "items":{
        "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentAssociation-CIRComponentAssociationDetails-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

AssignmentNumber: string

Maximum Length: 255

Assignment number of the calculation card association.
DirCardCompId: integer (int64)

Title: Component Base Name

Unique identifier of the calculation card for component association details.
EffectiveEndDate: string (date)

Effective end date of the calculation card association details.
EffectiveStartDate: string (date)

Effective start date of the calculation card association details.
GUID: string

GUID for component association details.
LegisCode: string

Legislation code for component association details.
ObjectVersionNumber: integer (int32)

Current object version number for the calculation card component association details.
RelationshipGroupId: integer (int64)

Title: Employment Terms Number

Relationship group ID.
SourceSystemId: string

Source system identifier for component association details.
SourceSystemOwner: string

Source system owner for component association details.
TierIndicator: string

Maximum Length: 255

Tier Indicator for the calculation card association details.
WorkAtHome: string

Maximum Length: 255

Work at home status of the employee assignment.

{
    "type":"object",
    "properties":{
        "AssignmentNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Assignment number of the calculation card association.",
            "nullable":true
        },
        "DirCardCompId":{
            "title":"Component Base Name",
            "type":"integer",
            "description":"Unique identifier of the calculation card for component association details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card association details.",
            "format":"date",
            "nullable":false
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card association details.",
            "format":"date",
            "nullable":false
        },
        "GUID":{
            "type":"string",
            "description":"GUID for component association details.",
            "nullable":true,
            "x-queryable":false
        },
        "LegisCode":{
            "type":"string",
            "description":"Legislation code for component association details.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Current object version number for the calculation card component association details.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "RelationshipGroupId":{
            "title":"Employment Terms Number",
            "type":"integer",
            "description":"Relationship group ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DLoadCIRRestDisplayType":"CHOICE",
                "DLoadCIRRestDisplayAttrList":"[AssignmentNumber]",
                "DLoadCIRRestReturnAttrName":"RelationshipGroupId",
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.deductions.personalRecords.protectedUiModel.cir.view.CalculationCardPayRelGroupsVO",
                "controlType":"choice",
                "DLoadCIRRestListQueryCriteria":"[findByPayRelId]",
                "DLoadCIRRestListBindMap":"[pEffectiveDate:'{DEPENDENT.EffectiveStartDate}';pPayRelId:'{DEPENDENT.PayrollRelationshipId}';pTier:'{DEPENDENT.TierIndicator}']",
                "precision":18,
                "displayMode":"displayAttribute"
            }
        },
        "SourceSystemId":{
            "type":"string",
            "description":"Source system identifier for component association details.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemOwner":{
            "type":"string",
            "description":"Source system owner for component association details.",
            "nullable":true,
            "x-queryable":false
        },
        "TierIndicator":{
            "maxLength":255,
            "type":"string",
            "description":"Tier Indicator for the calculation card association details.",
            "nullable":true
        },
        "WorkAtHome":{
            "maxLength":255,
            "type":"string",
            "description":"Work at home status of the employee assignment.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

CategoryName: string

Title: Category

Maximum Length: 30
ContentRepositoryFileShared: boolean

Title: Shared
DatatypeCode: string

Title: Type

Maximum Length: 30

Default Value: FILE
Description: string

Title: Description

Maximum Length: 255
DmDocumentId: string

Maximum Length: 255
DmFolderPath: string

Title: Dm Folder Path

Maximum Length: 1000
DmVersionNumber: string

Maximum Length: 255
DownloadInfo: string

Title: DownloadInfo
ErrorStatusCode: string

Title: Error Status Code
ErrorStatusMessage: string

Title: Error Status Message
ExpirationDate: string (date-time)

Title: Expiration Date
FileContents: string (byte)

Title: File Contents
FileName: string

Title: File Name

Maximum Length: 2048
FileUrl: string

Title: File Url
PostProcessingAction: string

Title: PostProcessingAction
Title: string

Title: Title
UploadedFileContentType: string

Title: Uploaded File Content Type
UploadedFileLength: integer

Title: File Size
UploadedFileName: string

Title: Uploaded File Name
UploadedText: string

Title: Uploaded Text
Uri: string

Title: Uri

Maximum Length: 4000
Url: string

Title: Url

Maximum Length: 4000

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

AssignmentId: integer

Assignment ID of the employee for component date ranges.
AssignmentNumber: string

Assignment number of the employee for component date ranges.
AttributeCheckSum: string

Check sum of the attribute.
BaseClassificationName: string

Maximum Length: 160

Base classification name for component date ranges.
BaseComponentName: string

Maximum Length: 80

Base component name of the calculation card component for component date ranges.
BaseComponentNameFilter: string

Base component filter.
BaseDeductionGroupName: string

Maximum Length: 240

Base deduction group name of the calculation card component for component date ranges.
CardEffectiveEndDate: string (date)

Effective end date of the calculation card for component date ranges.
CardEffectiveStartDate: string (date)

Effective start date of the calculation card for component date ranges.
CardLevel: string

Maximum Length: 30

Card level for component date ranges.
CardSequence: integer (int64)

Card sequence of the calculation card for component date ranges.
CIREffectiveDate: string (date)

Effective start date of the calculation card component for component date ranges.
CIRMode: string

Represents the current mode of the card component.
ClassificationId: number

Classification ID of the calculation card component for component date ranges.
ComponentDiscriminator: string

Maximum Length: 255

Discriminator for the calculation card component.
ComponentSequence: integer (int64)

Sequence value of the calculation card component for component date ranges.
Context1: string

Maximum Length: 150

Reference Value 1 for component date ranges.
Context2: string

Maximum Length: 150

Reference Value 2 for component date ranges.
Context3: string

Maximum Length: 150

Reference Value 3 for component date ranges.
Context4: string

Maximum Length: 150

Reference Value 4 for component date ranges.
Context5: string

Maximum Length: 150

Reference Value 5 for component date ranges.
Context6: string

Maximum Length: 150

Reference Value 6 for component date ranges.
DeductionGroupId: integer (int64)

Deduction group ID of the calculation card component for component date ranges.
DeductionGroupName: string

Maximum Length: 240

Deduction group name of the calculation card component for component date ranges.
DirCardCompDefId: integer (int64)

Definition ID of the calculation card component for component date ranges.
DirCardCompDefName: string

Maximum Length: 80

Definition name of the calculation card component for component date ranges.
DirCardCompDrId: integer (int64)

Unique identifier for the calculation card component date range.
DirCardCompId: integer (int64)

ID of the calculation card component.
DirCardDefinitionBaseName: string

Maximum Length: 80

Definition base name of the calculation card for component date ranges.
DirCardDefinitionId: integer (int64)

Definition ID of the calculation card for component date ranges.
DirCardDefinitionName: string

Maximum Length: 80

Definition name of the calculation card for component date ranges.
DirCardId: integer (int64)

Unique identifier of the calculation card for component date ranges.
DynamicAttributeNames: string

Attribute names of the calculation card component for component date ranges.
DynamicData: string

DynamicData is the write oriented attribute. Consumers pass a JSON string where each key identifies the calculation card components override attribute to create or change the value
DynamicDataDetails: string

DynamicDataDetails is the read-oriented metadata or value representation. It tells the consumer which dynamic override attributes are available for the calculation card component
EffectiveEndDate: string (date)

Effective end date of calculation card component override.
EffectiveStartDate: string (date)

Effective start date of the calculation card component override.
ElementTypeId: integer (int64)

Element type ID of the calculation card component for component date ranges.
GroupBaseComponentName: string

Maximum Length: 80

Group base component name of the calculation card component for component date ranges.
GroupComponentName: string

Maximum Length: 80

Group component name of the calculation card component for component date ranges.
GroupDirCardCompDefId: integer

Group component definition ID of the calculation card component for component date ranges.
GUID: string

GUID for component date ranges.
IgnoreCompsWithoutOvdOrFlexes: string

Default Value: N

Ignore calculation card components without overrides.
IgnoreTUContextComps: string

Indicates whether calculation card components with tax unit context are ignored for component date ranges.
LegislativeDataGroupId: integer (int64)

Legislative data group ID of the employee payroll relationship for component date ranges.
LegislativeDataGroupName: string

Maximum Length: 240

Legislative data group name of the employee payroll relationship for component date ranges.
LevelCode: string

Maximum Length: 30

Level code for component date ranges.
OverrideFlexAttributeDetails: string

Overrides attribute details of the calculation card component.
ParentDirCardCompDefId: integer

Component definition ID of the calculation card components parent component for component date ranges.
ParentDirCardCompId: integer (int64)

Component ID of calculation card components parent component.
PayrollRelationshipId: integer

Payroll Relationship ID of the employee.
PayrollRelationshipNumber: string

Payroll relationship number of the employee for component date ranges.
PayrollStatUnitId: integer

Payroll statutory unit ID for component date ranges.
PayrollStatutoryUnitName: string

Name of the payroll statutory unit for component date ranges.
RangeEndDate: string (date)

Range end date for component date ranges.
RangeMode: string

RangeMode controls certain date effective behavior for the update or delete of component date ranges.
RangeStartDate: string (date)

Range start date for component date ranges.
Role: string

Role of the user.
SecBaseClassificationName: string

Maximum Length: 160

Secondary base classification name of the calculation card component for component date ranges.
SecondaryClassificationId: number

Secondary classification ID of the calculation card component for component date ranges.
SourceId: integer (int64)

Payroll relationship ID of the employee for component date ranges.
SourceSystemId: string

Source system identifier for component date ranges.
SourceSystemOwner: string

Source system owner for component date ranges.
SourceType: string

Maximum Length: 30

Type of source associated with the calculation card component date range.
Subpriority: integer

Subpriority of the calculation card component date range.
SystemPersonType: string

System person type for component date ranges.
TaxReportingUnitName: string

Tax reporting unit name assigned to the calculation card for component date ranges.

{
    "type":"object",
    "properties":{
        "AssignmentId":{
            "type":"integer",
            "description":"Assignment ID of the employee for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadForeignIntegration":"Assignment;AssignmentId;PER_ALL_ASSIGNMENTS_M;ASSIGNMENT_ID",
                "ForeignVOAttributeName":"AssignmentId",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.registrations.publicView.PayrollAssignmentPVO\",\"findByAssignmentNumber\",\"AssignmentNumber:pAssignmentNumber\",\"findByAssignmentId\",\"AssignmentId:pAssignmentId\");",
                "DLoadSpreadsheetHideAttribute":"true"
            }
        },
        "AssignmentNumber":{
            "type":"string",
            "description":"Assignment number of the employee for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_REL_GROUPS_DN__PayrollAssignmentPEO",
                "DLoadLOVReturnAttributes":"AssignmentNumber",
                "DLoadLOVDisplayAttributes":"[AssignmentNumber]",
                "DLoadCIRAttributeTableAndColumn":"PAY_REL_GROUPS_DN.ASSIGNMENT_NUMBER",
                "DLoadCIRAttributeWhereClause":"PAY_REL_GROUPS_DN.GROUP_TYPE = 'A';PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_CIR_CARD_COMPONENTS_DR_VL.SOURCE_ID",
                "HcmComparable":"True",
                "DLoadLOVViewDefName":"oracle.apps.hcm.payrolls.registrations.publicView.PayrollAssignmentPVO",
                "DLoadCIRDependentAttributeWhereClause":"PayrollRelationshipNumber:PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_REL_GROUPS_DN__PayrollAssignmentPEO"
            }
        },
        "AttributeCheckSum":{
            "type":"string",
            "description":"Check sum of the attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseClassificationName":{
            "maxLength":160,
            "type":"string",
            "description":"Base classification name for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Base component name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseComponentNameFilter":{
            "type":"string",
            "description":"Base component filter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseDeductionGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Base deduction group name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "CIREffectiveDate":{
            "type":"string",
            "description":"Effective start date of the calculation card component for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "CIRMode":{
            "type":"string",
            "description":"Represents the current mode of the card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "CardEffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "CardEffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "CardLevel":{
            "maxLength":30,
            "type":"string",
            "description":"Card level for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "CardSequence":{
            "type":"integer",
            "description":"Card sequence of the calculation card for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ClassificationId":{
            "type":"number",
            "description":"Classification ID of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "ComponentDiscriminator":{
            "maxLength":255,
            "type":"string",
            "description":"Discriminator for the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.bo.view.DIRCardComponentExtendedBO",
                "DLoadCIRElementClassificationRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentElementClassificationVO",
                "DLoadHidden":"true",
                "dependencies":[
                    "CIREffectiveDate",
                    "Context1",
                    "Context2",
                    "Context3",
                    "Context4",
                    "Context5",
                    "Context6",
                    "DirCardCompDefId"
                ]
            }
        },
        "ComponentSequence":{
            "type":"integer",
            "description":"Sequence value of the calculation card component for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            }
        },
        "Context1":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 1 for component date ranges.",
            "nullable":true
        },
        "Context2":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 2 for component date ranges.",
            "nullable":true
        },
        "Context3":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 3 for component date ranges.",
            "nullable":true
        },
        "Context4":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 4 for component date ranges.",
            "nullable":true
        },
        "Context5":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 5 for component date ranges.",
            "nullable":true
        },
        "Context6":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 6 for component date ranges.",
            "nullable":true
        },
        "DeductionGroupId":{
            "type":"integer",
            "description":"Deduction group ID of the calculation card component for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentDeductionGroupVO",
                "precision":18,
                "DLoadHidden":"true",
                "dependencies":[
                    "DirCardDefinitionBaseName",
                    "DirCardDefinitionId"
                ]
            }
        },
        "DeductionGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Deduction group name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "DirCardCompDefId":{
            "type":"integer",
            "description":"Definition ID of the calculation card component for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentDefVO",
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.DIRCardCompDefVO\",\"DirCardCompDefName:ComponentName;LegislativeDataGroupId;DirCardDefinitionId\",\"DirCardCompDefId\");",
                "dependencies":[
                    "BaseComponentNameFilter",
                    "DeductionGroupId",
                    "IgnoreTUContextComps",
                    "Role"
                ]
            }
        },
        "DirCardCompDefName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition name of the calculation card component for component date ranges.",
            "nullable":true
        },
        "DirCardCompDrId":{
            "type":"integer",
            "description":"Unique identifier for the calculation card component date range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.ComponentDirCardCompDrIdHelper\");",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DirCardCompId":{
            "type":"integer",
            "description":"ID of the calculation card component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.ComponentDirCardCompIdHelper\");"
            }
        },
        "DirCardDefinitionBaseName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition base name of the calculation card for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "DirCardDefinitionId":{
            "type":"integer",
            "description":"Definition ID of the calculation card for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.DIRCardDefinitionVO\",\"DirCardDefinitionName:DisplayName;LegislativeDataGroupId:LegislativeDataGroupId\",\"DirCardDefinitionId:DirCardDefinitionId\");"
            }
        },
        "DirCardDefinitionName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition name of the calculation card for component date ranges.",
            "nullable":true
        },
        "DirCardId":{
            "type":"integer",
            "description":"Unique identifier of the calculation card for component date ranges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DynamicAttributeNames":{
            "type":"string",
            "description":"Attribute names of the calculation card component for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true",
                "HcmComparable":"True"
            }
        },
        "DynamicData":{
            "type":"string",
            "description":"DynamicData is the write oriented attribute. Consumers pass a JSON string where each key identifies the calculation card components override attribute to create or change the value",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "DynamicDataDetails":{
            "type":"string",
            "description":"DynamicDataDetails is the read-oriented metadata or value representation. It tells the consumer which dynamic override attributes are available for the calculation card component",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of calculation card component override.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card component override.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"Element type ID of the calculation card component for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            }
        },
        "GUID":{
            "type":"string",
            "description":"GUID for component date ranges.",
            "nullable":true,
            "x-queryable":false
        },
        "GroupBaseComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Group base component name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "GroupComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Group component name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "GroupDirCardCompDefId":{
            "type":"integer",
            "description":"Group component definition ID of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "IgnoreCompsWithoutOvdOrFlexes":{
            "type":"string",
            "description":"Ignore calculation card components without overrides.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "IgnoreTUContextComps":{
            "type":"string",
            "description":"Indicates whether calculation card components with tax unit context are ignored for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Legislative data group ID of the employee payroll relationship for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.LegislativeDataGroupVO\",\"LegislativeDataGroupName:Name\",\"LegislativeDataGroupId:LegislativeDataGroupId\");"
            }
        },
        "LegislativeDataGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Legislative data group name of the employee payroll relationship for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PER_CHOOSE_LEGISLATIVE_DATA_GROUP_DATA__PER_LEGISLATIVE_DATA_GROUPS__LegislativeDataGroupPEO",
                "DLoadLOVReturnAttributes":"Name",
                "DLoadLOVDisplayAttributes":"[Name]",
                "DLoadLOVViewDefName":"oracle.apps.hcm.legislativeDataGroups.publicView.LegislativeDataGroupPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PER_CHOOSE_LEGISLATIVE_DATA_GROUP_DATA__PER_LEGISLATIVE_DATA_GROUPS__LegislativeDataGroupPEO"
            }
        },
        "LevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Level code for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "OverrideFlexAttributeDetails":{
            "type":"string",
            "description":"Overrides attribute details of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "ParentDirCardCompDefId":{
            "type":"integer",
            "description":"Component definition ID of the calculation card components parent component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "ParentDirCardCompId":{
            "type":"integer",
            "description":"Component ID of calculation card components parent component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            }
        },
        "PayrollRelationshipId":{
            "type":"integer",
            "description":"Payroll Relationship ID of the employee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "PayrollRelationshipNumber":{
            "type":"string",
            "description":"Payroll relationship number of the employee for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_PAY_RELATIONSHIPS_DN__PayrollRelationshipPEO",
                "DLoadLOVReturnAttributes":"PayrollRelationshipNumber",
                "DLoadLOVDisplayAttributes":"[PayrollRelationshipNumber]",
                "DLoadCIRAttributeTableAndColumn":"PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_NUMBER",
                "DLoadCIRAttributeWhereClause":"PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_CIR_CARD_COMPONENTS_DR_VL.SOURCE_ID",
                "HcmComparable":"True",
                "DLoadLOVViewDefName":"oracle.apps.hcm.payrolls.registrations.publicView.PayrollRelationshipPVO",
                "DLoadCIRDependentAttributeWhereClause":"AssignmentNumber:PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_PAY_RELATIONSHIPS_DN__PayrollRelationshipPEO"
            }
        },
        "PayrollStatUnitId":{
            "type":"integer",
            "description":"Payroll statutory unit ID for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "PayrollStatutoryUnitName":{
            "type":"string",
            "description":"Name of the payroll statutory unit for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_CHOOSE_PAYROLL_STATUTORY_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT",
                "DLoadLOVReturnAttributes":"Name",
                "DLoadLOVDisplayAttributes":"[Name]",
                "DLoadCIRAttributeTableAndColumn":"XLE_ENTITY_PROFILES.NAME",
                "DLoadCIRAttributeWhereClause":"XLE_ENTITY_PROFILES.LEGAL_ENTITY_ID=HR_ALL_ORGANIZATION_UNITS_F_VL.LEGAL_ENTITY_ID AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=HR_ORG_UNIT_CLASSIFICATIONS_F.ORGANIZATION_ID AND HR_ORG_UNIT_CLASSIFICATIONS_F.CLASSIFICATION_CODE='HCM_PSU' AND HR_ORG_UNIT_CLASSIFICATIONS_F.STATUS='A' AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=PAY_CIR_CARDS_VL.SOURCE_ID AND PAY_CIR_CARDS_VL.SOURCE_TYPE='PSU'",
                "DLoadCIRAttributeTables":"HR_ALL_ORGANIZATION_UNITS_F_VL;HR_ORG_UNIT_CLASSIFICATIONS_F",
                "DLoadLOVViewDefName":"oracle.apps.hcm.common.pay.publicView.parameters.PayrollStatutoryUnitPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_CHOOSE_PAYROLL_STATUTORY_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT"
            }
        },
        "RangeEndDate":{
            "type":"string",
            "description":"Range end date for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "DLoadHidden":"true"
            }
        },
        "RangeMode":{
            "type":"string",
            "description":"RangeMode controls certain date effective behavior for the update or delete of component date ranges.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "DLoadHidden":"true"
            }
        },
        "RangeStartDate":{
            "type":"string",
            "description":"Range start date for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "DLoadHidden":"true"
            }
        },
        "Role":{
            "type":"string",
            "description":"Role of the user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "SecBaseClassificationName":{
            "maxLength":160,
            "type":"string",
            "description":"Secondary base classification name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "SecondaryClassificationId":{
            "type":"number",
            "description":"Secondary classification ID of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "SourceId":{
            "type":"integer",
            "description":"Payroll relationship ID of the employee for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.CardSourceIdHelper\");"
            }
        },
        "SourceSystemId":{
            "type":"string",
            "description":"Source system identifier for component date ranges.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemOwner":{
            "type":"string",
            "description":"Source system owner for component date ranges.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of source associated with the calculation card component date range.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "Subpriority":{
            "type":"integer",
            "description":"Subpriority of the calculation card component date range.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "SystemPersonType":{
            "type":"string",
            "description":"System person type for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "TaxReportingUnitName":{
            "type":"string",
            "description":"Tax reporting unit name assigned to the calculation card for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_CHOOSE_TAX_REPORTING_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT",
                "DLoadLOVReturnAttributes":"TruName",
                "DLoadLOVDisplayAttributes":"[TruName]",
                "DLoadCIRAttributeTableAndColumn":"XLE_ETB_PROFILES.NAME",
                "DLoadCIRAttributeWhereClause":"XLE_ETB_PROFILES.ESTABLISHMENT_ID = HR_ALL_ORGANIZATION_UNITS_F_VL.ESTABLISHMENT_ID AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID = HR_ORG_UNIT_CLASSIFICATIONS_F.ORGANIZATION_ID AND HR_ORG_UNIT_CLASSIFICATIONS_F.CLASSIFICATION_CODE = 'HCM_TRU' AND HR_ORG_UNIT_CLASSIFICATIONS_F.STATUS = 'A' AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=PAY_CIR_CARDS_VL.SOURCE_ID AND PAY_CIR_CARDS_VL.SOURCE_TYPE='TRU'",
                "DLoadCIRAttributeTables":"HR_ALL_ORGANIZATION_UNITS_F_VL;HR_ORG_UNIT_CLASSIFICATIONS_F",
                "DLoadLOVViewDefName":"oracle.apps.hcm.common.pay.publicView.parameters.TaxReportingUnitPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_CHOOSE_TAX_REPORTING_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT"
            }
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : calculationEntries-CIRComponent-item-response

Type: object

Show Source

ActiveFlag: boolean

Maximum Length: 60

Indicates whether the calculation card component is active.
AssignmentId: integer

Assignment ID of the employee.
AssignmentNumber: string

Assignment number of the employee.
AssociableTru: string

Maximum Length: 30

Associated tax reporting units.
AttachmentEntityName: string

Maximum Length: 40

Entity name of the attachment.
BaseClassificationName: string

Maximum Length: 160

Base classification name.
BaseComponentName: string

Maximum Length: 80

Base component name of the calculation card component.
BaseComponentNameFilter: string

Regular expression used to filter components by base component name for the specified calculation card definition ID.
BaseDeductionGroupName: string

Maximum Length: 240

Base deduction group name of the calculation card component.
BIPFormLinks: string

BIP form links of the calculation card component.
CardEffectiveEndDate: string (date)

Effective end date of the calculation card for component.
CardEffectiveStartDate: string (date)

Effective start date of the calculation card for component.
CardLevel: string

Maximum Length: 30

Card level of the calculation card.
CardSequence: integer (int64)

Card sequence of the calculation card.
CIRComponentAssociation: array Calculation Card Component Associations

Title: Calculation Card Component Associations

The CIRComponentAssociation resource returns list of associations associated with a calculation card.
CIRComponentAttachments: array Calculation Card Component Attachments

Title: Calculation Card Component Attachments

The CIRComponentAttachmentsVO resource returns attachments associated with a calculation card.
CIRComponentDateRanges: array Calculation Card Component Overrides

Title: Calculation Card Component Overrides

The resource CIRComponentDateRanges returns overrides associated with a calculation card component with different date ranges.
CIREffectiveDate: string (date)

Effective start date of the calculation card component.
CIRMode: string

Default Value: LOADER

Represents the current mode of the component.
ClassificationId: number

Classification ID of the calculation card component.
ComponentDiscriminator: string

Maximum Length: 255

Value that identifies the specific type of calculation card component.
ComponentEffectiveEndDate: string (date)

Effective end date of the calculation card component.
ComponentEffectiveStartDate: string (date)

Effective start date of the calculation card component for component.
ComponentSequence: integer (int64)

Sequence value of the calculation card component.
Context1: string

Maximum Length: 150

Reference Value 1.
Context2: string

Maximum Length: 150

Reference Value 2.
Context3: string

Maximum Length: 150

Reference Value 3.
Context4: string

Maximum Length: 150

Reference Value 4.
Context5: string

Maximum Length: 150

Reference Value 5.
Context6: string

Maximum Length: 150

Reference Value 6.
DeductionGroupId: integer (int64)

Deduction group ID of the calculation card component.
DeductionGroupName: string

Maximum Length: 240

Deduction group name of the calculation card component.
DirCardCompDefId: integer (int64)

Definition ID of the calculation card component.
DirCardCompDefName: string

Maximum Length: 80

Definition name of the calculation card component.
DirCardCompId: integer (int64)

Calculation card component ID.
DirCardDefinitionBaseName: string

Maximum Length: 80

Definition base name of the calculation card.
DirCardDefinitionId: integer (int64)

Definition ID of the calculation card.
DirCardDefinitionName: string

Maximum Length: 80

Definition name of the calculation card.
DirCardId: integer (int64)

Unique identifier for the calculation card.
DynamicAttributeNames: string

Attribute names of the calculation card component.
DynamicData: string

Attribute used to submit calculation card component data.
DynamicDataDetails: string

Read-only representation of the calculation card component metadata and values.
EffectiveDatedFlag: boolean

Maximum Length: 255

Effective dated indicator.
EffectiveEndDate: string (date)

Effective end date of the calculation card component for component.
EffectiveStartDate: string (date)

Effective start date of the card component for component.
ElementTypeId: integer (int64)

Element type ID of the calculation card component.
GroupBaseComponentName: string

Maximum Length: 80

Group base component name of the calculation card component.
GroupComponentName: string

Maximum Length: 80

Group component name of the calculation card component.
GroupDirCardCompDefId: integer

Group component definition ID of the calculation card component.
GroupIdentifierNames: string

Group identifier names of the calculation card component.
GroupName: string

Group name of the calculation card component.
GUID: string

GUID details for the component.
IgnoreCompsWithoutOvdOrFlexes: string

Default Value: N

Indicates whether calculation card components without overrides or flexfields are ignored.
IgnoreTUContextComps: string

Default Value: Y

Indicates whether calculation card components with tax unit context are ignored.
LegislativeDataGroupId: integer (int64)

Legislative data group ID of the employee payroll relationship.
LegislativeDataGroupName: string

Maximum Length: 240

Legislative data group name of the employee payroll relationship.
LevelCode: string

Maximum Length: 30

Level code for the component.
links: array Links

Title: Links

The link relations associated with the resource instance.
OverrideNames: string

Overrides names of the calculation card component.
ParentDirCardCompDefId: integer

Component definition ID of the calculation card components parent component.
ParentDirCardCompId: integer (int64)

Component ID of the calculation card components parent component.
PayrollRelationshipId: integer

Payroll relationship ID of the employee.
PayrollRelationshipNumber: string

Payroll relationship number of the employee.
PayrollStatUnitId: integer

Identifier for the payroll statutory unit.
PayrollStatutoryUnitName: string

Name of the payroll statutory unit.
RangeEndDate: string (date)

Range end date for the component.
RangeMode: string

RangeMode controls certain date effective operations for the update or delete of calculation card component.
RangeStartDate: string (date)

Range start date for the component.
Role: string

Default Value: MGR

Role of user.
SecBaseClassificationName: string

Maximum Length: 160

Secondary base classification name of the calculation card component.
SecondaryClassificationId: number

Secondary classification ID of the calculation card component.
SourceId: integer (int64)

Payroll relationship ID of the employee for component.
SourceSystemId: string

Source system identifier for the component.
SourceSystemOwner: string

Details of the source system owner for the component.
SourceType: string

Maximum Length: 30

Type of source associated with the calculation card component.
Subpriority: integer

Title: Subprocessing Order

Subprocessing order of the calculation card component.
SystemPersonType: string

System person type.
TaxReportingUnitName: string

Tax reporting unit name assigned to the calculation card.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":60,
            "type":"boolean",
            "description":"Indicates whether the calculation card component is active.",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestDisplayType":"CHECKBOX",
                "DLoadCIRRestDisplayAttrList":"[MeaningWithTag]",
                "DLoadCIRRestReturnAttrName":"Code",
                "DLoadCIRCheckboxCheckedValue":"Y",
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.deductions.personalRecords.protectedUiModel.cir.view.CIRHcmLookupTypeVO",
                "DLoadCIRRestListQueryCriteria":"findByCodeMeaningAndTag",
                "DLoadCIRRestListBindMap":"[LookupTypeBindVar:'YES_NO']",
                "DLoadCIRCheckboxUnCheckedValue":"N",
                "DLoadHidden":"true",
                "DLoadCIRCustomOjTransform":"Y"
            },
            "x-oj":{
                "transform":{
                    "path":"vx/oracle_hcm_calculationentriesusextUI/ui/self/applications/americas-calculation-cards/resources/js/cirdynamicobjectutils",
                    "name":"transformCIRUIHints"
                }
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Assignment ID of the employee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadForeignIntegration":"Assignment;AssignmentId;PER_ALL_ASSIGNMENTS_M;ASSIGNMENT_ID",
                "ForeignVOAttributeName":"AssignmentId",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.registrations.publicView.PayrollAssignmentPVO\",\"findByAssignmentNumber\",\"AssignmentNumber:pAssignmentNumber\",\"findByAssignmentId\",\"AssignmentId:pAssignmentId\");",
                "DLoadSpreadsheetHideAttribute":"true"
            }
        },
        "AssignmentNumber":{
            "type":"string",
            "description":"Assignment number of the employee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_REL_GROUPS_DN__PayrollAssignmentPEO",
                "DLoadLOVReturnAttributes":"AssignmentNumber",
                "DLoadLOVDisplayAttributes":"[AssignmentNumber]",
                "DLoadCIRAttributeTableAndColumn":"PAY_REL_GROUPS_DN.ASSIGNMENT_NUMBER",
                "DLoadCIRAttributeWhereClause":"PAY_REL_GROUPS_DN.GROUP_TYPE = 'A';PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_CIR_CARD_COMPONENTS_VL.SOURCE_ID",
                "HcmComparable":"True",
                "DLoadLOVViewDefName":"oracle.apps.hcm.payrolls.registrations.publicView.PayrollAssignmentPVO",
                "DLoadCIRDependentAttributeWhereClause":"PayrollRelationshipNumber:PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_REL_GROUPS_DN__PayrollAssignmentPEO"
            }
        },
        "AssociableTru":{
            "maxLength":30,
            "type":"string",
            "description":"Associated tax reporting units.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":40,
            "type":"string",
            "description":"Entity name of the attachment.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "BIPFormLinks":{
            "type":"string",
            "description":"BIP form links of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseClassificationName":{
            "maxLength":160,
            "type":"string",
            "description":"Base classification name.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "BaseComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Base component name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "BaseComponentNameFilter":{
            "type":"string",
            "description":"Regular expression used to filter components by base component name for the specified calculation card definition ID.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseDeductionGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Base deduction group name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "CIRComponentAssociation":{
            "title":"Calculation Card Component Associations",
            "type":"array",
            "description":"The CIRComponentAssociation resource returns list of associations associated with a calculation card.",
            "items":{
                "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentAssociation-item-response"
            }
        },
        "CIRComponentAttachments":{
            "title":"Calculation Card Component Attachments",
            "type":"array",
            "description":"The CIRComponentAttachmentsVO resource returns attachments associated with a calculation card.",
            "items":{
                "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentAttachments-item-response"
            }
        },
        "CIRComponentDateRanges":{
            "title":"Calculation Card Component Overrides",
            "type":"array",
            "description":"The resource CIRComponentDateRanges returns overrides associated with a calculation card component with different date ranges.",
            "items":{
                "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentDateRanges-item-response"
            },
            "x-cardinality":"1"
        },
        "CIREffectiveDate":{
            "type":"string",
            "description":"Effective start date of the calculation card component.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "CIRMode":{
            "type":"string",
            "description":"Represents the current mode of the component.",
            "nullable":true,
            "default":"LOADER",
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "CardEffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card for component.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "CardEffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card for component.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "CardLevel":{
            "maxLength":30,
            "type":"string",
            "description":"Card level of the calculation card.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "CardSequence":{
            "type":"integer",
            "description":"Card sequence of the calculation card.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClassificationId":{
            "type":"number",
            "description":"Classification ID of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "ComponentDiscriminator":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the specific type of calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.bo.view.DIRCardComponentBO",
                "includeInCompactView":true,
                "DLoadCIRElementClassificationRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentElementClassificationVO",
                "DLoadHidden":"true",
                "dependencies":[
                    "Context1",
                    "Context2",
                    "Context3",
                    "Context4",
                    "Context5",
                    "Context6",
                    "DirCardCompDefId"
                ]
            }
        },
        "ComponentEffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card component.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "ComponentEffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card component for component.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "ComponentSequence":{
            "type":"integer",
            "description":"Sequence value of the calculation card component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "Context1":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 1.",
            "nullable":true,
            "x-queryable":true
        },
        "Context2":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 2.",
            "nullable":true,
            "x-queryable":true
        },
        "Context3":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 3.",
            "nullable":true,
            "x-queryable":true
        },
        "Context4":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 4.",
            "nullable":true,
            "x-queryable":true
        },
        "Context5":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 5.",
            "nullable":true,
            "x-queryable":true
        },
        "Context6":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 6.",
            "nullable":true,
            "x-queryable":true
        },
        "DeductionGroupId":{
            "type":"integer",
            "description":"Deduction group ID of the calculation card component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentDeductionGroupVO",
                "includeInCompactView":true,
                "precision":18,
                "DLoadHidden":"true",
                "dependencies":[
                    "DirCardDefinitionBaseName",
                    "DirCardDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "DeductionGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Deduction group name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "DirCardCompDefId":{
            "type":"integer",
            "description":"Definition ID of the calculation card component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentDefVO",
                "includeInCompactView":true,
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.DIRCardCompDefVO\",\"DirCardCompDefName:ComponentName;LegislativeDataGroupId;DirCardDefinitionId\",\"DirCardCompDefId\");",
                "dependencies":[
                    "BaseComponentNameFilter",
                    "DeductionGroupId",
                    "IgnoreTUContextComps",
                    "Role"
                ]
            },
            "x-queryable":true
        },
        "DirCardCompDefName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DirCardCompId":{
            "type":"integer",
            "description":"Calculation card component ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.ComponentDirCardCompIdHelper\");",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DirCardDefinitionBaseName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition base name of the calculation card.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "DirCardDefinitionId":{
            "type":"integer",
            "description":"Definition ID of the calculation card.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.DIRCardDefinitionVO\",\"DirCardDefinitionName:DisplayName;LegislativeDataGroupId:LegislativeDataGroupId\",\"DirCardDefinitionId:DirCardDefinitionId\");"
            },
            "x-queryable":true
        },
        "DirCardDefinitionName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition name of the calculation card.",
            "nullable":true,
            "x-queryable":true
        },
        "DirCardId":{
            "type":"integer",
            "description":"Unique identifier for the calculation card.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.ComponentDirCardIdHelper\");"
            },
            "x-queryable":true
        },
        "DynamicAttributeNames":{
            "type":"string",
            "description":"Attribute names of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "DynamicData":{
            "type":"string",
            "description":"Attribute used to submit calculation card component data.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "DynamicDataDetails":{
            "type":"string",
            "description":"Read-only representation of the calculation card component metadata and values.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "EffectiveDatedFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Effective dated indicator.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card component for component.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the card component for component.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"Element type ID of the calculation card component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "GUID":{
            "type":"string",
            "description":"GUID details for the component.",
            "nullable":true,
            "x-queryable":false
        },
        "GroupBaseComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Group base component name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "GroupComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Group component name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "GroupDirCardCompDefId":{
            "type":"integer",
            "description":"Group component definition ID of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "GroupIdentifierNames":{
            "type":"string",
            "description":"Group identifier names of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true",
                "DLoadCIRCustomOjTransform":"Y"
            },
            "x-oj":{
                "transform":{
                    "path":"vx/oracle_hcm_calculationentriesusextUI/ui/self/applications/americas-calculation-cards/resources/js/cirdynamicobjectutils",
                    "name":"transformCIRUIHints"
                }
            }
        },
        "GroupName":{
            "type":"string",
            "description":"Group name of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "IgnoreCompsWithoutOvdOrFlexes":{
            "type":"string",
            "description":"Indicates whether calculation card components without overrides or flexfields are ignored.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "IgnoreTUContextComps":{
            "type":"string",
            "description":"Indicates whether calculation card components with tax unit context are ignored.",
            "nullable":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Legislative data group ID of the employee payroll relationship.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.LegislativeDataGroupVO\",\"LegislativeDataGroupName:Name\",\"LegislativeDataGroupId:LegislativeDataGroupId\");"
            },
            "x-queryable":true
        },
        "LegislativeDataGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Legislative data group name of the employee payroll relationship.",
            "nullable":true,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PER_CHOOSE_LEGISLATIVE_DATA_GROUP_DATA__PER_LEGISLATIVE_DATA_GROUPS__LegislativeDataGroupPEO",
                "DLoadLOVReturnAttributes":"Name",
                "DLoadLOVDisplayAttributes":"[Name]",
                "DLoadLOVViewDefName":"oracle.apps.hcm.legislativeDataGroups.publicView.LegislativeDataGroupPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PER_CHOOSE_LEGISLATIVE_DATA_GROUP_DATA__PER_LEGISLATIVE_DATA_GROUPS__LegislativeDataGroupPEO"
            },
            "x-queryable":true
        },
        "LevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Level code for the component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "OverrideNames":{
            "type":"string",
            "description":"Overrides names of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "ParentDirCardCompDefId":{
            "type":"integer",
            "description":"Component definition ID of the calculation card components parent component.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "ParentDirCardCompId":{
            "type":"integer",
            "description":"Component ID of the calculation card components parent component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "PayrollRelationshipId":{
            "type":"integer",
            "description":"Payroll relationship ID of the employee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "PayrollRelationshipNumber":{
            "type":"string",
            "description":"Payroll relationship number of the employee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_PAY_RELATIONSHIPS_DN__PayrollRelationshipPEO",
                "DLoadLOVReturnAttributes":"PayrollRelationshipNumber",
                "DLoadLOVDisplayAttributes":"[PayrollRelationshipNumber]",
                "DLoadCIRAttributeTableAndColumn":"PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_NUMBER",
                "DLoadCIRAttributeWhereClause":"PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_CIR_CARD_COMPONENTS_VL.SOURCE_ID",
                "HcmComparable":"True",
                "DLoadLOVViewDefName":"oracle.apps.hcm.payrolls.registrations.publicView.PayrollRelationshipPVO",
                "DLoadCIRDependentAttributeWhereClause":"AssignmentNumber:PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_PAY_RELATIONSHIPS_DN__PayrollRelationshipPEO"
            }
        },
        "PayrollStatUnitId":{
            "type":"integer",
            "description":"Identifier for the payroll statutory unit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "PayrollStatutoryUnitName":{
            "type":"string",
            "description":"Name of the payroll statutory unit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_CHOOSE_PAYROLL_STATUTORY_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT",
                "DLoadLOVReturnAttributes":"Name",
                "DLoadLOVDisplayAttributes":"[Name]",
                "DLoadCIRAttributeTableAndColumn":"XLE_ENTITY_PROFILES.NAME",
                "DLoadCIRAttributeWhereClause":"XLE_ENTITY_PROFILES.LEGAL_ENTITY_ID=HR_ALL_ORGANIZATION_UNITS_F_VL.LEGAL_ENTITY_ID AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=HR_ORG_UNIT_CLASSIFICATIONS_F.ORGANIZATION_ID AND HR_ORG_UNIT_CLASSIFICATIONS_F.CLASSIFICATION_CODE='HCM_PSU' AND HR_ORG_UNIT_CLASSIFICATIONS_F.STATUS='A' AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=PAY_CIR_CARDS_VL.SOURCE_ID AND PAY_CIR_CARDS_VL.SOURCE_TYPE='PSU'",
                "DLoadCIRAttributeTables":"HR_ALL_ORGANIZATION_UNITS_F_VL;HR_ORG_UNIT_CLASSIFICATIONS_F",
                "DLoadLOVViewDefName":"oracle.apps.hcm.common.pay.publicView.parameters.PayrollStatutoryUnitPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_CHOOSE_PAYROLL_STATUTORY_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT"
            }
        },
        "RangeEndDate":{
            "type":"string",
            "description":"Range end date for the component.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "sortable":false
            }
        },
        "RangeMode":{
            "type":"string",
            "description":"RangeMode controls certain date effective operations for the update or delete of calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RangeStartDate":{
            "type":"string",
            "description":"Range start date for the component.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "sortable":false
            }
        },
        "Role":{
            "type":"string",
            "description":"Role of user.",
            "nullable":true,
            "default":"MGR",
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "SecBaseClassificationName":{
            "maxLength":160,
            "type":"string",
            "description":"Secondary base classification name of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "SecondaryClassificationId":{
            "type":"number",
            "description":"Secondary classification ID of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "SourceId":{
            "type":"integer",
            "description":"Payroll relationship ID of the employee for component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.CardSourceIdHelper\");"
            },
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"string",
            "description":"Source system identifier for the component.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemOwner":{
            "type":"string",
            "description":"Details of the source system owner for the component.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of source associated with the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "Subpriority":{
            "title":"Subprocessing Order",
            "type":"integer",
            "description":"Subprocessing order of the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "SystemPersonType":{
            "type":"string",
            "description":"System person type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "TaxReportingUnitName":{
            "type":"string",
            "description":"Tax reporting unit name assigned to the calculation card.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_CHOOSE_TAX_REPORTING_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT",
                "DLoadLOVReturnAttributes":"TruName",
                "DLoadLOVDisplayAttributes":"[TruName]",
                "DLoadCIRAttributeTableAndColumn":"XLE_ETB_PROFILES.NAME",
                "DLoadCIRAttributeWhereClause":"XLE_ETB_PROFILES.ESTABLISHMENT_ID = HR_ALL_ORGANIZATION_UNITS_F_VL.ESTABLISHMENT_ID AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID = HR_ORG_UNIT_CLASSIFICATIONS_F.ORGANIZATION_ID AND HR_ORG_UNIT_CLASSIFICATIONS_F.CLASSIFICATION_CODE = 'HCM_TRU' AND HR_ORG_UNIT_CLASSIFICATIONS_F.STATUS = 'A' AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=PAY_CIR_CARDS_VL.SOURCE_ID AND PAY_CIR_CARDS_VL.SOURCE_TYPE='TRU'",
                "DLoadCIRAttributeTables":"HR_ALL_ORGANIZATION_UNITS_F_VL;HR_ORG_UNIT_CLASSIFICATIONS_F",
                "DLoadLOVViewDefName":"oracle.apps.hcm.common.pay.publicView.parameters.TaxReportingUnitPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_CHOOSE_TAX_REPORTING_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Calculation Card Component Associations

Type: array

Title: Calculation Card Component Associations

The CIRComponentAssociation resource returns list of associations associated with a calculation card.

Show Source

Array of: object calculationEntries-CIRComponent-CIRComponentAssociation-item-response

{
    "title":"Calculation Card Component Associations",
    "type":"array",
    "description":"The CIRComponentAssociation resource returns list of associations associated with a calculation card.",
    "items":{
        "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentAssociation-item-response"
    }
}

Nested Schema : Calculation Card Component Attachments

Type: array

Title: Calculation Card Component Attachments

The CIRComponentAttachmentsVO resource returns attachments associated with a calculation card.

Show Source

Array of: object calculationEntries-CIRComponent-CIRComponentAttachments-item-response

{
    "title":"Calculation Card Component Attachments",
    "type":"array",
    "description":"The CIRComponentAttachmentsVO resource returns attachments associated with a calculation card.",
    "items":{
        "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentAttachments-item-response"
    }
}

Nested Schema : Calculation Card Component Overrides

Type: array

Title: Calculation Card Component Overrides

The resource CIRComponentDateRanges returns overrides associated with a calculation card component with different date ranges.

Show Source

Array of: object calculationEntries-CIRComponent-CIRComponentDateRanges-item-response

{
    "title":"Calculation Card Component Overrides",
    "type":"array",
    "description":"The resource CIRComponentDateRanges returns overrides associated with a calculation card component with different date ranges.",
    "items":{
        "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentDateRanges-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : calculationEntries-CIRComponent-CIRComponentAssociation-item-response

Type: object

Show Source

AssociableTru: string

Read Only: true

Maximum Length: 30

Associated tax reporting units for component association.
BaseComponentName: string

Read Only: true

Maximum Length: 80

Base component name of the calculation card association.
BaseDisplayName: string

Read Only: true

Maximum Length: 80

Base display name of the calculation card association.
CIRComponentAssociationDetails: array Calculation Card Component Association Details

Title: Calculation Card Component Association Details

The CIRComponentAssociationDetails resource returns details of the calculation card association.
ComponentName: string

Read Only: true

Maximum Length: 80

Component name of calculation card association.
CreatedBy: string

Read Only: true

Maximum Length: 64

Name of the person who created the calculation card component association.
CreationDate: string (date-time)

Read Only: true

Creation date of the calculation card component association.
DirCardCompDefId: integer (int64)

Read Only: true

Definition ID of the calculation card component for component association.
DirCardCompId: integer (int64)

Title: Component Base Name

Unique identifier for the calculation card component.
DirCardDefinitionId: integer (int64)

Read Only: true

Definition ID of the calculation card for component association.
DirCardId: integer (int64)

Title: Calculation Card Name

Unique identifier for the calculation card for component association.
DirRepCardId: integer (int64)

Unique identifier for the reporting card.
DisplayName: string

Read Only: true

Maximum Length: 80

Display name of the calculation card association.
EffectiveEndDate: string (date)

Effective end date of the calculation card association.
EffectiveStartDate: string (date)

Effective start date of the calculation card association.
GUID: string

GUID for the component association.
LastUpdateDate: string (date-time)

Read Only: true

Last updated date of the calculation card component association.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

Name of the person who last updated the calculation card component association.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

Last update login of the calculation card component association.
LegisCode: string

Legislation code for component association.
LegislationDiscriminator: string

Read Only: true

Legislation discriminator for the component association.
LegislativeDataGroupId: integer (int64)

Read Only: true

Legislation data group ID.
links: array Links

Title: Links

The link relations associated with the resource instance.
ObjectVersionNumber: integer (int32)

Current object version number for the calculation card component association.
PayrollStatUnitId: integer

Payroll statutory unit ID.
SourceSystemId: string

Source system identifier for component association.
SourceSystemOwner: string

Source system owner for component association.
TaxGroupName: string

Maximum Length: 255

Tax group name of the calculation card association.
TaxUnitId: integer (int64)

Title: Tax Reporting Unit

Tax unit ID of the calculation card association.
TruBatchId: string

Maximum Length: 80

Tax reporting unit batch ID.

{
    "type":"object",
    "properties":{
        "AssociableTru":{
            "maxLength":30,
            "type":"string",
            "description":"Associated tax reporting units for component association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaseComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Base component name of the calculation card association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaseDisplayName":{
            "maxLength":80,
            "type":"string",
            "description":"Base display name of the calculation card association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CIRComponentAssociationDetails":{
            "title":"Calculation Card Component Association Details",
            "type":"array",
            "description":"The CIRComponentAssociationDetails resource returns details of the calculation card association.",
            "items":{
                "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentAssociation-CIRComponentAssociationDetails-item-response"
            }
        },
        "ComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Component name of calculation card association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the person who created the calculation card component association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date of the calculation card component association.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DirCardCompDefId":{
            "type":"integer",
            "description":"Definition ID of the calculation card component for component association.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirCardCompId":{
            "title":"Component Base Name",
            "type":"integer",
            "description":"Unique identifier for the calculation card component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirCardDefinitionId":{
            "type":"integer",
            "description":"Definition ID of the calculation card for component association.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirCardId":{
            "title":"Calculation Card Name",
            "type":"integer",
            "description":"Unique identifier for the calculation card for component association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirRepCardId":{
            "type":"integer",
            "description":"Unique identifier for the reporting card.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DisplayName":{
            "maxLength":80,
            "type":"string",
            "description":"Display name of the calculation card association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card association.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card association.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "GUID":{
            "type":"string",
            "description":"GUID for the component association.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date of the calculation card component association.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last update login of the calculation card component association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the person who last updated the calculation card component association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegisCode":{
            "type":"string",
            "description":"Legislation code for component association.",
            "nullable":true,
            "x-queryable":false
        },
        "LegislationDiscriminator":{
            "type":"string",
            "description":"Legislation discriminator for the component association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DirCardCompId",
                    "DirCardId"
                ]
            }
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Legislation data group ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Current object version number for the calculation card component association.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PayrollStatUnitId":{
            "type":"integer",
            "description":"Payroll statutory unit ID.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"string",
            "description":"Source system identifier for component association.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemOwner":{
            "type":"string",
            "description":"Source system owner for component association.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxGroupName":{
            "maxLength":255,
            "type":"string",
            "description":"Tax group name of the calculation card association.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxUnitId":{
            "title":"Tax Reporting Unit",
            "type":"integer",
            "description":"Tax unit ID of the calculation card association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestDisplayType":"CHOICE",
                "DLoadCIRRestDisplayAttrList":"[Name]",
                "DLoadCIRRestReturnAttrName":"OrganizationId",
                "DLoadCIRRestVoName":"oracle.apps.hcm.common.pay.publicModel.view.TaxReportingUnitPVO",
                "controlType":"choice",
                "DLoadCIRRestListQueryCriteria":"[findActiveByDate,findByPsuOrganizationId,findByLdgId]",
                "DLoadCIRRestListBindMap":"[pDate:'{DEPENDENT.EffectiveStartDate}';pPsuOrganizationId:'{DEPENDENT.PayrollStatUnitId}';pLdgId:'{DEPENDENT.LegislativeDataGroupId}']",
                "precision":18,
                "displayMode":"displayAttribute"
            },
            "x-queryable":true
        },
        "TruBatchId":{
            "maxLength":80,
            "type":"string",
            "description":"Tax reporting unit batch ID.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Calculation Card Component Association Details

Type: array

Title: Calculation Card Component Association Details

The CIRComponentAssociationDetails resource returns details of the calculation card association.

Show Source

Array of: object calculationEntries-CIRComponent-CIRComponentAssociation-CIRComponentAssociationDetails-item-response

{
    "title":"Calculation Card Component Association Details",
    "type":"array",
    "description":"The CIRComponentAssociationDetails resource returns details of the calculation card association.",
    "items":{
        "$ref":"#/components/schemas/calculationEntries-CIRComponent-CIRComponentAssociation-CIRComponentAssociationDetails-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : calculationEntries-CIRComponent-CIRComponentAssociation-CIRComponentAssociationDetails-item-response

Type: object

Show Source

AssignmentNumber: string

Maximum Length: 255

Assignment number of the calculation card association.
AssociableTru: string

Read Only: true

Maximum Length: 30

Associated tax reporting units for component association details.
BaseComponentName: string

Read Only: true

Maximum Length: 80

Base component name of the calculation card association for component association details.
BaseDisplayName: string

Read Only: true

Maximum Length: 80

Base display name of the calculation card association for component association details.
ComponentName: string

Read Only: true

Maximum Length: 80

Component name of the calculation card association.
CreatedBy: string

Read Only: true

Maximum Length: 64

Name of the person who created the calculation card component association details.
CreationDate: string (date-time)

Read Only: true

Creation date of the calculation card component association details.
DirCardCompDefId: integer (int64)

Read Only: true

Definition ID of the calculation card component for component association details.
DirCardCompId: integer (int64)

Title: Component Base Name

Unique identifier of the calculation card for component association details.
DirCardDefinitionId: integer (int64)

Read Only: true

Definition ID of the calculation card for component association details.
DirCardId: integer (int64)

Read Only: true

Calculation card identifier.
DirRepCardId: integer (int64)

Unique identifier for the reporting card for component association details.
DirRepCardUsageId: integer (int64)

Unique identifier for the reporting card usage.
DisplayName: string

Read Only: true

Maximum Length: 80

Display name of the calculation card association for component association details.
EffectiveEndDate: string (date)

Effective end date of the calculation card association details.
EffectiveStartDate: string (date)

Effective start date of the calculation card association details.
GUID: string

GUID for component association details.
LastUpdateDate: string (date-time)

Read Only: true

Last updated date of the calculation card component association details.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

Name of the person who last updated the calculation card component association details.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

Last update login of the calculation card component association details.
LegisCode: string

Legislation code for component association details.
LegislationDiscriminator: string

Read Only: true

Legislation discriminator for component association details.
links: array Links

Title: Links

The link relations associated with the resource instance.
ObjectVersionNumber: integer (int32)

Current object version number for the calculation card component association details.
PayrollRelationshipId: integer (int64)

Read Only: true

Payroll relationship ID of the employee for component association details.
RelationshipGroupId: integer (int64)

Title: Employment Terms Number

Relationship group ID.
SourceSystemId: string

Source system identifier for component association details.
SourceSystemOwner: string

Source system owner for component association details.
TierIndicator: string

Maximum Length: 255

Tier Indicator for the calculation card association details.
WorkAtHome: string

Maximum Length: 255

Work at home status of the employee assignment.

{
    "type":"object",
    "properties":{
        "AssignmentNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Assignment number of the calculation card association.",
            "nullable":true,
            "x-queryable":true
        },
        "AssociableTru":{
            "maxLength":30,
            "type":"string",
            "description":"Associated tax reporting units for component association details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaseComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Base component name of the calculation card association for component association details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaseDisplayName":{
            "maxLength":80,
            "type":"string",
            "description":"Base display name of the calculation card association for component association details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Component name of the calculation card association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the person who created the calculation card component association details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date of the calculation card component association details.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DirCardCompDefId":{
            "type":"integer",
            "description":"Definition ID of the calculation card component for component association details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirCardCompId":{
            "title":"Component Base Name",
            "type":"integer",
            "description":"Unique identifier of the calculation card for component association details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirCardDefinitionId":{
            "type":"integer",
            "description":"Definition ID of the calculation card for component association details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirCardId":{
            "type":"integer",
            "description":"Calculation card identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DirRepCardId":{
            "type":"integer",
            "description":"Unique identifier for the reporting card for component association details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirRepCardUsageId":{
            "type":"integer",
            "description":"Unique identifier for the reporting card usage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DisplayName":{
            "maxLength":80,
            "type":"string",
            "description":"Display name of the calculation card association for component association details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card association details.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card association details.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "GUID":{
            "type":"string",
            "description":"GUID for component association details.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date of the calculation card component association details.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last update login of the calculation card component association details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the person who last updated the calculation card component association details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegisCode":{
            "type":"string",
            "description":"Legislation code for component association details.",
            "nullable":true,
            "x-queryable":false
        },
        "LegislationDiscriminator":{
            "type":"string",
            "description":"Legislation discriminator for component association details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DirRepCardId"
                ]
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Current object version number for the calculation card component association details.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PayrollRelationshipId":{
            "type":"integer",
            "description":"Payroll relationship ID of the employee for component association details.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipGroupId":{
            "title":"Employment Terms Number",
            "type":"integer",
            "description":"Relationship group ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DLoadCIRRestDisplayType":"CHOICE",
                "DLoadCIRRestDisplayAttrList":"[AssignmentNumber]",
                "DLoadCIRRestReturnAttrName":"RelationshipGroupId",
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.deductions.personalRecords.protectedUiModel.cir.view.CalculationCardPayRelGroupsVO",
                "controlType":"choice",
                "DLoadCIRRestListQueryCriteria":"[findByPayRelId]",
                "DLoadCIRRestListBindMap":"[pEffectiveDate:'{DEPENDENT.EffectiveStartDate}';pPayRelId:'{DEPENDENT.PayrollRelationshipId}';pTier:'{DEPENDENT.TierIndicator}']",
                "precision":18,
                "displayMode":"displayAttribute"
            },
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"string",
            "description":"Source system identifier for component association details.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemOwner":{
            "type":"string",
            "description":"Source system owner for component association details.",
            "nullable":true,
            "x-queryable":false
        },
        "TierIndicator":{
            "maxLength":255,
            "type":"string",
            "description":"Tier Indicator for the calculation card association details.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkAtHome":{
            "maxLength":255,
            "type":"string",
            "description":"Work at home status of the employee assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

Allowed Values: [ "collection", "item", "describe", "other" ]

The kind of the related resource.
name: string

Title: name

The name of the link to the related resource.
properties: object properties
rel: string

Title: relation

Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : calculationEntries-CIRComponent-CIRComponentAttachments-item-response

Type: object

Show Source

AsyncTrackerId: string

Title: Asynchronous Upload Tracker Id

The identifier used to track asynchronous background uploads of file contents. This field can only be used when the DatatypeCode="FILE". When queried it will only show when the ErrorCode="Pending" which signifies that a background upload has been registered but not yet completed. The async tracker id can only be set upon creation of an attachment. If the FileContents and tracker id are set then the tracker will be ignored.
AttachedDocumentId: integer (int64)

Title: Attached Document Id
CategoryName: string

Title: Category

Maximum Length: 30
ContentRepositoryFileShared: boolean

Title: Shared
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 255
CreatedByUserName: string

Title: Created By User Name

Read Only: true
CreationDate: string (date-time)

Title: Creation Date

Read Only: true
DatatypeCode: string

Title: Type

Maximum Length: 30

Default Value: FILE
Description: string

Title: Description

Maximum Length: 255
DmDocumentId: string

Maximum Length: 255
DmFolderPath: string

Title: Dm Folder Path

Maximum Length: 1000
DmVersionNumber: string

Maximum Length: 255
DownloadInfo: string

Title: DownloadInfo
ErrorStatusCode: string

Title: Error Status Code
ErrorStatusMessage: string

Title: Error Status Message
ExpirationDate: string (date-time)

Title: Expiration Date
FileContents: string (byte)

Title: File Contents
FileName: string

Title: File Name

Maximum Length: 2048
FileUrl: string

Title: File Url
FileWebImage: string (byte)

Title: File Web Image

Read Only: true
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 255
LastUpdatedByUserName: string

Title: Last Updated By User

Read Only: true
links: array Links

Title: Links

The link relations associated with the resource instance.
PostProcessingAction: string

Title: PostProcessingAction
Title: string

Title: Title
UploadedFileContentType: string

Title: Uploaded File Content Type
UploadedFileLength: integer

Title: File Size
UploadedFileName: string

Title: Uploaded File Name
UploadedText: string

Title: Uploaded Text
Uri: string

Title: Uri

Maximum Length: 4000
Url: string

Title: Url

Maximum Length: 4000
UserName: string

Title: User Name

Read Only: true

Maximum Length: 255

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The identifier used to track asynchronous background uploads of file contents.  This field can only be used when the DatatypeCode=\"FILE\".  When queried it will only show when the ErrorCode=\"Pending\" which signifies that a background upload has been registered but not yet completed.  The async tracker id can only be set upon creation of an attachment.  If the FileContents and tracker id are set then the tracker will be ignored.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : calculationEntries-CIRComponent-CIRComponentDateRanges-item-response

Type: object

Show Source

AssignmentId: integer

Assignment ID of the employee for component date ranges.
AssignmentNumber: string

Assignment number of the employee for component date ranges.
AttributeCheckSum: string

Check sum of the attribute.
BaseClassificationName: string

Maximum Length: 160

Base classification name for component date ranges.
BaseComponentName: string

Maximum Length: 80

Base component name of the calculation card component for component date ranges.
BaseComponentNameFilter: string

Base component filter.
BaseDeductionGroupName: string

Maximum Length: 240

Base deduction group name of the calculation card component for component date ranges.
CardEffectiveEndDate: string (date)

Effective end date of the calculation card for component date ranges.
CardEffectiveStartDate: string (date)

Effective start date of the calculation card for component date ranges.
CardLevel: string

Maximum Length: 30

Card level for component date ranges.
CardSequence: integer (int64)

Card sequence of the calculation card for component date ranges.
CIREffectiveDate: string (date)

Effective start date of the calculation card component for component date ranges.
CIRMode: string

Represents the current mode of the card component.
ClassificationId: number

Classification ID of the calculation card component for component date ranges.
ComponentDiscriminator: string

Maximum Length: 255

Discriminator for the calculation card component.
ComponentSequence: integer (int64)

Sequence value of the calculation card component for component date ranges.
Context1: string

Maximum Length: 150

Reference Value 1 for component date ranges.
Context2: string

Maximum Length: 150

Reference Value 2 for component date ranges.
Context3: string

Maximum Length: 150

Reference Value 3 for component date ranges.
Context4: string

Maximum Length: 150

Reference Value 4 for component date ranges.
Context5: string

Maximum Length: 150

Reference Value 5 for component date ranges.
Context6: string

Maximum Length: 150

Reference Value 6 for component date ranges.
DeductionGroupId: integer (int64)

Deduction group ID of the calculation card component for component date ranges.
DeductionGroupName: string

Maximum Length: 240

Deduction group name of the calculation card component for component date ranges.
DirCardCompDefId: integer (int64)

Definition ID of the calculation card component for component date ranges.
DirCardCompDefName: string

Maximum Length: 80

Definition name of the calculation card component for component date ranges.
DirCardCompDrId: integer (int64)

Unique identifier for the calculation card component date range.
DirCardCompId: integer (int64)

ID of the calculation card component.
DirCardDefinitionBaseName: string

Maximum Length: 80

Definition base name of the calculation card for component date ranges.
DirCardDefinitionId: integer (int64)

Definition ID of the calculation card for component date ranges.
DirCardDefinitionName: string

Maximum Length: 80

Definition name of the calculation card for component date ranges.
DirCardId: integer (int64)

Unique identifier of the calculation card for component date ranges.
DynamicAttributeNames: string

Attribute names of the calculation card component for component date ranges.
DynamicData: string

DynamicData is the write oriented attribute. Consumers pass a JSON string where each key identifies the calculation card components override attribute to create or change the value
DynamicDataDetails: string

DynamicDataDetails is the read-oriented metadata or value representation. It tells the consumer which dynamic override attributes are available for the calculation card component
EffectiveEndDate: string (date)

Effective end date of calculation card component override.
EffectiveStartDate: string (date)

Effective start date of the calculation card component override.
ElementTypeId: integer (int64)

Element type ID of the calculation card component for component date ranges.
GroupBaseComponentName: string

Maximum Length: 80

Group base component name of the calculation card component for component date ranges.
GroupComponentName: string

Maximum Length: 80

Group component name of the calculation card component for component date ranges.
GroupDirCardCompDefId: integer

Group component definition ID of the calculation card component for component date ranges.
GUID: string

GUID for component date ranges.
IgnoreCompsWithoutOvdOrFlexes: string

Default Value: N

Ignore calculation card components without overrides.
IgnoreTUContextComps: string

Indicates whether calculation card components with tax unit context are ignored for component date ranges.
LegislativeDataGroupId: integer (int64)

Legislative data group ID of the employee payroll relationship for component date ranges.
LegislativeDataGroupName: string

Maximum Length: 240

Legislative data group name of the employee payroll relationship for component date ranges.
LevelCode: string

Maximum Length: 30

Level code for component date ranges.
links: array Links

Title: Links

The link relations associated with the resource instance.
OverrideFlexAttributeDetails: string

Overrides attribute details of the calculation card component.
ParentDirCardCompDefId: integer

Component definition ID of the calculation card components parent component for component date ranges.
ParentDirCardCompId: integer (int64)

Component ID of calculation card components parent component.
PayrollRelationshipId: integer

Payroll Relationship ID of the employee.
PayrollRelationshipNumber: string

Payroll relationship number of the employee for component date ranges.
PayrollStatUnitId: integer

Payroll statutory unit ID for component date ranges.
PayrollStatutoryUnitName: string

Name of the payroll statutory unit for component date ranges.
RangeEndDate: string (date)

Range end date for component date ranges.
RangeMode: string

RangeMode controls certain date effective behavior for the update or delete of component date ranges.
RangeStartDate: string (date)

Range start date for component date ranges.
Role: string

Role of the user.
SecBaseClassificationName: string

Maximum Length: 160

Secondary base classification name of the calculation card component for component date ranges.
SecondaryClassificationId: number

Secondary classification ID of the calculation card component for component date ranges.
SourceId: integer (int64)

Payroll relationship ID of the employee for component date ranges.
SourceSystemId: string

Source system identifier for component date ranges.
SourceSystemOwner: string

Source system owner for component date ranges.
SourceType: string

Maximum Length: 30

Type of source associated with the calculation card component date range.
Subpriority: integer

Subpriority of the calculation card component date range.
SystemPersonType: string

System person type for component date ranges.
TaxReportingUnitName: string

Tax reporting unit name assigned to the calculation card for component date ranges.

{
    "type":"object",
    "properties":{
        "AssignmentId":{
            "type":"integer",
            "description":"Assignment ID of the employee for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadForeignIntegration":"Assignment;AssignmentId;PER_ALL_ASSIGNMENTS_M;ASSIGNMENT_ID",
                "ForeignVOAttributeName":"AssignmentId",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.registrations.publicView.PayrollAssignmentPVO\",\"findByAssignmentNumber\",\"AssignmentNumber:pAssignmentNumber\",\"findByAssignmentId\",\"AssignmentId:pAssignmentId\");",
                "DLoadSpreadsheetHideAttribute":"true"
            }
        },
        "AssignmentNumber":{
            "type":"string",
            "description":"Assignment number of the employee for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_REL_GROUPS_DN__PayrollAssignmentPEO",
                "DLoadLOVReturnAttributes":"AssignmentNumber",
                "DLoadLOVDisplayAttributes":"[AssignmentNumber]",
                "DLoadCIRAttributeTableAndColumn":"PAY_REL_GROUPS_DN.ASSIGNMENT_NUMBER",
                "DLoadCIRAttributeWhereClause":"PAY_REL_GROUPS_DN.GROUP_TYPE = 'A';PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_CIR_CARD_COMPONENTS_DR_VL.SOURCE_ID",
                "HcmComparable":"True",
                "DLoadLOVViewDefName":"oracle.apps.hcm.payrolls.registrations.publicView.PayrollAssignmentPVO",
                "DLoadCIRDependentAttributeWhereClause":"PayrollRelationshipNumber:PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_REL_GROUPS_DN__PayrollAssignmentPEO"
            }
        },
        "AttributeCheckSum":{
            "type":"string",
            "description":"Check sum of the attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseClassificationName":{
            "maxLength":160,
            "type":"string",
            "description":"Base classification name for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "BaseComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Base component name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "BaseComponentNameFilter":{
            "type":"string",
            "description":"Base component filter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "BaseDeductionGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Base deduction group name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "CIREffectiveDate":{
            "type":"string",
            "description":"Effective start date of the calculation card component for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "DLoadHidden":"true"
            }
        },
        "CIRMode":{
            "type":"string",
            "description":"Represents the current mode of the card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "CardEffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the calculation card for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "CardEffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "CardLevel":{
            "maxLength":30,
            "type":"string",
            "description":"Card level for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "CardSequence":{
            "type":"integer",
            "description":"Card sequence of the calculation card for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClassificationId":{
            "type":"number",
            "description":"Classification ID of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "ComponentDiscriminator":{
            "maxLength":255,
            "type":"string",
            "description":"Discriminator for the calculation card component.",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.bo.view.DIRCardComponentExtendedBO",
                "DLoadCIRElementClassificationRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentElementClassificationVO",
                "DLoadHidden":"true",
                "dependencies":[
                    "CIREffectiveDate",
                    "Context1",
                    "Context2",
                    "Context3",
                    "Context4",
                    "Context5",
                    "Context6",
                    "DirCardCompDefId"
                ]
            },
            "x-queryable":true
        },
        "ComponentSequence":{
            "type":"integer",
            "description":"Sequence value of the calculation card component for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "Context1":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 1 for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "Context2":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 2 for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "Context3":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 3 for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "Context4":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 4 for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "Context5":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 5 for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "Context6":{
            "maxLength":150,
            "type":"string",
            "description":"Reference Value 6 for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "DeductionGroupId":{
            "type":"integer",
            "description":"Deduction group ID of the calculation card component for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentDeductionGroupVO",
                "precision":18,
                "DLoadHidden":"true",
                "dependencies":[
                    "DirCardDefinitionBaseName",
                    "DirCardDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "DeductionGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Deduction group name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "DirCardCompDefId":{
            "type":"integer",
            "description":"Definition ID of the calculation card component for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DLoadCIRRestVoName":"oracle.apps.hcm.payrolls.cir.service.common.helper.view.CIRComponentDefVO",
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.DIRCardCompDefVO\",\"DirCardCompDefName:ComponentName;LegislativeDataGroupId;DirCardDefinitionId\",\"DirCardCompDefId\");",
                "dependencies":[
                    "BaseComponentNameFilter",
                    "DeductionGroupId",
                    "IgnoreTUContextComps",
                    "Role"
                ]
            },
            "x-queryable":true
        },
        "DirCardCompDefName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "DirCardCompDrId":{
            "type":"integer",
            "description":"Unique identifier for the calculation card component date range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.ComponentDirCardCompDrIdHelper\");",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DirCardCompId":{
            "type":"integer",
            "description":"ID of the calculation card component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.ComponentDirCardCompIdHelper\");"
            },
            "x-queryable":true
        },
        "DirCardDefinitionBaseName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition base name of the calculation card for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "DirCardDefinitionId":{
            "type":"integer",
            "description":"Definition ID of the calculation card for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.DIRCardDefinitionVO\",\"DirCardDefinitionName:DisplayName;LegislativeDataGroupId:LegislativeDataGroupId\",\"DirCardDefinitionId:DirCardDefinitionId\");"
            },
            "x-queryable":true
        },
        "DirCardDefinitionName":{
            "maxLength":80,
            "type":"string",
            "description":"Definition name of the calculation card for component date ranges.",
            "nullable":true,
            "x-queryable":true
        },
        "DirCardId":{
            "type":"integer",
            "description":"Unique identifier of the calculation card for component date ranges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DynamicAttributeNames":{
            "type":"string",
            "description":"Attribute names of the calculation card component for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true",
                "HcmComparable":"True"
            }
        },
        "DynamicData":{
            "type":"string",
            "description":"DynamicData is the write oriented attribute. Consumers pass a JSON string where each key identifies the calculation card components override attribute to create or change the value",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "DynamicDataDetails":{
            "type":"string",
            "description":"DynamicDataDetails is the read-oriented metadata or value representation. It tells the consumer which dynamic override attributes are available for the calculation card component",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of calculation card component override.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the calculation card component override.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"Element type ID of the calculation card component for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "GUID":{
            "type":"string",
            "description":"GUID for component date ranges.",
            "nullable":true,
            "x-queryable":false
        },
        "GroupBaseComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Group base component name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "GroupComponentName":{
            "maxLength":80,
            "type":"string",
            "description":"Group component name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "GroupDirCardCompDefId":{
            "type":"integer",
            "description":"Group component definition ID of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "IgnoreCompsWithoutOvdOrFlexes":{
            "type":"string",
            "description":"Ignore calculation card components without overrides.",
            "nullable":true,
            "default":"N",
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "IgnoreTUContextComps":{
            "type":"string",
            "description":"Indicates whether calculation card components with tax unit context are ignored for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Legislative data group ID of the employee payroll relationship for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.view.LegislativeDataGroupVO\",\"LegislativeDataGroupName:Name\",\"LegislativeDataGroupId:LegislativeDataGroupId\");"
            },
            "x-queryable":true
        },
        "LegislativeDataGroupName":{
            "maxLength":240,
            "type":"string",
            "description":"Legislative data group name of the employee payroll relationship for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PER_CHOOSE_LEGISLATIVE_DATA_GROUP_DATA__PER_LEGISLATIVE_DATA_GROUPS__LegislativeDataGroupPEO",
                "DLoadLOVReturnAttributes":"Name",
                "DLoadLOVDisplayAttributes":"[Name]",
                "DLoadLOVViewDefName":"oracle.apps.hcm.legislativeDataGroups.publicView.LegislativeDataGroupPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PER_CHOOSE_LEGISLATIVE_DATA_GROUP_DATA__PER_LEGISLATIVE_DATA_GROUPS__LegislativeDataGroupPEO"
            },
            "x-queryable":true
        },
        "LevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Level code for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "OverrideFlexAttributeDetails":{
            "type":"string",
            "description":"Overrides attribute details of the calculation card component.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "ParentDirCardCompDefId":{
            "type":"integer",
            "description":"Component definition ID of the calculation card components parent component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "ParentDirCardCompId":{
            "type":"integer",
            "description":"Component ID of calculation card components parent component.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "PayrollRelationshipId":{
            "type":"integer",
            "description":"Payroll Relationship ID of the employee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "PayrollRelationshipNumber":{
            "type":"string",
            "description":"Payroll relationship number of the employee for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_PAY_RELATIONSHIPS_DN__PayrollRelationshipPEO",
                "DLoadLOVReturnAttributes":"PayrollRelationshipNumber",
                "DLoadLOVDisplayAttributes":"[PayrollRelationshipNumber]",
                "DLoadCIRAttributeTableAndColumn":"PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_NUMBER",
                "DLoadCIRAttributeWhereClause":"PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_CIR_CARD_COMPONENTS_DR_VL.SOURCE_ID",
                "HcmComparable":"True",
                "DLoadLOVViewDefName":"oracle.apps.hcm.payrolls.registrations.publicView.PayrollRelationshipPVO",
                "DLoadCIRDependentAttributeWhereClause":"AssignmentNumber:PAY_REL_GROUPS_DN.PAYROLL_RELATIONSHIP_ID = PAY_PAY_RELATIONSHIPS_DN.PAYROLL_RELATIONSHIP_ID",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_VIEW_PAYROLL_RELATIONSHIP_DATA__PAY_PAY_RELATIONSHIPS_DN__PayrollRelationshipPEO"
            }
        },
        "PayrollStatUnitId":{
            "type":"integer",
            "description":"Payroll statutory unit ID for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "PayrollStatutoryUnitName":{
            "type":"string",
            "description":"Name of the payroll statutory unit for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_CHOOSE_PAYROLL_STATUTORY_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT",
                "DLoadLOVReturnAttributes":"Name",
                "DLoadLOVDisplayAttributes":"[Name]",
                "DLoadCIRAttributeTableAndColumn":"XLE_ENTITY_PROFILES.NAME",
                "DLoadCIRAttributeWhereClause":"XLE_ENTITY_PROFILES.LEGAL_ENTITY_ID=HR_ALL_ORGANIZATION_UNITS_F_VL.LEGAL_ENTITY_ID AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=HR_ORG_UNIT_CLASSIFICATIONS_F.ORGANIZATION_ID AND HR_ORG_UNIT_CLASSIFICATIONS_F.CLASSIFICATION_CODE='HCM_PSU' AND HR_ORG_UNIT_CLASSIFICATIONS_F.STATUS='A' AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=PAY_CIR_CARDS_VL.SOURCE_ID AND PAY_CIR_CARDS_VL.SOURCE_TYPE='PSU'",
                "DLoadCIRAttributeTables":"HR_ALL_ORGANIZATION_UNITS_F_VL;HR_ORG_UNIT_CLASSIFICATIONS_F",
                "DLoadLOVViewDefName":"oracle.apps.hcm.common.pay.publicView.parameters.PayrollStatutoryUnitPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_CHOOSE_PAYROLL_STATUTORY_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT"
            }
        },
        "RangeEndDate":{
            "type":"string",
            "description":"Range end date for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "RangeMode":{
            "type":"string",
            "description":"RangeMode controls certain date effective behavior for the update or delete of component date ranges.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "RangeStartDate":{
            "type":"string",
            "description":"Range start date for component date ranges.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "Role":{
            "type":"string",
            "description":"Role of the user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "SecBaseClassificationName":{
            "maxLength":160,
            "type":"string",
            "description":"Secondary base classification name of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "SecondaryClassificationId":{
            "type":"number",
            "description":"Secondary classification ID of the calculation card component for component date ranges.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "SourceId":{
            "type":"integer",
            "description":"Payroll relationship ID of the employee for component date ranges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "DLoadHidden":"true",
                "KeyHelper":"keyContextHelper.resolve(\"oracle.apps.hcm.payrolls.cir.service.common.helper.CardSourceIdHelper\");"
            },
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"string",
            "description":"Source system identifier for component date ranges.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemOwner":{
            "type":"string",
            "description":"Source system owner for component date ranges.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of source associated with the calculation card component date range.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "Subpriority":{
            "type":"integer",
            "description":"Subpriority of the calculation card component date range.",
            "nullable":true,
            "x-hints":{
                "DLoadHidden":"true"
            },
            "x-queryable":true
        },
        "SystemPersonType":{
            "type":"string",
            "description":"System person type for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadHidden":"true"
            }
        },
        "TaxReportingUnitName":{
            "type":"string",
            "description":"Tax reporting unit name assigned to the calculation card for component date ranges.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DLoadLOVListSecurityViewCriteria":"FNDDS__PAY_CHOOSE_TAX_REPORTING_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT",
                "DLoadLOVReturnAttributes":"TruName",
                "DLoadLOVDisplayAttributes":"[TruName]",
                "DLoadCIRAttributeTableAndColumn":"XLE_ETB_PROFILES.NAME",
                "DLoadCIRAttributeWhereClause":"XLE_ETB_PROFILES.ESTABLISHMENT_ID = HR_ALL_ORGANIZATION_UNITS_F_VL.ESTABLISHMENT_ID AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID = HR_ORG_UNIT_CLASSIFICATIONS_F.ORGANIZATION_ID AND HR_ORG_UNIT_CLASSIFICATIONS_F.CLASSIFICATION_CODE = 'HCM_TRU' AND HR_ORG_UNIT_CLASSIFICATIONS_F.STATUS = 'A' AND HR_ALL_ORGANIZATION_UNITS_F_VL.ORGANIZATION_ID=PAY_CIR_CARDS_VL.SOURCE_ID AND PAY_CIR_CARDS_VL.SOURCE_TYPE='TRU'",
                "DLoadCIRAttributeTables":"HR_ALL_ORGANIZATION_UNITS_F_VL;HR_ORG_UNIT_CLASSIFICATIONS_F",
                "DLoadLOVViewDefName":"oracle.apps.hcm.common.pay.publicView.parameters.TaxReportingUnitPVO",
                "PayRefObjectSecurityViewCriteria":"FNDDS__PAY_CHOOSE_TAX_REPORTING_UNIT_DATA__HR_ALL_ORGANIZATION_UNITS_F__QRSLT"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

CIRComponentAssociation

Operation: /hcmRestApi/resources/11.13.18.05/calculationEntries/{DirCardId}/child/CIRComponent/{CIRComponentUniqID}/child/CIRComponentAssociation

Parameters:

CIRComponentUniqID: $request.path.CIRComponentUniqID
DirCardId: $request.path.DirCardId

The CIRComponentAssociation resource returns list of associations associated with a calculation card.

CIRComponentAttachments

Operation: /hcmRestApi/resources/11.13.18.05/calculationEntries/{DirCardId}/child/CIRComponent/{CIRComponentUniqID}/child/CIRComponentAttachments

Parameters:

CIRComponentUniqID: $request.path.CIRComponentUniqID
DirCardId: $request.path.DirCardId

The CIRComponentAttachmentsVO resource returns attachments associated with a calculation card.

CIRComponentDateRanges

Operation: /hcmRestApi/resources/11.13.18.05/calculationEntries/{DirCardId}/child/CIRComponent/{CIRComponentUniqID}/child/CIRComponentDateRanges

Parameters:

CIRComponentUniqID: $request.path.CIRComponentUniqID
DirCardId: $request.path.DirCardId

The resource CIRComponentDateRanges returns overrides associated with a calculation card component with different date ranges.

updateComponentActiveInActiveFlag

Operation: /hcmRestApi/resources/11.13.18.05/calculationEntries/{DirCardId}/child/CIRComponent/{CIRComponentUniqID}/action/updateComponentActiveInActiveFlag

Parameters:

CIRComponentUniqID: $request.path.CIRComponentUniqID
DirCardId: $request.path.DirCardId

Update components of the calculation card based on the active flag.