Create a personal payment method
post
/hcmRestApi/resources/11.13.18.05/personalPaymentMethods
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
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. -
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. -
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.
Response
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-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 create a personal payment method by submitting a POST request on the REST resource.
curl -i -u "<username>:<password>" -H Effective-Of:RangeStartDate=2010-10-12 -H POST -d <payload> https://<host>:<port>/hcmRestApi/resources/11.13.18.05/personalPaymentMethods
Example of Payload
The following is an example of the request payload.
{ "Name": "Cheque Payment Method", "EffectiveStartDate": "2010-02-01", "EffectiveEndDate": "4712-12-31", "OrgPaymentMethodId": 300100005800591, "BankAccountId": null, "PaymentAmountType": "P", "Amount": null, "Percentage": 29, "Priority": 9, "PayrollRelationshipId": 300100006014818 }
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.
{ "PersonalPaymentMethodId" : 300100181650103, "Name" : "Cheque Payment Method", "EffectiveStartDate" : "2010-10-12", "EffectiveEndDate" : "4712-12-31", "OrgPaymentMethodId" : 300100005800591, "BankAccountId" : null, "PaymentAmountType" : "P", "Amount" : null, "Percentage" : 30, "Priority" : 9, "PayrollRelationshipId" : 300100006014818, "PartyId" : 300100006001613, "PersonNumber" : "300100006014805", "links" : [ ] }