Get all
get
/hcmRestApi/resources/11.13.18.05/payslips
Get all earnings and deductions for a payslip.
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all the attachments that match the specified primary key criteria.
Finder Variables- DocumentsOfRecordId; integer; Finds all the payslip documents that match the specified primary key criteria.
- PrimaryKey Finds all the attachments that match the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- Amount; number; Net pay amount.
- AttachmentEntityName; string; Attachment entity name.
- CreationDate; string; Creation date of the payslip document.
- CurrencyCode; string; Currency code for the payment.
- DefaultCurrencyCode; string; Currency code of a legislative data group.
- DocumentsOfRecordId; integer; Unique identifier of the payslip.
- PaymentDate; string; Date on which the employee gets the payment.
- PayrollRelationshipId; integer; Payroll relationship identifier for payslips
- PayrollRelationshipNumber; string; Unique number of the payroll relationship.
- PayslipViewDate; string; Date on which the payslip is available to the employee.
- PeriodEndDate; string; End date of the payroll period.
- PeriodStartDate; string; Start date of the payroll period.
- PersonId; integer; Unique identifier of the person.
- RelActionId; integer; Unique identifier of the payslip process run for an employee.
- WeekDay; string; Payroll relationship identifier for payslips
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : payslips
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : payslips-item-response
Type:
Show Source
object
-
Amount: number
Net pay amount.
-
AttachmentEntityName: string
Maximum Length:
22
Attachment entity name. -
CreationDate: string
(date-time)
Read Only:
true
Creation date of the payslip document. -
CurrencyCode: string
Maximum Length:
20
Currency code for the payment. -
DefaultCurrencyCode: string
Title:
Default Currency
Read Only:true
Maximum Length:20
Currency code of a legislative data group. -
documents: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
DocumentsOfRecordId: integer
(int64)
Unique identifier of the payslip.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentDate: string
(date)
Date on which the employee gets the payment.
-
PayrollRelationshipId: integer
(int64)
Payroll relationship identifier for payslips
-
PayrollRelationshipNumber: string
Title:
Payroll Relationship Number
Read Only:true
Maximum Length:30
Unique number of the payroll relationship. -
payslipHistory: array
Payslip History
Title:
Payslip History
The payslipHistory resource is a child of the payslips resource. It includes all the historical payment details made to the employee. -
PayslipSummary: array
Payslips Summary
Title:
Payslips Summary
-
PayslipViewDate: string
(date)
Date on which the payslip is available to the employee.
-
PeriodEndDate: string
(date)
End date of the payroll period.
-
PeriodStartDate: string
(date)
Start date of the payroll period.
-
PersonId: integer
(int64)
Unique identifier of the person.
-
RelActionId: integer
(int64)
Unique identifier of the payslip process run for an employee.
-
WeekDay: string
Read Only:
true
Maximum Length:255
Payroll relationship identifier for payslips
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Payslip History
Type:
array
Title:
Payslip History
The payslipHistory resource is a child of the payslips resource. It includes all the historical payment details made to the employee.
Show Source
Nested Schema : payslips-documents-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. -
AttachmentsPreview: array
Attachment Previews
Title:
Attachment Previews
The attachments preview resource is used to preview the attachment pages. -
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 : Attachment Previews
Type:
array
Title:
Attachment Previews
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : payslips-documents-AttachmentsPreview-item-response
Type:
Show Source
object
-
Attachment: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
ImageHeight: integer
Title:
Image Height
Read Only:true
The height of the previewed image. -
ImageSource: string
Title:
Image Source
Read Only:true
The preview of the image in base64 encoded PNG format. -
ImageWidth: integer
Title:
Image Width
Read Only:true
The width of the previewed image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageNum: integer
Title:
Page Number
Read Only:true
The number of the page in the preview.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : payslips-documents-AttachmentsPreview-Attachment-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. -
AttachmentsPreview: array
Attachment Previews
Title:
Attachment Previews
The attachments preview resource is used to preview the attachment pages. -
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 : Attachment Previews
Type:
array
Title:
Attachment Previews
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : payslips-documents-AttachmentsPreview-Attachment-AttachmentsPreview-item-response
Type:
Show Source
object
-
ImageHeight: integer
Title:
Image Height
Read Only:true
The height of the previewed image. -
ImageSource: string
Title:
Image Source
Read Only:true
The preview of the image in base64 encoded PNG format. -
ImageWidth: integer
Title:
Image Width
Read Only:true
The width of the previewed image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageNum: integer
Title:
Page Number
Read Only:true
The number of the page in the preview.
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 : payslips-payslipHistory-item-response
Type:
Show Source
object
-
Amount: number
Read Only:
true
Balance amount. -
BalanceName: string
Read Only:
true
Maximum Length:1000
Name of the balance reporting name. -
ClassName: string
Read Only:
true
Maximum Length:1000
Name of the primary classification. -
Context: string
Read Only:
true
Maximum Length:1000
Name of the balance region such as earnings, deductions and summary. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayrollRelActionId: string
Read Only:
true
Maximum Length:1000
Unique identifier of the payslip process run for an employee. -
PayrollRelationshipId: string
Read Only:
true
Maximum Length:255
Name of the base balance category. -
PrepayRelActionId: string
Read Only:
true
Maximum Length:1000
Name of the balance category. -
ProcessDate: string
Read Only:
true
Maximum Length:1000
Name of the base balance. -
SecClassName: string
Read Only:
true
Maximum Length:1000
Name of the primary base classification.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : payslips-PayslipSummary-item-response
Type:
Show Source
object
-
Amount: number
Read Only:
true
-
BaseBalanceName: string
Read Only:
true
-
BaseCategoryName: string
Read Only:
true
-
CategoryName: string
Read Only:
true
-
Context: string
Read Only:
true
-
DisplaySequence: integer
Read Only:
true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NetPayDistribution: array
Net Pay Distribution
Title:
Net Pay Distribution
The netPayDistribution resource is a child of the payslips resource. It includes all the payment details made to the employee. -
PayrollRelActionId: integer
Read Only:
true
-
PrimaryBaseClassName: string
Read Only:
true
-
PrimaryClassName: string
Read Only:
true
-
ReportingName: string
Read Only:
true
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Net Pay Distribution
Type:
array
Title:
Net Pay Distribution
The netPayDistribution resource is a child of the payslips resource. It includes all the payment details made to the employee.
Show Source
Nested Schema : payslips-PayslipSummary-NetPayDistribution-item-response
Type:
Show Source
object
-
AccountNumber: string
Read Only:
true
Maximum Length:100
Bank account number. -
Amount: number
Read Only:
true
Payment amount. -
CurrencyCode: string
Read Only:
true
Maximum Length:5
Currency code for the payment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentMethodName: string
Read Only:
true
Maximum Length:250
Name of the payment method. -
PaymentReference: string
Read Only:
true
Maximum Length:30
Payment reference for net pay distribution. -
PaymentType: string
Read Only:
true
Maximum Length:80
Payment type used to process payments.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- downloadAttachments
-
Downloads attachments for a document record of a worker.
Examples
This example shows how to retrieve payslips by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H -X GET https://<hostname>:<portno>/hcmRestApi/resources/11.13.18.05/payslips"
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type : application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"items": [
{
"Amount": 23854.97,
"DefaultCurrencyCode": "USD",
"PayslipViewDate": "2011-05-31",
"PeriodStartDate": "2011-05-01",
"PeriodEndDate": "2011-05-31",
"PaymentDate": "2011-05-31",
"DocumentsOfRecordId": 300100206533718,
"AttachmentEntityName": "HR_DOCUMENTS_OF_RECORD",
"PayrollRelationshipNumber": "100004259961",
"PersonId": 100100004259961,
"links": []
},
{
"Amount": 21559.97,
"DefaultCurrencyCode": "USD",
"PayslipViewDate": "2011-01-31",
"PeriodStartDate": "2011-01-01",
"PeriodEndDate": "2011-01-31",
"PaymentDate": "2011-01-31",
"DocumentsOfRecordId": 300100016912800,
"AttachmentEntityName": "HR_DOCUMENTS_OF_RECORD",
"PayrollRelationshipNumber": "100004259961",
"PersonId": 100100004259961,
"links": []
}
],
"count": 2,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": []
}