Get all personal payment methods
get
/hcmRestApi/resources/11.13.18.05/personalPaymentMethods
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 personal payment method attributes that Payroll REST services can use.
Finder Variables- EffectiveEndDate; string; Date at the end of the date range within which the personal payment method is effective.
- EffectiveStartDate; string; Date at the beginning of the date range within which the personal payment method is effective.
- PartyId; integer; Unique identifier used to retrieve the payment details for the person. The party is an entity of the trading community model.
- PersonalPaymentMethodId; integer; Unique identifier for the personal payment method used to retrieve the personal payment method record.
- findByAssignmentNumberPersonNumber Finds all personal payment methods based on the assignment number or person number.
Finder Variables- AssignmentNumber; string; Assignment number used to retrieve the personal payment methods.
- PersonNumber; string; Person number used to retrieve the personal payment methods.
- SysEffectiveDate; object;
- PrimaryKey Finds all personal payment method attributes that Payroll REST services can use.
-
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; Amount to be credited to this payment method.
- BankAccountId; integer; Unique identifier of the bank account associated with the personal payment method.
- EffectiveEndDate; string; Date at the end of the date range within which the personal payment method is effective.
- EffectiveStartDate; string; Date at the beginning of the date range within which the personal payment method is effective.
- Name; string; Name of the personal payment method.
- OrgPaymentMethodId; integer; Unique identifier of the organization payment method associated with the personal payment method.
- PartyId; integer; 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; Payment type associated with the personal payment method, such as check.
- PayrollRelationshipId; integer; Payroll relationship associated with this personal payment method.
- Percentage; number; Percentage value to be paid using this payment method, such as 5%.
- PersonNumber; string; Person number associated with this personal payment method.
- PersonalPaymentMethodId; integer; System-generated unique identifier for the personal payment method.
- Priority; integer; Order in which the personal payment methods are processed. The personal payment method with priority 1 is processed first.
-
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
-
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
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 : personalPaymentMethods
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 : personalPaymentMethods-item-response
Type:
Show Source
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.
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.
Examples
This example shows how to retrieve all personal payment methods by submitting a GET request on the REST resource using cURL.
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
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": 300100004929909, "Name": "ZPAY Com TH EFT Payment Method", "EffectiveStartDate": "2010-01-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100002943750, "BankAccountId": 590, "PaymentAmountType": "M", "Amount": 700, "Percentage": null, "Priority": 10, "PayrollRelationshipId": 300100002951658, "PartyId": 300100002947512, "PersonNumber": "300100002951644", "links": [ {} ] }, { "PersonalPaymentMethodId": 300100002961408, "Name": "ZPAY Com TH EFT Payment Method", "EffectiveStartDate": "2010-01-01", "EffectiveEndDate": "2012-09-03", "OrgPaymentMethodId": 300100002943750, "BankAccountId": 570, "PaymentAmountType": "M", "Amount": 456, "Percentage": null, "Priority": 10, "PayrollRelationshipId": 300100002957660, "PartyId": 300100002947519, "PersonNumber": "300100002957646", "links": [ {} ] }, { "PersonalPaymentMethodId": 300100007660539, "Name": "NACHA Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100003245046, "BankAccountId": 672, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100003263782, "PartyId": 300100003261650, "PersonNumber": "300100003263769", "links": [ {} ] }, { "PersonalPaymentMethodId": 300100023589370, "Name": "ZHRX-AU-Green DD OPM", "EffectiveStartDate": "2010-01-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100023548941, "BankAccountId": 972, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100004490324, "PartyId": 300100004477956, "PersonNumber": "300100004490073", "links": [] }, { "PersonalPaymentMethodId": 300100023623815, "Name": "ZHRX-AU-Ruddock DD PPM", "EffectiveStartDate": "2010-01-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100023548941, "BankAccountId": 959, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100004500599, "PartyId": 300100004478279, "PersonNumber": "300100004499344", "links": [] }, { "PersonalPaymentMethodId": 300100007669938, "Name": "BACS Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100005800594, "BankAccountId": 652, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100006014523, "PartyId": 300100006001608, "PersonNumber": "300100006014510", "links": [] }, { "PersonalPaymentMethodId": 300100007669884, "Name": null, "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100005800588, "BankAccountId": null, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100006038768, "PartyId": 300100006002218, "PersonNumber": "300100006038617", "links": [] }, { "PersonalPaymentMethodId": 300100007660541, "Name": "NACHA Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100003245046, "BankAccountId": 673, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 20, "PayrollRelationshipId": 300100006485851, "PartyId": 300100006469307, "PersonNumber": "300100006485838", "links": [] }, { "PersonalPaymentMethodId": 300100007660542, "Name": "Check Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100003245042, "BankAccountId": null, "PaymentAmountType": "M", "Amount": 300, "Percentage": null, "Priority": 10, "PayrollRelationshipId": 300100006485851, "PartyId": 300100006469307, "PersonNumber": "300100006485838", "links": [] }, { "PersonalPaymentMethodId": 300100007660540, "Name": "Check Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100003245042, "BankAccountId": null, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100005746376, "PartyId": 300100005744042, "PersonNumber": "300100005746169", "links": [] }, { "PersonalPaymentMethodId": 300100008121858, "Name": "ZPAY Com TH Check Payment Method", "EffectiveStartDate": "2010-01-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100008121744, "BankAccountId": null, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100007825418, "PartyId": 300100007854089, "PersonNumber": "300100007825405", "links": [] }, { "PersonalPaymentMethodId": 300100007660518, "Name": "Check Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100003245042, "BankAccountId": null, "PaymentAmountType": "M", "Amount": 500, "Percentage": null, "Priority": 10, "PayrollRelationshipId": 300100005762787, "PartyId": 300100005744274, "PersonNumber": "300100005762738", "links": [] }, { "PersonalPaymentMethodId": 300100007660517, "Name": "NACHA Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100003245046, "BankAccountId": 671, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 20, "PayrollRelationshipId": 300100005762787, "PartyId": 300100005744274, "PersonNumber": "300100005762738", "links": [ {} ] }, { "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": [] }, { "PersonalPaymentMethodId": 300100007660543, "Name": "BACS Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100005800594, "BankAccountId": 651, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100005998399, "PartyId": 300100005969120, "PersonNumber": "300100005998386", "links": [] }, { "PersonalPaymentMethodId": 300100007658409, "Name": "Check Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100003245042, "BankAccountId": null, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100005773924, "PartyId": 300100005744313, "PersonNumber": "300100005773910", "links": [] }, { "PersonalPaymentMethodId": 300100007660544, "Name": "BACS Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100005800594, "BankAccountId": 674, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 20, "PayrollRelationshipId": 300100006012490, "PartyId": 300100006001561, "PersonNumber": "300100006008457", "links": [] }, { "PersonalPaymentMethodId": 300100007660545, "Name": null, "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100005800588, "BankAccountId": null, "PaymentAmountType": "M", "Amount": 300, "Percentage": null, "Priority": 10, "PayrollRelationshipId": 300100006012490, "PartyId": 300100006001561, "PersonNumber": "300100006008457", "links": [] }, { "PersonalPaymentMethodId": 300100007660849, "Name": "Cheque Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100005800591, "BankAccountId": null, "PaymentAmountType": "P", "Amount": null, "Percentage": 10, "Priority": 10, "PayrollRelationshipId": 300100006029251, "PartyId": 300100006002207, "PersonNumber": "300100006029103", "links": [] }, { "PersonalPaymentMethodId": 300100007660553, "Name": "BACS Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100005800594, "BankAccountId": 675, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 20, "PayrollRelationshipId": 300100006029251, "PartyId": 300100006002207, "PersonNumber": "300100006029103", "links": [] }, { "PersonalPaymentMethodId": 300100007658383, "Name": "NACHA Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100003245046, "BankAccountId": 670, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100005763186, "PartyId": 300100005744287, "PersonNumber": "300100005763118", "links": [] }, { "PersonalPaymentMethodId": 300100007660546, "Name": "Cheque Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100005800591, "BankAccountId": null, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100006012744, "PartyId": 300100006001573, "PersonNumber": "300100006012731", "links": [] }, { "PersonalPaymentMethodId": 300100007669917, "Name": "Cheque Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100005800591, "BankAccountId": null, "PaymentAmountType": "P", "Amount": null, "Percentage": 100, "Priority": 10, "PayrollRelationshipId": 300100006013043, "PartyId": 300100006001578, "PersonNumber": "300100006012989", "links": [] }, { "PersonalPaymentMethodId": 300100011981912, "Name": "Cheque Payment Method", "EffectiveStartDate": "2010-01-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100011959845, "BankAccountId": null, "PaymentAmountType": "P", "Amount": null, "Percentage": 50, "Priority": 10, "PayrollRelationshipId": 300100011922761, "PartyId": 300100011919684, "PersonNumber": "955160008166158", "links": [] }, { "PersonalPaymentMethodId": 300100011981913, "Name": "EFT Payment Method", "EffectiveStartDate": "2010-01-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100011959873, "BankAccountId": 811, "PaymentAmountType": "P", "Amount": null, "Percentage": 50, "Priority": 10, "PayrollRelationshipId": 300100011922761, "PartyId": 300100011919684, "PersonNumber": "955160008166158", "links": [] } ], "count": 25, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "", "name": "personalPaymentMethods", "kind": "collection" } ] }