Jump to

• Request
• Response

Unique identifier for the payroll

patch

/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/RetroResults/{RetroResultsUniqID}/child/RetroEntriesSummary/{RetroEntriesSummaryUniqID}

Request

Path Parameters

• ObjectActionId(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=
• RetroEntriesSummaryUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ElementEntryId and CreatorType ---for the Retro Total resource and used to uniquely identify an instance of Retro Total. The client should not generate the hash key value. Instead, the client should query on the Retro Total collection resource with a filter on the primary key values in order to navigate to a specific instance of Retro Total.
  
  For example: RetroEntriesSummary?q=ElementEntryId=<value1>;CreatorType=<value2>
• RetroResultsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ElementTypeId, CreatorId and PayrollIdentifier ---for the Retro Total resource and used to uniquely identify an instance of Retro Total. The client should not generate the hash key value. Instead, the client should query on the Retro Total collection resource with a filter on the primary key values in order to navigate to a specific instance of Retro Total.
  
  For example: RetroResults?q=ElementTypeId=<value1>;CreatorId=<value2>;PayrollIdentifier=<value3>

Header Parameters

• 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• calcPayrollEntryDetails: array Retro Total
  Title: Retro Total

  Unique identifier for the payroll
• retroEntryDetails: array Retro Total
  Title: Retro Total

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "calcPayrollEntryDetails":{
            "title":"Retro Total",
            "type":"array",
            "description":"Unique identifier for the payroll",
            "items":{
                "$ref":"#/components/schemas/personProcessResults-RetroResults-RetroEntriesSummary-calcPayrollEntryDetails-item-patch-request"
            }
        },
        "retroEntryDetails":{
            "title":"Retro Total",
            "type":"array",
            "description":"Unique identifier for the payroll",
            "items":{
                "$ref":"#/components/schemas/personProcessResults-RetroResults-RetroEntriesSummary-retroEntryDetails-item-patch-request"
            }
        }
    }
}

Nested Schema : Retro Total

Type: array

Title: Retro Total

Unique identifier for the payroll

Show Source

• Array of: object personProcessResults-RetroResults-RetroEntriesSummary-calcPayrollEntryDetails-item-patch-request

{
    "title":"Retro Total",
    "type":"array",
    "description":"Unique identifier for the payroll",
    "items":{
        "$ref":"#/components/schemas/personProcessResults-RetroResults-RetroEntriesSummary-calcPayrollEntryDetails-item-patch-request"
    }
}

Nested Schema : Retro Total

Type: array

Title: Retro Total

Unique identifier for the payroll

Show Source

• Array of: object personProcessResults-RetroResults-RetroEntriesSummary-retroEntryDetails-item-patch-request

{
    "title":"Retro Total",
    "type":"array",
    "description":"Unique identifier for the payroll",
    "items":{
        "$ref":"#/components/schemas/personProcessResults-RetroResults-RetroEntriesSummary-retroEntryDetails-item-patch-request"
    }
}

Nested Schema : personProcessResults-RetroResults-RetroEntriesSummary-calcPayrollEntryDetails-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : personProcessResults-RetroResults-RetroEntriesSummary-retroEntryDetails-item-patch-request

Type: object

Show Source

• CalcPayrollValueDetails: string
  Maximum Length: 4000

  Unique identifier for the payroll
• DisplaySequence: integer (int32)
  Unique identifier for the payroll
• InputValueName: string
  Maximum Length: 80

  Unique identifier for the payroll
• LegislativeDataGroupId: integer (int64)
  Unique identifier for the payroll
• LovDisplayValueDetails: string
  Maximum Length: 60

  Unique identifier for the payroll
