Get a personal payment method
/hcmRestApi/resources/11.13.18.05/personalPaymentMethods/{personalPaymentMethodsUniqID}
Request
-
personalPaymentMethodsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Personal Payment Methods resource and used to uniquely identify an instance of Personal Payment Methods. The client should not generate the hash key value. Instead, the client should query on the Personal Payment Methods collection resource in order to navigate to a specific instance of Personal Payment Methods to get the hash key.
-
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).
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
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
- application/json
Default Response
-
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.
object
-
Amount: number
Title:
Amount
Amount to be credited to this payment method. -
BankAccountId: integer
(int64)
Title:
Bank Account ID
Unique identifier of the bank account associated with the personal payment method. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date at the end of the date range within which the personal payment method is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date at the beginning of the date range within which the personal payment method is effective. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:250
Name of the personal payment method. -
OrgPaymentMethodId: integer
(int64)
Title:
Organization Payment Method
Unique identifier of the organization payment method associated with the personal payment method. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
Unique identifier used to capture the payment details for the person, such as bank account information. The party is an entity of the trading community model. -
PaymentAmountType: string
Title:
Payment Amount Type
Maximum Length:30
Payment type associated with the personal payment method, such as check. -
PayrollRelationshipId: integer
(int64)
Payroll relationship associated with this personal payment method.
-
Percentage: number
Title:
Percentage
Percentage value to be paid using this payment method, such as 5%. -
PersonalPaymentMethodId: integer
(int64)
Title:
Personal Payment Method ID
System-generated unique identifier for the personal payment method. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number associated with this personal payment method. -
Priority: integer
(int64)
Title:
Processing Order
Order in which the personal payment methods are processed. The personal payment method with priority 1 is processed first.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This section covers all the parameters using which you can fetch a personal payment method.
Get a personal payment method by using a person number
This example shows how to retrieve a personal payment method by using a person number.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "Effective-Of:RangeStartDate=2010-10-12" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/personalPaymentMethods?finder=findByAssignmentNumberPersonNumber;PersonNumber=<PersonNumber>
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": [ { "PersonalPaymentMethodId": 300100007669965, "Name": "Cheque Payment Method_sdlfnsdfnksdkfhksdf", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100005800591, "BankAccountId": null, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100006014818, "PartyId": 300100006001613, "PersonNumber": "300100006014805", "links": [] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { ...] }
Get a personal payment method using an assignment number
This example shows how to retrieve a personal payment method by using an assignment number.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "Effective-Of:RangeStartDate=2010-10-12" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/personalPaymentMethods?finder=findByAssignmentNumberPersonNumber;AssignmentNumber=<AssignmentNumber>
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": [ { "PersonalPaymentMethodId": 300100007669965, "Name": "Cheque Payment Method_sdlfnsdfnksdkfhksdf", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100005800591, "BankAccountId": null, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100006014818, "PartyId": 300100006001613, "PersonNumber": "300100006014805", "links": [] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { ...] }
Get personal payment methods based on an effective date
This example shows how to retrieve personal payment methods as of an effective date.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "Effective-Of:RangeStartDate=2010-10-12" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/personalPaymentMethods?q=PayrollRelationshipId=<PayrollrelationshipId>&effectiveDate=<EffectiveDate in YYYY-MM-DD>
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": [ { "PersonalPaymentMethodId": 300100210071144, "Name": "Check Payment Method", "EffectiveStartDate": "2020-03-03", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100003245042, "BankAccountId": null, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 20, "PayrollRelationshipId": 300100006342199, "PartyId": 300100006257275, "PersonNumber": "300100006342154", "links": [] }, { "PersonalPaymentMethodId": 300100214492958, "Name": "PPM2", "EffectiveStartDate": "2020-08-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100003245042, "BankAccountId": null, "PaymentAmountType": "M", "Amount": 100, "Percentage": null, "Priority": 10, "PayrollRelationshipId": 300100006342199, "PartyId": 300100006257275, "PersonNumber": "300100006342154", "links": [] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [] }