Unique identifier for the payroll
get
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}
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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
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.
There's no request body for this operation.
Back to TopResponse
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 : personProcessResults-item-response
Type:
Show Source
object
-
ActionStatusCode: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
ActionStatusLookupType: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
ActionType: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
ActionTypeCode: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
AdditionalResults: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
AssignmentId: string
Read Only:
true
Maximum Length:163
Unique identifier for the payroll -
AssignmentNumber: string
Read Only:
true
Maximum Length:163
Unique identifier for the payroll -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BalanceGroupLOV: array
Person Process Results Balance Group
Title:
Person Process Results Balance Group
Unique identifier for the payroll -
BalanceTypeLOV: array
Person Process Results Balance Type
Title:
Person Process Results Balance Type
Unique identifier for the payroll -
BalanceView: array
Person Process Results Balance View
Title:
Person Process Results Balance View
Unique identifier for the payroll -
BaseFlowId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
CalculationBreakdown: array
Person Process Results Calculation Breakdown
Title:
Person Process Results Calculation Breakdown
Unique identifier for the payroll -
ConsolidationSetId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
ConsolidationSetName: string
Read Only:
true
Maximum Length:60
Unique identifier for the payroll -
costAdjustments: array
Payslips Summary
Title:
Payslips Summary
Unique identifier for the payroll -
costingResults: array
Payslips Summary
Title:
Payslips Summary
Unique identifier for the payroll -
DateEarned: string
(date)
Read Only:
true
Unique identifier for the payroll -
EarnEndDate: string
(date)
Read Only:
true
Unique identifier for the payroll -
EarnStartDate: string
(date)
Read Only:
true
Unique identifier for the payroll -
FlowInstanceId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
FlowName: string
Read Only:
true
Maximum Length:200
Unique identifier for the payroll -
LegislationCode: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
LegislativeDataGroupId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
LegislativeDataGroupName: string
Read Only:
true
Maximum Length:240
Unique identifier for the payroll -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
messages: array
Person Process Results Messages
Title:
Person Process Results Messages
Unique identifier for the payroll -
ObjectActionId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
ObjectId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
ObjectName: string
Read Only:
true
Maximum Length:1083
Unique identifier for the payroll -
ObjectReference: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
ObjectType: string
Read Only:
true
Maximum Length:255
Unique identifier for the payroll -
ObjectTypeCode: string
Read Only:
true
Maximum Length:40
Unique identifier for the payroll -
Payments: array
Person Process Results Prepayment
Title:
Person Process Results Prepayment
Unique identifier for the payroll -
PayRequestId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
Payroll: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
PayrollActionId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
PayrollAssignmentLOV: array
Person Process Results Assignment
Title:
Person Process Results Assignment
Unique identifier for the payroll -
PayrollId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
PayrollPeriodName: string
Read Only:
true
Maximum Length:70
Unique identifier for the payroll -
PayrollPeriodNumber: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
PersonId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
PersonNumber: string
Read Only:
true
Maximum Length:1083
Unique identifier for the payroll -
PersonProcessPCG: array
Person Process Results Process Configuration Group
Title:
Person Process Results Process Configuration Group
Unique identifier for the payroll -
Prepayments: array
Person Process Results Prepayment
Title:
Person Process Results Prepayment
Unique identifier for the payroll -
PrimaryClassificationLOV: array
Person Process Results Primary Classification
Title:
Person Process Results Primary Classification
Unique identifier for the payroll -
PrimaryResults: string
Read Only:
true
Maximum Length:12
Unique identifier for the payroll -
ProcessDate: string
(date)
Read Only:
true
Unique identifier for the payroll -
ProcessEndDate: string
(date)
Read Only:
true
Unique identifier for the payroll -
ProcessStartDate: string
(date)
Read Only:
true
Unique identifier for the payroll -
RelationshipNumber: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
RetroRunId: integer
Read Only:
true
Unique identifier for the payroll -
RunResult: array
Person Process Results Run Result
Title:
Person Process Results Run Result
Unique identifier for the payroll -
RunResultRateDetail: array
Person Process Results Rate Detail
Title:
Person Process Results Rate Detail
Unique identifier for the payroll -
RunTypeId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
RunTypeName: string
Read Only:
true
Unique identifier for the payroll -
SOEBalanceView: array
Person Process Results Statements of Earnings
Title:
Person Process Results Statements of Earnings
Unique identifier for the payroll -
SourceActionId: integer
Read Only:
true
Unique identifier for the payroll -
Status: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
SubmissionDate: string
(date)
Read Only:
true
Unique identifier for the payroll -
TaskId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
TaskInstanceId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
TaskName: string
Read Only:
true
Maximum Length:250
Unique identifier for the payroll -
TaxReportingUnitLOV: array
Person Process Results Tax Reporting Unit
Title:
Person Process Results Tax Reporting Unit
Unique identifier for the payroll -
VoidPayment: array
Person Process Results Prepayment
Title:
Person Process Results Prepayment
Unique identifier for the payroll -
VoidPaymentActionId: integer
(int64)
Read Only:
true
Unique identifier for the payroll
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Person Process Results Balance Group
Type:
array
Title:
Person Process Results Balance Group
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Balance Type
Type:
array
Title:
Person Process Results Balance Type
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Balance View
Type:
array
Title:
Person Process Results Balance View
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Calculation Breakdown
Type:
array
Title:
Person Process Results Calculation Breakdown
Unique identifier for the payroll
Show Source
Nested Schema : Payslips Summary
Type:
array
Title:
Payslips Summary
Unique identifier for the payroll
Show Source
Nested Schema : Payslips Summary
Type:
array
Title:
Payslips Summary
Unique identifier for the payroll
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Person Process Results Messages
Type:
array
Title:
Person Process Results Messages
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Prepayment
Type:
array
Title:
Person Process Results Prepayment
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Assignment
Type:
array
Title:
Person Process Results Assignment
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Process Configuration Group
Type:
array
Title:
Person Process Results Process Configuration Group
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Prepayment
Type:
array
Title:
Person Process Results Prepayment
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Primary Classification
Type:
array
Title:
Person Process Results Primary Classification
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Run Result
Type:
array
Title:
Person Process Results Run Result
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Rate Detail
Type:
array
Title:
Person Process Results Rate Detail
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Statements of Earnings
Type:
array
Title:
Person Process Results Statements of Earnings
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Tax Reporting Unit
Type:
array
Title:
Person Process Results Tax Reporting Unit
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Prepayment
Type:
array
Title:
Person Process Results Prepayment
Unique identifier for the payroll
Show Source
Nested Schema : personProcessResults-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : personProcessResults-BalanceGroupLOV-item-response
Type:
Show Source
object
-
BalanceReportType: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
BalGrpUsageId: integer
Read Only:
true
Unique identifier for the payroll -
BaseGroupUsageName: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
FormatType: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
GroupUsageName: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollRelActionId: integer
Read Only:
true
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-BalanceTypeLOV-item-response
Type:
Show Source
object
-
BalanceName: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
BalanceTypeId: integer
Read Only:
true
Unique identifier for the payroll -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollRelActionId: integer
Read Only:
true
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-BalanceView-item-response
Type:
Show Source
object
-
BalanceContext: array
Person Process Results Balance Context
Title:
Person Process Results Balance Context
Unique identifier for the payroll -
BalanceFeed: array
Person Process Results Balance Feed
Title:
Person Process Results Balance Feed
Unique identifier for the payroll -
BalanceName: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
BalanceTypeId: integer
Read Only:
true
Unique identifier for the payroll -
BalGroupUsageId1: integer
Read Only:
true
Unique identifier for the payroll -
BalGroupUsageId2: integer
Read Only:
true
Unique identifier for the payroll -
BalTypeId: integer
Read Only:
true
Unique identifier for the payroll -
CtxString: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
CtxUserString: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
DefbalForBreakdown: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId1: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId10: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId2: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId3: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId4: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId5: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId6: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId7: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId8: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId9: integer
Read Only:
true
Unique identifier for the payroll -
DimensionName: string
Read Only:
true
Maximum Length:160
Unique identifier for the payroll -
EmploymentBalance: array
Person Process Results Employment Balance
Title:
Person Process Results Employment Balance
Unique identifier for the payroll -
FeedCheckingType: string
Read Only:
true
Maximum Length:1
Unique identifier for the payroll -
LegislationCode: string
Read Only:
true
Maximum Length:30
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. -
PayrollRelActionId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
RowIndex: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
TotalValue1: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
TotalValue2: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
Uom: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
UomCode: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
Value1: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value10: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value2: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value3: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value4: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value5: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value6: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value7: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value8: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value9: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll
Nested Schema : Person Process Results Balance Context
Type:
array
Title:
Person Process Results Balance Context
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Balance Feed
Type:
array
Title:
Person Process Results Balance Feed
Unique identifier for the payroll
Show Source
Nested Schema : Person Process Results Employment Balance
Type:
array
Title:
Person Process Results Employment Balance
Unique identifier for the payroll
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-BalanceView-BalanceContext-item-response
Type:
Show Source
object
-
ContextBaseName: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
ContextDescription: string
Read Only:
true
Maximum Length:240
Unique identifier for the payroll -
ContextMeaning: string
Read Only:
true
Maximum Length:250
Unique identifier for the payroll -
ContextName: string
Read Only:
true
Maximum Length:255
Unique identifier for the payroll -
ContextValue: string
Read Only:
true
Maximum Length:60
Unique identifier for the payroll -
CtxString: string
Read Only:
true
Unique identifier for the payroll -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-BalanceView-BalanceFeed-item-response
Type:
Show Source
object
-
BalanceName: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
ClassificationName: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
CtxString: string
Read Only:
true
Maximum Length:400
Unique identifier for the payroll -
DefinedBalanceId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
ElementName: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
InputValue: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
InputValueId: integer
Read Only:
true
Unique identifier for the payroll -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollRelActionId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
ResultValue: string
Read Only:
true
Maximum Length:60
Unique identifier for the payroll -
RunResultId: integer
Read Only:
true
Unique identifier for the payroll -
Scale: integer
(int32)
Read Only:
true
Unique identifier for the payroll -
Uom: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-BalanceView-EmploymentBalance-item-response
Type:
Show Source
object
-
CxtString: string
Read Only:
true
Maximum Length:300
Unique identifier for the payroll -
DefBalId: integer
Read Only:
true
Unique identifier for the payroll -
EmploymentId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
EmploymentLevel: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
EmploymentNumber: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollRelActionId: integer
Read Only:
true
Unique identifier for the payroll -
PTDValue: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
QTDValue: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
RUNValue: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
YTDValue: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-CalculationBreakdown-item-response
Type:
Show Source
object
-
CalcBreakdownId: integer
Read Only:
true
Unique identifier for the payroll -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:122
Unique identifier for the payroll -
PayrollRelActionId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
Value: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-costAdjustments-item-response
Type:
Show Source
object
-
AdjustmentDescription: string
Title:
Description
Maximum Length:4000
Unique identifier for the payroll -
AdjustmentName: string
Maximum Length:
50
Unique identifier for the payroll -
CostAdjustmentActionId: integer
Unique identifier for the payroll
-
CostAdjustmentId: integer
(int64)
Unique identifier for the payroll
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Unique identifier for the payroll -
CreationDate: string
(date-time)
Read Only:
true
Unique identifier for the payroll -
EffectiveDate: string
(date)
Unique identifier for the payroll
-
LastUpdateDate: string
(date-time)
Read Only:
true
Unique identifier for the payroll -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
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. -
PayrollRelActionId: integer
(int64)
Unique identifier for the payroll
-
PayrollRelationshipId: integer
(int64)
Unique identifier for the payroll
-
Status: string
Maximum Length:
10
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-costingResults-item-response
Type:
Show Source
object
-
Account: string
Title:
Concatenated Segments
Unique identifier for the payroll -
AccountType: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
AccountTypeCode: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
ActionType: string
Title:
Action Type
Read Only:true
Maximum Length:80
Unique identifier for the payroll -
AdjustedFlag: boolean
Read Only:
true
Maximum Length:1
Unique identifier for the payroll -
AdjustmentStatusCode: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
Assignment: string
Title:
Assignment
Read Only:true
Maximum Length:15
Unique identifier for the payroll -
CalcBreakdownId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
ClassificationName: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
CostAllocationKeyflexId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
CostId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
DistributedElementName: string
Title:
Distributed Element
Read Only:true
Maximum Length:80
Unique identifier for the payroll -
DistributedInputValue: string
Title:
Distributed Input Value
Read Only:true
Maximum Length:80
Unique identifier for the payroll -
DistributedRunResultId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
ElementName: string
Title:
Element Name
Read Only:true
Maximum Length:80
Unique identifier for the payroll -
EndDate: string
(date)
Title:
End Date
Read Only:true
Unique identifier for the payroll -
EntryType: string
Title:
Entry Type
Read Only:true
Maximum Length:80
Unique identifier for the payroll -
HoursAccountedCredit: number
Title:
Credit
Read Only:true
Unique identifier for the payroll -
HoursAccountedDebit: number
Title:
Debit
Read Only:true
Unique identifier for the payroll -
IdFlexNumber: integer
Read Only:
true
Unique identifier for the payroll -
ImportedToProjectFlag: boolean
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
InputValue: string
Title:
Input Value
Read Only:true
Maximum Length:80
Unique identifier for the payroll -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
Title:
Message
Read Only:true
Maximum Length:12
Unique identifier for the payroll -
MoneyAccountedCredit: number
Title:
Credit
Read Only:true
Unique identifier for the payroll -
MoneyAccountedDebit: number
Title:
Debit
Read Only:true
Unique identifier for the payroll -
OutputCurrencyCode: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
PayrollActionId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
PayrollAssignmentId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
PayrollRelActionId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
PayrollRelationshipId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
PayrollRelationshipNumber: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
PersonId: integer
(int64)
Read Only:
true
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 -
StartDate: string
(date)
Title:
Start Date
Read Only:true
Unique identifier for the payroll -
SubledgerEventDetails: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
TransferToProjectsStatus: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
UnitOfMeasure: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
UnitOfMeasureCode: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
UseAtAssignmentLevelFlag: boolean
Read Only:
true
Maximum Length:30
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-messages-item-response
Type:
Show Source
object
-
LineSequence: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
LineText: string
Read Only:
true
Maximum Length:2000
Unique identifier for the payroll -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
MessageId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
MessageLevel: string
Read Only:
true
Maximum Length:1
Unique identifier for the payroll -
MessageLevelName: string
Title:
Meaning
Read Only:true
Maximum Length:80
Unique identifier for the payroll -
MessageUserDetail: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
ObjectId: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
ObjectType: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
ParentMessageId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
PayrollId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
SourceId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
SourceType: string
Read Only:
true
Maximum Length:1
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-Payments-item-response
Type:
Show Source
object
-
AccountNumber: string
Title:
Bank Account Number
Maximum Length:80
Unique identifier for the payroll -
AccountNumberVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
Amount: number
Title:
Amount
Unique identifier for the payroll -
BankAccountId: integer
(int64)
Unique identifier for the payroll
-
BankAccountNumberLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BankAccountType: string
Read Only:
true
Maximum Length:25
Unique identifier for the payroll -
BankAccountTypeLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BankName: string
Read Only:
true
Maximum Length:360
Unique identifier for the payroll -
BankNameLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BankNumber: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
BankNumberLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BasePaymentTypeName: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
BicCode: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
BicCodeLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BranchName: string
Read Only:
true
Maximum Length:360
Unique identifier for the payroll -
BranchNameLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BranchNumber: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
BranchNumberLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BranchPartyId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
CalcBreakdownId: integer
(int64)
Unique identifier for the payroll
-
CalcBreakdownRef: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
CalculationBreakdownValue: string
Read Only:
true
Unique identifier for the payroll -
CancelRelActionId: integer
Read Only:
true
Unique identifier for the payroll -
CheckDigits: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
CurrencyCode: string
Maximum Length:
15
Unique identifier for the payroll -
EmpRelActionId: integer
Read Only:
true
Unique identifier for the payroll -
ExpPmtDtVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
ExtBankAccountId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
FlowInstanceName: string
Maximum Length:
80
Unique identifier for the payroll -
Iban: string
Read Only:
true
Maximum Length:50
Unique identifier for the payroll -
IbanLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
IsBankTransfer: string
Read Only:
true
Maximum Length:1
Unique identifier for the payroll -
LegislationCode: string
Read Only:
true
Maximum Length:30
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. -
MakeExternalPaymentFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
Opm: string
Maximum Length:
80
Unique identifier for the payroll -
Payee: string
Maximum Length:
2000
Unique identifier for the payroll -
PayeeId: integer
(int64)
Unique identifier for the payroll
-
PayeeType: string
Maximum Length:
12
Unique identifier for the payroll -
PayeeVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
PayLockingAction: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
PayLockingFlag: boolean
Read Only:
true
Unique identifier for the payroll -
PaymentDate: string
(date)
Title:
Payment Date
Unique identifier for the payroll -
PaymentProcSubmitDate: string
(date)
Unique identifier for the payroll
-
PaymentReference: string
Title:
Payment Reference
Maximum Length:30
Unique identifier for the payroll -
PaymentRefVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
PaymentRelActionId: integer
(int64)
Unique identifier for the payroll
-
PaymentTypeId: integer
(int64)
Unique identifier for the payroll
-
PaymentTypeName: string
Maximum Length:
80
Unique identifier for the payroll -
PayrollActionId: integer
(int64)
Unique identifier for the payroll
-
PayrollId: integer
(int64)
Unique identifier for the payroll
-
PayrollName: string
Maximum Length:
80
Unique identifier for the payroll -
PayrollRelActionId: integer
(int64)
Unique identifier for the payroll
-
PayrollRelationshipNumber: string
Maximum Length:
30
Unique identifier for the payroll -
PersonId: integer
(int64)
Unique identifier for the payroll
-
PersonNumber: string
Maximum Length:
30
Unique identifier for the payroll -
PpmName: string
Title:
Personal Payment Method
Maximum Length:80
Unique identifier for the payroll -
PpmNameVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
PrepayCumRelActionId: integer
(int64)
Unique identifier for the payroll
-
PrePaymentId: integer
(int64)
Unique identifier for the payroll
-
PrepayPaymentDate: string
(date)
Unique identifier for the payroll
-
PrepayProcessDate: string
(date)
Unique identifier for the payroll
-
PrepayProcSubmitDate: string
(date)
Unique identifier for the payroll
-
PrepayRelActionId: integer
(int64)
Unique identifier for the payroll
-
PreventPaymentFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
Priority: integer
(int64)
Unique identifier for the payroll
-
ProcessDate: string
(date)
Unique identifier for the payroll
-
ProcessEndDate: string
(date)
Unique identifier for the payroll
-
ProcessName: string
Maximum Length:
80
Unique identifier for the payroll -
ProcessNameCode: string
Maximum Length:
80
Unique identifier for the payroll -
ProcessStartDate: string
(date)
Unique identifier for the payroll
-
Reason: string
Maximum Length:
80
Unique identifier for the payroll -
ReasonVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
RelationshipId: integer
(int64)
Unique identifier for the payroll
-
RollbackFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
RollUpPaymentActionId: number
Read Only:
true
Unique identifier for the payroll -
SecondaryAccountReference: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
ShowVoidedPayment: string
Read Only:
true
Maximum Length:1
Unique identifier for the payroll -
Source: string
Maximum Length:
80
Unique identifier for the payroll -
Status: string
Title:
Payment Status
Maximum Length:4000
Unique identifier for the payroll -
StatusCode: string
Maximum Length:
1
Unique identifier for the payroll -
VoidPaymentActionId: integer
(int64)
Unique identifier for the payroll
-
VoidPaymentFlag: boolean
Maximum Length:
1
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-PayrollAssignmentLOV-item-response
Type:
Show Source
object
-
AssignmentNumber: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollAssignmentId: integer
Read Only:
true
Unique identifier for the payroll -
PayrollRelationshipId: integer
(int64)
Read Only:
true
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-PersonProcessPCG-item-response
Type:
Show Source
object
-
ActionParamGroupName: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TiPayRequestId: integer
Read Only:
true
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-Prepayments-item-response
Type:
Show Source
object
-
AccountNumber: string
Title:
Bank Account Number
Maximum Length:80
Unique identifier for the payroll -
AccountNumberVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
Amount: number
Title:
Amount
Unique identifier for the payroll -
BankAccountId: integer
(int64)
Unique identifier for the payroll
-
BankAccountNumberLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BankAccountType: string
Read Only:
true
Maximum Length:25
Unique identifier for the payroll -
BankAccountTypeLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BankName: string
Read Only:
true
Maximum Length:360
Unique identifier for the payroll -
BankNameLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BankNumber: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
BankNumberLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BasePaymentTypeName: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
BicCode: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
BicCodeLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BranchName: string
Read Only:
true
Maximum Length:360
Unique identifier for the payroll -
BranchNameLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BranchNumber: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
BranchNumberLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BranchPartyId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
CalcBreakdownId: integer
(int64)
Unique identifier for the payroll
-
CalcBreakdownRef: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
CalculationBreakdownValue: string
Read Only:
true
Unique identifier for the payroll -
CancelRelActionId: integer
Read Only:
true
Unique identifier for the payroll -
CheckDigits: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
CurrencyCode: string
Maximum Length:
15
Unique identifier for the payroll -
EmpRelActionId: integer
Read Only:
true
Unique identifier for the payroll -
ExpPmtDtVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
ExtBankAccountId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
FlowInstanceName: string
Maximum Length:
80
Unique identifier for the payroll -
Iban: string
Read Only:
true
Maximum Length:50
Unique identifier for the payroll -
IbanLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
IsBankTransfer: string
Read Only:
true
Maximum Length:1
Unique identifier for the payroll -
LegislationCode: string
Read Only:
true
Maximum Length:30
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. -
MakeExternalPaymentFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
Opm: string
Maximum Length:
80
Unique identifier for the payroll -
Payee: string
Maximum Length:
2000
Unique identifier for the payroll -
PayeeId: integer
(int64)
Unique identifier for the payroll
-
PayeeType: string
Maximum Length:
12
Unique identifier for the payroll -
PayeeVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
PayLockingAction: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
PayLockingFlag: boolean
Read Only:
true
Unique identifier for the payroll -
PaymentDate: string
(date)
Title:
Payment Date
Unique identifier for the payroll -
PaymentProcSubmitDate: string
(date)
Unique identifier for the payroll
-
PaymentReference: string
Title:
Payment Reference
Maximum Length:30
Unique identifier for the payroll -
PaymentRefVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
PaymentRelActionId: integer
(int64)
Unique identifier for the payroll
-
PaymentTypeId: integer
(int64)
Unique identifier for the payroll
-
PaymentTypeName: string
Maximum Length:
80
Unique identifier for the payroll -
PayrollActionId: integer
(int64)
Unique identifier for the payroll
-
PayrollId: integer
(int64)
Unique identifier for the payroll
-
PayrollName: string
Maximum Length:
80
Unique identifier for the payroll -
PayrollRelActionId: integer
(int64)
Unique identifier for the payroll
-
PayrollRelationshipNumber: string
Maximum Length:
30
Unique identifier for the payroll -
PersonId: integer
(int64)
Unique identifier for the payroll
-
PersonNumber: string
Maximum Length:
30
Unique identifier for the payroll -
PpmName: string
Title:
Personal Payment Method
Maximum Length:80
Unique identifier for the payroll -
PpmNameVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
PrepayCumRelActionId: integer
(int64)
Unique identifier for the payroll
-
PrePaymentId: integer
(int64)
Unique identifier for the payroll
-
PrepayPaymentDate: string
(date)
Unique identifier for the payroll
-
PrepayProcessDate: string
(date)
Unique identifier for the payroll
-
PrepayProcSubmitDate: string
(date)
Unique identifier for the payroll
-
PrepayRelActionId: integer
(int64)
Unique identifier for the payroll
-
PreventPaymentFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
Priority: integer
(int64)
Unique identifier for the payroll
-
ProcessDate: string
(date)
Unique identifier for the payroll
-
ProcessEndDate: string
(date)
Unique identifier for the payroll
-
ProcessName: string
Maximum Length:
80
Unique identifier for the payroll -
ProcessNameCode: string
Maximum Length:
80
Unique identifier for the payroll -
ProcessStartDate: string
(date)
Unique identifier for the payroll
-
Reason: string
Maximum Length:
80
Unique identifier for the payroll -
ReasonVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
RelationshipId: integer
(int64)
Unique identifier for the payroll
-
RollbackFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
RollUpPaymentActionId: number
Read Only:
true
Unique identifier for the payroll -
SecondaryAccountReference: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
ShowVoidedPayment: string
Read Only:
true
Maximum Length:1
Unique identifier for the payroll -
Source: string
Maximum Length:
80
Unique identifier for the payroll -
Status: string
Title:
Payment Status
Maximum Length:4000
Unique identifier for the payroll -
StatusCode: string
Maximum Length:
1
Unique identifier for the payroll -
VoidPaymentActionId: integer
(int64)
Unique identifier for the payroll
-
VoidPaymentFlag: boolean
Maximum Length:
1
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-PrimaryClassificationLOV-item-response
Type:
Show Source
object
-
BaseClassificationId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
BaseClassificationName: string
Read Only:
true
Maximum Length:160
Unique identifier for the payroll -
ClassificationId: integer
Read Only:
true
Unique identifier for the payroll -
ClassificationName: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
DateFrom: string
(date)
Read Only:
true
Unique identifier for the payroll -
DateTo: string
(date)
Read Only:
true
Unique identifier for the payroll -
LegislationCode: string
Read Only:
true
Maximum Length:30
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-RunResult-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Unique identifier for the payroll -
CalcBreakdownId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
ContextId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
DateEarned: string
(date)
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 -
ElementName: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
ElementTypeId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
GenerateDbItemsFlag: boolean
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
Inputcurrency: string
Title:
Input Currency
Read Only:true
Maximum Length:15
Unique identifier for the payroll -
Inputcurrencycode: string
Read Only:
true
Maximum Length:15
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 -
Legcode: string
Read Only:
true
Maximum Length:30
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. -
LookupType: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
lovResultValue: string
Unique identifier for the payroll
-
OutputCurrencyCode: string
Read Only:
true
Maximum Length:15
Unique identifier for the payroll -
PAY_LOV_lovResultValue_LOV_SWITCHER: string
Read Only:
true
-
PayrollRelActionId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
PayrollRelationshipId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
Pclassid: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
PersonId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
PrimaryClassification: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
ProcessingPriority: integer
(int32)
Read Only:
true
Unique identifier for the payroll -
ProrationDates: string
Title:
Proration Period
Read Only:true
Maximum Length:37
Unique identifier for the payroll -
ProrationEndDate: string
(date)
Read Only:
true
Unique identifier for the payroll -
ProrationStartDate: string
(date)
Read Only:
true
Unique identifier for the payroll -
Prunsourceid: 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
Title:
Element Entry Result Identifier
Read Only:true
Unique identifier for the payroll -
RunResultNum: number
Read Only:
true
Unique identifier for the payroll -
RunTypeId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
RunTypeName: string
Title:
Run Type
Read Only:true
Maximum Length:80
Unique identifier for the payroll -
Sclassid: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
SecondaryClassification: string
Title:
Secondary Classification
Read Only:true
Maximum Length:120
Unique identifier for the payroll -
SourceType: string
Read Only:
true
Maximum Length:1
Unique identifier for the payroll -
Symbol: string
Read Only:
true
Maximum Length:12
Unique identifier for the payroll -
TaxReportingName: string
Title:
Tax Reporting Unit
Read Only:true
Maximum Length:240
Unique identifier for the payroll -
TaxUnitId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
Unit: string
Title:
Unit of Measure
Read Only:true
Maximum Length:80
Unique identifier for the payroll -
Uom: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
UseAtAsgLevel: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
ValueDetails: string
Read Only:
true
Maximum Length:4000
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 -
VoDecodedlookup: string
Unique identifier for the payroll
-
VoName: string
Read Only:
true
Maximum Length:200
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-RunResultRateDetail-item-response
Type:
Show Source
object
-
Amount: string
Read Only:
true
Maximum Length:60
Unique identifier for the payroll -
BaseElementName: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
Classification: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
ClassificationId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
Element: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
Factor: string
Read Only:
true
Maximum Length:60
Unique identifier for the payroll -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollRelActionId: integer
Read Only:
true
Unique identifier for the payroll -
Rate: string
Read Only:
true
Maximum Length:60
Unique identifier for the payroll -
RunResultId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
UnitType: string
Read Only:
true
Maximum Length:60
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-SOEBalanceView-item-response
Type:
Show Source
object
-
BalanceName: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
BalanceTypeId: integer
Read Only:
true
Unique identifier for the payroll -
BalGrpUeBaseName: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
BalGrpUeName: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
BalGrpUeSeq: string
Read Only:
true
Maximum Length:120
Unique identifier for the payroll -
CtxString: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
CtxUserString: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
DefbalForBreakdown: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId1: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId10: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId2: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId3: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId4: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId5: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId6: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId7: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId8: integer
Read Only:
true
Unique identifier for the payroll -
DefbalId9: integer
Read Only:
true
Unique identifier for the payroll -
DimensionName: string
Read Only:
true
Maximum Length:160
Unique identifier for the payroll -
FeedCheckingType: string
Read Only:
true
Maximum Length:1
Unique identifier for the payroll -
LegislationCode: string
Read Only:
true
Maximum Length:30
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. -
PayrollRelActionId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
RowIndex: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
TotalValue1: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
TotalValue2: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
Uom: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
UomCode: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
Value1: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value10: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value2: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value3: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value4: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value5: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value6: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value7: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value8: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll -
Value9: string
Read Only:
true
Maximum Length:4000
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-TaxReportingUnitLOV-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollRelActionId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
TaxReportingUnitId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
TaxReportingUnitName: string
Read Only:
true
Maximum Length:255
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personProcessResults-VoidPayment-item-response
Type:
Show Source
object
-
AccountNumber: string
Title:
Bank Account Number
Maximum Length:80
Unique identifier for the payroll -
AccountNumberVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
Amount: number
Title:
Amount
Unique identifier for the payroll -
BankAccountId: integer
(int64)
Unique identifier for the payroll
-
BankAccountNumberLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BankAccountType: string
Read Only:
true
Maximum Length:25
Unique identifier for the payroll -
BankAccountTypeLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BankName: string
Read Only:
true
Maximum Length:360
Unique identifier for the payroll -
BankNameLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BankNumber: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
BankNumberLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BasePaymentTypeName: string
Read Only:
true
Maximum Length:80
Unique identifier for the payroll -
BicCode: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
BicCodeLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BranchName: string
Read Only:
true
Maximum Length:360
Unique identifier for the payroll -
BranchNameLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BranchNumber: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
BranchNumberLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
BranchPartyId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
CalcBreakdownId: integer
(int64)
Unique identifier for the payroll
-
CalcBreakdownRef: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
CalculationBreakdownValue: string
Read Only:
true
Unique identifier for the payroll -
CancelRelActionId: integer
Read Only:
true
Unique identifier for the payroll -
CheckDigits: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
CurrencyCode: string
Maximum Length:
15
Unique identifier for the payroll -
EmpRelActionId: integer
Read Only:
true
Unique identifier for the payroll -
ExpPmtDtVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
ExtBankAccountId: integer
(int64)
Read Only:
true
Unique identifier for the payroll -
FlowInstanceName: string
Maximum Length:
80
Unique identifier for the payroll -
Iban: string
Read Only:
true
Maximum Length:50
Unique identifier for the payroll -
IbanLabel: string
Read Only:
true
Maximum Length:100
Unique identifier for the payroll -
IsBankTransfer: string
Read Only:
true
Maximum Length:1
Unique identifier for the payroll -
LegislationCode: string
Read Only:
true
Maximum Length:30
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. -
MakeExternalPaymentFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
Opm: string
Maximum Length:
80
Unique identifier for the payroll -
Payee: string
Maximum Length:
2000
Unique identifier for the payroll -
PayeeId: integer
(int64)
Unique identifier for the payroll
-
PayeeType: string
Maximum Length:
12
Unique identifier for the payroll -
PayeeVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
PayLockingAction: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
PayLockingFlag: boolean
Read Only:
true
Unique identifier for the payroll -
PaymentDate: string
(date)
Title:
Payment Date
Unique identifier for the payroll -
PaymentProcSubmitDate: string
(date)
Unique identifier for the payroll
-
PaymentReference: string
Title:
Payment Reference
Maximum Length:30
Unique identifier for the payroll -
PaymentRefVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
PaymentRelActionId: integer
(int64)
Unique identifier for the payroll
-
PaymentTypeId: integer
(int64)
Unique identifier for the payroll
-
PaymentTypeName: string
Maximum Length:
80
Unique identifier for the payroll -
PayrollActionId: integer
(int64)
Unique identifier for the payroll
-
PayrollId: integer
(int64)
Unique identifier for the payroll
-
PayrollName: string
Maximum Length:
80
Unique identifier for the payroll -
PayrollRelActionId: integer
(int64)
Unique identifier for the payroll
-
PayrollRelationshipNumber: string
Maximum Length:
30
Unique identifier for the payroll -
PersonId: integer
(int64)
Unique identifier for the payroll
-
PersonNumber: string
Maximum Length:
30
Unique identifier for the payroll -
PpmName: string
Title:
Personal Payment Method
Maximum Length:80
Unique identifier for the payroll -
PpmNameVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
PrepayCumRelActionId: integer
(int64)
Unique identifier for the payroll
-
PrePaymentId: integer
(int64)
Unique identifier for the payroll
-
PrepayPaymentDate: string
(date)
Unique identifier for the payroll
-
PrepayProcessDate: string
(date)
Unique identifier for the payroll
-
PrepayProcSubmitDate: string
(date)
Unique identifier for the payroll
-
PrepayRelActionId: integer
(int64)
Unique identifier for the payroll
-
PreventPaymentFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
Priority: integer
(int64)
Unique identifier for the payroll
-
ProcessDate: string
(date)
Unique identifier for the payroll
-
ProcessEndDate: string
(date)
Unique identifier for the payroll
-
ProcessName: string
Maximum Length:
80
Unique identifier for the payroll -
ProcessNameCode: string
Maximum Length:
80
Unique identifier for the payroll -
ProcessStartDate: string
(date)
Unique identifier for the payroll
-
Reason: string
Maximum Length:
80
Unique identifier for the payroll -
ReasonVisibleFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
RelationshipId: integer
(int64)
Unique identifier for the payroll
-
RollbackFlag: boolean
Maximum Length:
1
Unique identifier for the payroll -
RollUpPaymentActionId: number
Read Only:
true
Unique identifier for the payroll -
SecondaryAccountReference: string
Read Only:
true
Maximum Length:30
Unique identifier for the payroll -
ShowVoidedPayment: string
Read Only:
true
Maximum Length:1
Unique identifier for the payroll -
Source: string
Maximum Length:
80
Unique identifier for the payroll -
Status: string
Title:
Payment Status
Maximum Length:4000
Unique identifier for the payroll -
StatusCode: string
Maximum Length:
1
Unique identifier for the payroll -
VoidPaymentActionId: integer
(int64)
Unique identifier for the payroll
-
VoidPaymentFlag: boolean
Maximum Length:
1
Unique identifier for the payroll
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- BalanceGroupLOV
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceGroupLOVParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- BalanceTypeLOV
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceTypeLOVParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- BalanceView
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceViewParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- CalculationBreakdown
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/CalculationBreakdownParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- Payments
-
Parameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- PayrollAssignmentLOV
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/PayrollAssignmentLOVParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- PersonProcessPCG
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/PersonProcessPCGParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- Prepayments
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/PrepaymentsParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- PrimaryClassificationLOV
-
Parameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- RunResult
-
Parameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- RunResultRateDetail
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/RunResultRateDetailParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- SOEBalanceView
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/SOEBalanceViewParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- TaxReportingUnitLOV
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/TaxReportingUnitLOVParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- VoidPayment
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/VoidPaymentParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- attachments
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/attachmentsParameters:
- ObjectActionId:
$request.path.ObjectActionId
The attachments resource is used to view, create, and update attachments. - ObjectActionId:
- costAdjustments
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/costAdjustmentsParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- costingResults
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/costingResultsParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- messages
-
Parameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId:
- performObjectAction
-
Operation: /hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/action/performObjectActionParameters:
- ObjectActionId:
$request.path.ObjectActionId
Unique identifier for the payroll - ObjectActionId: