1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Payslips

Get all

get

/hcmRestApi/resources/11.13.18.05/payslips

Get all earnings and deductions for a payslip.

Request

Query Parameters
  • 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).
  • 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
  • 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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : payslips
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : payslips-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
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 Summary
Type: array
Title: Payslips Summary
Show Source
Nested Schema : payslips-documents-item-response
Type: object
Show Source
Nested Schema : Attachment Previews
Type: array
Title: Attachment Previews
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : payslips-documents-AttachmentsPreview-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : payslips-documents-AttachmentsPreview-Attachment-item-response
Type: object
Show Source
Nested Schema : Attachment Previews
Type: array
Title: Attachment Previews
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : payslips-documents-AttachmentsPreview-Attachment-AttachmentsPreview-item-response
Type: object
Show Source
Nested Schema : payslips-payslipHistory-item-response
Type: object
Show Source
Nested Schema : payslips-PayslipSummary-item-response
Type: object
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: object
Show Source
Back to Top

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": []
}
Back to Top