Jump to

• Request
• Response
• Examples

Update a personal payment method

patch

/hcmRestApi/resources/11.13.18.05/personalPaymentMethods/{personalPaymentMethodsUniqID}

Request

Path Parameters

• 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.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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%.
• 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.

{
    "type":"object",
    "properties":{
        "PaymentAmountType":{
            "title":"Payment Amount Type",
            "maxLength":30,
            "type":"string",
            "description":"Payment type associated with the personal payment method, such as check.",
            "nullable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Date at the end of the date range within which the personal payment method is effective.",
            "format":"date",
            "nullable":false
        },
        "Percentage":{
            "title":"Percentage",
            "type":"number",
            "description":"Percentage value to be paid using this payment method, such as 5%.",
            "nullable":true,
            "x-hints":{
                "precision":22,
                "scale":2
            }
        },
        "BankAccountId":{
            "title":"Bank Account ID",
            "type":"integer",
            "description":"Unique identifier of the bank account associated with the personal payment method.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Priority":{
            "title":"Processing Order",
            "type":"integer",
            "description":"Order in which the personal payment methods are processed. The personal payment method with priority 1 is processed first.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount to be credited to this payment method.",
            "nullable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Date at the beginning of the date range within which the personal payment method is effective.",
            "format":"date",
            "nullable":false
        },
        "OrgPaymentMethodId":{
            "title":"Organization Payment Method",
            "type":"integer",
            "description":"Unique identifier of the organization payment method associated with the personal payment method.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PayrollRelationshipId":{
            "type":"integer",
            "description":"Payroll relationship associated with this personal payment method.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":250,
            "type":"string",
            "description":"Name of the personal payment method.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : personalPaymentMethods-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number associated with this personal payment method.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Date at the end of the date range within which the personal payment method is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Percentage":{
            "title":"Percentage",
            "type":"number",
            "description":"Percentage value to be paid using this payment method, such as 5%.",
            "nullable":true,
            "x-hints":{
                "precision":22,
                "scale":2
            },
            "x-queryable":true
        },
        "Priority":{
            "title":"Processing Order",
            "type":"integer",
            "description":"Order in which the personal payment methods are processed. The personal payment method with priority 1 is processed first.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount to be credited to this payment method.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":250,
            "type":"string",
            "description":"Name of the personal payment method.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonalPaymentMethodId":{
            "title":"Personal Payment Method ID",
            "type":"integer",
            "description":"System-generated unique identifier for the personal payment method.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PaymentAmountType":{
            "title":"Payment Amount Type",
            "maxLength":30,
            "type":"string",
            "description":"Payment type associated with the personal payment method, such as check.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BankAccountId":{
            "title":"Bank Account ID",
            "type":"integer",
            "description":"Unique identifier of the bank account associated with the personal payment method.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Date at the beginning of the date range within which the personal payment method is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "OrgPaymentMethodId":{
            "title":"Organization Payment Method",
            "type":"integer",
            "description":"Unique identifier of the organization payment method associated with the personal payment method.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayrollRelationshipId":{
            "type":"integer",
            "description":"Payroll relationship associated with this personal payment method.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example shows how to update a payment method by submitting a PATCH request on the REST resource.

curl -i -u "<username>:<password>" -H "Effective-Of=RangeMode=UPDATE;RangeStartDate=2016-01-01" -X PATCH -d <payload> https://<host>:<port>/hcmRestApi/resources/11.13.18.05/personalPaymentMethods/<Generated Unique Id>

Example of Payload

The following is an example of the request payload.

 {	
	"PersonalPaymentMethodId": 300100181650365,
	"Name": "Cheque Payment Method",
	"EffectiveStartDate": "2010-10-12",
	"EffectiveEndDate": "4712-12-31",
	"PayrollRelationshipId": 300100006014818,
	"Percentage": 29  
} 

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" : 300100181650365,
  "Name" : "Cheque Payment Method",
  "EffectiveStartDate" : "2016-01-01",
  "EffectiveEndDate" : "4712-12-31",
  "OrgPaymentMethodId" : 300100005800591,
  "BankAccountId" : null,
  "PaymentAmountType" : "P",
  "Amount" : null,
  "Percentage" : 29,
  "Priority" : 9,
  "PayrollRelationshipId" : 300100006014818,
  "PartyId" : 300100006001613,
  "PersonNumber" : "300100006014805",
  "links" : [ ]
}

This example shows how to correct a payment method by submitting a PATCH request on the REST resource.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "Effective-Of:RangeMode=CORRECTION" -X PATCH -d " <payload> https://<host>:<port>/hcmRestApi/resources/11.13.18.05/personalPaymentMethods/<Generated PPM Id>

Example of Payload

The following is an example of the request payload.

{  
  "PersonalPaymentMethodId": 300100181650365,
  "Name": "Cheque Payment Method",
  "EffectiveStartDate": "2010-10-12",
  "EffectiveEndDate": "4712-12-31",
  "Percentage": 29,
  "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

Back to Top