• VoName: string
  Maximum Length: 200

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "CalcPayrollValueDetails":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "InputValueName":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LovDisplayValueDetails":{
            "maxLength":60,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "x-hints":{
                "PAY_LOV_VO_NAME_ATTRIBUTE_NAME":"VoName",
                "controlType":"choice",
                "PAY_LOV_VO_LDG_LEG_CODE_VAR_VALUE":"adf.object.getLdgLegCode(adf.object.getLegislativeDataGroupId())",
                "PAY_LOV_LT_LEGISLATION_CODE_VAR_VALUE":"adf.object.getLdgLegCode(adf.object.getLegislativeDataGroupId())",
                "PAY_LOV_DISPLAY_SEQUENCE_ATTRIBUTE_NAME":"DisplaySequence",
                "PAY_LOV_VO_LEGISLATIVE_DATA_GROUP_ID_VAR_VALUE":"adf.object.getLegislativeDataGroupId()"
            }
        },
        "VoName":{
            "maxLength":200,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : personProcessResults-RetroResults-RetroEntriesSummary-item-response

Type: object

Show Source

• calcPayrollEntryDetails: array Retro Total
  Title: Retro Total

  Unique identifier for the payroll
• ClassificationName: string
  Read Only: true

  Maximum Length: 120

  Unique identifier for the payroll
• CreatorId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• CreatorType: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• CreatorTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Unique identifier for the payroll
• EffectiveEndDate: string (date)
  Read Only: true

  Unique identifier for the payroll
• EffectiveStartDate: string (date)
  Read Only: true

  Unique identifier for the payroll
• ElementEntryId: integer
  Read Only: true

  Unique identifier for the payroll
• ElementName: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• ElementTypeId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• EndDate: string (date)
  Read Only: true

  Unique identifier for the payroll
• FlowName: string
  Read Only: true

  Maximum Length: 200

  Unique identifier for the payroll
• IpName: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MultipleEntryCount: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• PayrollIdentifier: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• PeriodName: string
  Read Only: true

  Maximum Length: 70

  Unique identifier for the payroll
• ProcessDate: string (date)
  Read Only: true

  Unique identifier for the payroll
• ProcessedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Unique identifier for the payroll
• ProcessingType: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• Reason: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• retroEntryDetails: array Retro Total
  Title: Retro Total

  Unique identifier for the payroll
• RunResultId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• SourceEntryId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• SourceRelActionId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• SourceRunResultId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• StartDate: string (date)
  Read Only: true

  Unique identifier for the payroll
• Total: string
  Read Only: true

  Maximum Length: 60

  Unique identifier for the payroll
• UseAtAsgLevel: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• UseAtRelLevel: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "ClassificationName":{
            "maxLength":120,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatorId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatorType":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatorTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementEntryId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementName":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowName":{
            "maxLength":200,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IpName":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MultipleEntryCount":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayrollIdentifier":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodName":{
            "maxLength":70,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessDate":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingType":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Reason":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RunResultId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceEntryId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceRelActionId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceRunResultId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Total":{
            "maxLength":60,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UseAtAsgLevel":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UseAtRelLevel":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "calcPayrollEntryDetails":{
            "title":"Retro Total",
            "type":"array",
            "description":"Unique identifier for the payroll",
            "items":{
                "$ref":"#/components/schemas/personProcessResults-RetroResults-RetroEntriesSummary-calcPayrollEntryDetails-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "retroEntryDetails":{
            "title":"Retro Total",
            "type":"array",
            "description":"Unique identifier for the payroll",
            "items":{
                "$ref":"#/components/schemas/personProcessResults-RetroResults-RetroEntriesSummary-retroEntryDetails-item-response"
            }
        }
    }
}

Nested Schema : Retro Total

Type: array

Title: Retro Total

Unique identifier for the payroll

Show Source

• Array of: object personProcessResults-RetroResults-RetroEntriesSummary-calcPayrollEntryDetails-item-response

{
    "title":"Retro Total",
    "type":"array",
    "description":"Unique identifier for the payroll",
    "items":{
        "$ref":"#/components/schemas/personProcessResults-RetroResults-RetroEntriesSummary-calcPayrollEntryDetails-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 : Retro Total

Type: array

Title: Retro Total

Unique identifier for the payroll

Show Source

• Array of: object personProcessResults-RetroResults-RetroEntriesSummary-retroEntryDetails-item-response

{
    "title":"Retro Total",
    "type":"array",
    "description":"Unique identifier for the payroll",
    "items":{
        "$ref":"#/components/schemas/personProcessResults-RetroResults-RetroEntriesSummary-retroEntryDetails-item-response"
    }
}

Nested Schema : personProcessResults-RetroResults-RetroEntriesSummary-calcPayrollEntryDetails-item-response

Type: object

Show Source

• CalcPayrollCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Unique identifier for the payroll
• CalcPayrollElementName: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• CalcPayrollFlowName: string
  Read Only: true

  Maximum Length: 200

  Unique identifier for the payroll
• CalcPayrollRunResultNum: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• CalcPayrollValueDetails: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier for the payroll
• CalcRunRelActId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• DirCardCompId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• DisplaySequence: integer (int32)
  Read Only: true

  Unique identifier for the payroll
• Effectivedate1: string (date)
  Read Only: true

  Unique identifier for the payroll
• ElementEntryId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• ElementTypeId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• InputValueId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• InputValueName: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• LegislativeDataGroupId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LovDisplayValueDetails: string
  Read Only: true

  Maximum Length: 60

  Unique identifier for the payroll
• PAY_LOV_LovDisplayValueDetails_LOV_SWITCHER: string
  Read Only: true
• PayrollRelActionId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• ReservedInputValue: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• ResultValue: string
  Read Only: true

  Maximum Length: 60

  Unique identifier for the payroll
• RunResultId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• SourceId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• SourceRunResultId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• ValueSetCode: string
  Read Only: true

  Maximum Length: 200

  Unique identifier for the payroll
• ValueType: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• VoName: string
  Read Only: true

  Maximum Length: 200

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "CalcPayrollCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalcPayrollElementName":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalcPayrollFlowName":{
            "maxLength":200,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalcPayrollRunResultNum":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":126
            },
            "x-queryable":true
        },
        "CalcPayrollValueDetails":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalcRunRelActId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirCardCompId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "Effectivedate1":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementEntryId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputValueId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputValueName":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LovDisplayValueDetails":{
            "maxLength":60,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAY_LOV_VO_NAME_ATTRIBUTE_NAME":"VoName",
                "controlType":"choice",
                "PAY_LOV_VO_LDG_LEG_CODE_VAR_VALUE":"adf.object.getLdgLegCode(adf.object.getLegislativeDataGroupId())",
                "PAY_LOV_LT_LEGISLATION_CODE_VAR_VALUE":"adf.object.getLdgLegCode(adf.object.getLegislativeDataGroupId())",
                "PAY_LOV_DISPLAY_SEQUENCE_ATTRIBUTE_NAME":"DisplaySequence",
                "PAY_LOV_VO_LEGISLATIVE_DATA_GROUP_ID_VAR_VALUE":"adf.object.getLegislativeDataGroupId()"
            },
            "x-queryable":true
        },
        "PAY_LOV_LovDisplayValueDetails_LOV_SWITCHER":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollRelActionId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReservedInputValue":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue":{
            "maxLength":60,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RunResultId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceRunResultId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ValueSetCode":{
            "maxLength":200,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueType":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VoName":{
            "maxLength":200,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":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 : personProcessResults-RetroResults-RetroEntriesSummary-retroEntryDetails-item-response

Type: object

Show Source

• CalcPayrollCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Unique identifier for the payroll
• CalcPayrollElementName: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• CalcPayrollFlowName: string
  Read Only: true

  Maximum Length: 200

  Unique identifier for the payroll
• CalcPayrollRunResultNum: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• CalcPayrollValueDetails: string
  Maximum Length: 4000

  Unique identifier for the payroll
• CalcRunRelActId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• DirCardCompId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• DisplaySequence: integer (int32)
  Unique identifier for the payroll
• Effectivedate1: string (date)
  Read Only: true

  Unique identifier for the payroll
• ElementEntryId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• ElementTypeId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• InputValueId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• InputValueName: string
  Maximum Length: 80

  Unique identifier for the payroll
• LegislativeDataGroupId: integer (int64)
  Unique identifier for the payroll
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LovDisplayValueDetails: string
  Maximum Length: 60

  Unique identifier for the payroll
• PAY_LOV_LovDisplayValueDetails_LOV_SWITCHER: string
  Read Only: true
• PayrollRelActionId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• ReservedInputValue: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• ResultValue: string
  Read Only: true

  Maximum Length: 60

  Unique identifier for the payroll
• RunResultId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• SourceId: integer (int64)
  Read Only: true

  Unique identifier for the payroll
• ValueSetCode: string
  Read Only: true

  Maximum Length: 200

  Unique identifier for the payroll
• ValueType: string
  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• VoName: string
  Maximum Length: 200

  Unique identifier for the payroll

{
    "type":"object",
    "properties":{
        "CalcPayrollCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalcPayrollElementName":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalcPayrollFlowName":{
            "maxLength":200,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalcPayrollRunResultNum":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":126
            },
            "x-queryable":true
        },
        "CalcPayrollValueDetails":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "x-queryable":true
        },
        "CalcRunRelActId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirCardCompId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "Effectivedate1":{
            "type":"string",
            "description":"Unique identifier for the payroll",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementEntryId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputValueId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputValueName":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "x-queryable":true
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LovDisplayValueDetails":{
            "maxLength":60,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "x-hints":{
                "PAY_LOV_VO_NAME_ATTRIBUTE_NAME":"VoName",
                "controlType":"choice",
                "PAY_LOV_VO_LDG_LEG_CODE_VAR_VALUE":"adf.object.getLdgLegCode(adf.object.getLegislativeDataGroupId())",
                "PAY_LOV_LT_LEGISLATION_CODE_VAR_VALUE":"adf.object.getLdgLegCode(adf.object.getLegislativeDataGroupId())",
                "PAY_LOV_DISPLAY_SEQUENCE_ATTRIBUTE_NAME":"DisplaySequence",
                "PAY_LOV_VO_LEGISLATIVE_DATA_GROUP_ID_VAR_VALUE":"adf.object.getLegislativeDataGroupId()"
            },
            "x-queryable":true
        },
        "PAY_LOV_LovDisplayValueDetails_LOV_SWITCHER":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrollRelActionId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReservedInputValue":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultValue":{
            "maxLength":60,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RunResultId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceId":{
            "type":"integer",
            "description":"Unique identifier for the payroll",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ValueSetCode":{
            "maxLength":200,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueType":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VoName":{
            "maxLength":200,
            "type":"string",
            "description":"Unique identifier for the payroll",
            "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"
    }
}

Links

calcPayrollEntryDetails

Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/RetroResults/{RetroResultsUniqID}/child/RetroEntriesSummary/{RetroEntriesSummaryUniqID}/child/calcPayrollEntryDetails

Parameters:

• ObjectActionId: $request.path.ObjectActionId
• RetroEntriesSummaryUniqID: $request.path.RetroEntriesSummaryUniqID
• RetroResultsUniqID: $request.path.RetroResultsUniqID

Unique identifier for the payroll

retroEntryDetails

Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/RetroResults/{RetroResultsUniqID}/child/RetroEntriesSummary/{RetroEntriesSummaryUniqID}/child/retroEntryDetails

Parameters:

• ObjectActionId: $request.path.ObjectActionId
• RetroEntriesSummaryUniqID: $request.path.RetroEntriesSummaryUniqID
• RetroResultsUniqID: $request.path.RetroResultsUniqID

Unique identifier for the payroll

Back to Top