Get all organization payment methods

get

/hcmRestApi/resources/11.13.18.05/organizationPaymentMethodsLOV

Request

Query Parameters
  • 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
  • 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 organization payment methods based on the specified primary key criteria.
      Finder Variables
      • EffectiveEndDate; string; Last date in a date range during which an organization payment method is available for processing.
      • EffectiveStartDate; string; First date in a date range during which an organization payment method is available for processing.
      • LegislativeDataGroupId; integer; Unique identifier for the legislative data group that's used to retrieve the organization payment method.
      • OrgPaymentMethodId; integer; Unique identifier for the organization payment method that's used to retrieve the organization payment method.
    • findByAssignmentNumber Finds all organization payment methods based on the organization payment method identifier.
      Finder Variables
      • AssignmentNumber; string; Assignment number used to retrieve organization payment methods.
      • SysEffectiveDate; object;
  • 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:
    • BaseOrgPayMethodName; string; Code that uniquely identifies the organization payment method for the legislative data group.
    • Category; string; Category of the payment method, such as cash, check, or electronic file transfer.
    • CurrencyCode; string; Code that identifies the currency used in payroll calculations, payments, and balances.
    • EffectiveEndDate; string; Last date in a date range during which an organization payment method is available for processing.
    • EffectiveStartDate; string; First date in a date range during which an organization payment method is available for processing.
    • LegislationCode; string; Code for the legislation, such as GB or US, associated with the organization payment method.
    • LegislativeDataGroupId; integer; Legislative data group associated with the organization payment method.
    • OrgPaymentMethodId; integer; Unique identifier used to retrieve the organization payment method.
    • OrgPaymentMethodName; string; Name of the organization payment method that determines the payment source and payment type.
    • PaymentTypeName; string; Name of the payment method, such as cash, check, or direct deposit.
  • 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
  • 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.
  • 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 : organizationPaymentMethodsLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : organizationPaymentMethodsLOV-item-response
Type: object
Show Source
  • Title: Base Name
    Read Only: true
    Maximum Length: 80
    Code that uniquely identifies the organization payment method for the legislative data group.
  • Title: Payment Category
    Maximum Length: 2
    Category of the payment method, such as cash, check, or electronic file transfer.
  • Title: Currency
    Read Only: true
    Maximum Length: 15
    Code that identifies the currency used in payroll calculations, payments, and balances.
  • Title: Effective End Date
    Read Only: true
    Last date in a date range during which an organization payment method is available for processing.
  • Title: Effective Start Date
    Read Only: true
    First date in a date range during which an organization payment method is available for processing.
  • Read Only: true
    Maximum Length: 30
    Code for the legislation, such as GB or US, associated with the organization payment method.
  • Read Only: true
    Legislative data group associated with the organization payment method.
  • Links
  • Title: Organization Payment Method ID
    Read Only: true
    Unique identifier used to retrieve the organization payment method.
  • Title: Organization Payment Method Name
    Read Only: true
    Maximum Length: 80
    Name of the organization payment method that determines the payment source and payment type.
  • Title: Payment Type
    Maximum Length: 80
    Name of the payment method, such as cash, check, or direct deposit.
Back to Top

Examples

This example shows how to retrieve all organization payment methods 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/organizationPaymentMethodsLOV"

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": [
    {
      "BaseOrgPayMethodName": "ZPAY_GPVS_COST_OPM02",
      "OrgPaymentMethodId": 300100006250568,
      "OrgPaymentMethodName": "ZPAY_GPVS_COST_OPM02",
      "CurrencyCode": "LRD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2011-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "LR",
      "LegislativeDataGroupId": 300100001794617,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-UK-C-VISION-BACS ORG PAY METHOD",
      "OrgPaymentMethodId": 300100007745698,
      "OrgPaymentMethodName": "ZHRX-UK-C-VISION-BACS ORG PAY METHOD",
      "CurrencyCode": "GBP",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2011-01-01",
      "PaymentTypeName": "EFT",
      "Category": "MT",
      "LegislationCode": "GB",
      "LegislativeDataGroupId": 300100003140607,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-UK-C-VISION-CASH ORG PAY METHOD",
      "OrgPaymentMethodId": 300100007745823,
      "OrgPaymentMethodName": "ZHRX-UK-C-VISION-CASH ORG PAY METHOD",
      "CurrencyCode": "GBP",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2011-01-01",
      "PaymentTypeName": "Cash",
      "Category": "CA",
      "LegislationCode": "GB",
      "LegislativeDataGroupId": 300100003140607,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-SA-V-EFT ORG PAY METHOD 1",
      "OrgPaymentMethodId": 300100007851285,
      "OrgPaymentMethodName": "ZHRX-SA-V-EFT ORG PAY METHOD 1",
      "CurrencyCode": "SAR",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2010-01-01",
      "PaymentTypeName": "EFT",
      "Category": "MT",
      "LegislationCode": "SA",
      "LegislativeDataGroupId": 300100002694012,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "OPM1_Check",
      "OrgPaymentMethodId": 300100008121744,
      "OrgPaymentMethodName": "OPM1_Check",
      "CurrencyCode": "LRD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2010-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "LR",
      "LegislativeDataGroupId": 300100001794617,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-AE-V-CHEQUE ORG PAY METHOD 1",
      "OrgPaymentMethodId": 300100009214290,
      "OrgPaymentMethodName": "ZHRX-AE-V-CHEQUE ORG PAY METHOD 1",
      "CurrencyCode": "AED",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2010-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "AE",
      "LegislativeDataGroupId": 300100002694011,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZPAY_GPVS_RRF_PPM_Check",
      "OrgPaymentMethodId": 300100002943726,
      "OrgPaymentMethodName": "ZPAY_GPVS_RRF_PPM_Check",
      "CurrencyCode": "LRD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2010-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "LR",
      "LegislativeDataGroupId": 100000019978068,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX_USP_SOE_OPM_NACHA",
      "OrgPaymentMethodId": 300100003049047,
      "OrgPaymentMethodName": "ZHRX_USP_SOE_OPM_NACHA",
      "CurrencyCode": "USD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2009-01-01",
      "PaymentTypeName": "EFT",
      "Category": "MT",
      "LegislationCode": "US",
      "LegislativeDataGroupId": 300100001794247,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX_USP_TAX_NACHA",
      "OrgPaymentMethodId": 300100005352666,
      "OrgPaymentMethodName": "ZHRX_USP_TAX_NACHA",
      "CurrencyCode": "USD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2008-01-01",
      "PaymentTypeName": "EFT",
      "Category": "MT",
      "LegislationCode": "US",
      "LegislativeDataGroupId": 300100001794247,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX_US_VIS_MA_OPM01",
      "OrgPaymentMethodId": 300100007907912,
      "OrgPaymentMethodName": "ZHRX_US_VIS_MA_OPM01",
      "CurrencyCode": "USD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2011-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "US",
      "LegislativeDataGroupId": 300100007803368,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-SA-V-EFT ORG PAY METHOD 3",
      "OrgPaymentMethodId": 300100007851429,
      "OrgPaymentMethodName": "ZHRX-SA-V-EFT ORG PAY METHOD 3",
      "CurrencyCode": "SAR",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2010-01-01",
      "PaymentTypeName": "EFT",
      "Category": "MT",
      "LegislationCode": "SA",
      "LegislativeDataGroupId": 300100002694012,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX_US_GP_CHK_OPM",
      "OrgPaymentMethodId": 300100007921007,
      "OrgPaymentMethodName": "ZHRX_US_GP_CHK_OPM",
      "CurrencyCode": "USD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2011-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "US",
      "LegislativeDataGroupId": 300100007803368,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "PM US Sun Power Check ",
      "OrgPaymentMethodId": 300100003245042,
      "OrgPaymentMethodName": "PM US Sun Power Check ",
      "CurrencyCode": "USD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2001-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "US",
      "LegislativeDataGroupId": 300100003140635,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "CRFL RRF Check",
      "OrgPaymentMethodId": 300100005788440,
      "OrgPaymentMethodName": "CRFL RRF Check",
      "CurrencyCode": "USD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2008-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "US",
      "LegislativeDataGroupId": 300100002693669,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "PM Uk Enginerring Cash",
      "OrgPaymentMethodId": 300100005800588,
      "OrgPaymentMethodName": "PM Uk Enginerring Cash",
      "CurrencyCode": "GBP",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2001-01-01",
      "PaymentTypeName": "Cash",
      "Category": "CA",
      "LegislationCode": "GB",
      "LegislativeDataGroupId": 300100005750648,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "PM UK Engineering Cheque",
      "OrgPaymentMethodId": 300100005800591,
      "OrgPaymentMethodName": "PM UK Engineering Cheque",
      "CurrencyCode": "GBP",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2001-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "GB",
      "LegislativeDataGroupId": 300100005750648,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "PM UK Eng Direct Deposit",
      "OrgPaymentMethodId": 300100005800594,
      "OrgPaymentMethodName": "PM UK Eng Direct Deposit",
      "CurrencyCode": "GBP",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2001-01-01",
      "PaymentTypeName": "EFT",
      "Category": "MT",
      "LegislationCode": "GB",
      "LegislativeDataGroupId": 300100005750648,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-US-BAT-PYM27780",
      "OrgPaymentMethodId": 300100006887573,
      "OrgPaymentMethodName": "ZHRX-US-BAT-PYM27780",
      "CurrencyCode": "USD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2010-01-01",
      "PaymentTypeName": "EFT",
      "Category": "MT",
      "LegislationCode": "US",
      "LegislativeDataGroupId": 300100001794245,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-AE-V-EFT ORG PAY METHOD 2",
      "OrgPaymentMethodId": 300100009220447,
      "OrgPaymentMethodName": "ZHRX-AE-V-EFT ORG PAY METHOD 2",
      "CurrencyCode": "AED",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2010-01-01",
      "PaymentTypeName": "EFT",
      "Category": "MT",
      "LegislationCode": "AE",
      "LegislativeDataGroupId": 300100002694011,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-SG-QTP-Cash",
      "OrgPaymentMethodId": 300100011469003,
      "OrgPaymentMethodName": "ZHRX-SG-QTP-Cash",
      "CurrencyCode": "SGD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2011-01-01",
      "PaymentTypeName": "Cash",
      "Category": "CA",
      "LegislationCode": "SG",
      "LegislativeDataGroupId": 300100007642178,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-SA-V-CASH ORG PAY METHOD 1",
      "OrgPaymentMethodId": 300100007851276,
      "OrgPaymentMethodName": "ZHRX-SA-V-CASH ORG PAY METHOD 1",
      "CurrencyCode": "SAR",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2010-01-01",
      "PaymentTypeName": "Cash",
      "Category": "CA",
      "LegislationCode": "SA",
      "LegislativeDataGroupId": 300100002694012,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-SA-V-CHEQUE ORG PAY METHOD 2",
      "OrgPaymentMethodId": 300100007851288,
      "OrgPaymentMethodName": "ZHRX-SA-V-CHEQUE ORG PAY METHOD 2",
      "CurrencyCode": "SAR",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2010-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "SA",
      "LegislativeDataGroupId": 300100002694012,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX_US_VIS_MT_OPM01",
      "OrgPaymentMethodId": 300100007907917,
      "OrgPaymentMethodName": "ZHRX_US_VIS_MT_OPM01",
      "CurrencyCode": "USD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2011-01-01",
      "PaymentTypeName": "Check",
      "Category": "CH",
      "LegislationCode": "US",
      "LegislativeDataGroupId": 300100007803368,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX_USVS_BAT_NACHA_OPM",
      "OrgPaymentMethodId": 300100008111680,
      "OrgPaymentMethodName": "ZHRX_USVS_BAT_NACHA_OPM",
      "CurrencyCode": "USD",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2010-01-01",
      "PaymentTypeName": "EFT",
      "Category": "MT",
      "LegislationCode": "US",
      "LegislativeDataGroupId": 300100001794245,
      "links": []
    },
    {
      "BaseOrgPayMethodName": "ZHRX-AE-V-EFT ORG PAY METHOD 1",
      "OrgPaymentMethodId": 300100009217759,
      "OrgPaymentMethodName": "ZHRX-AE-V-EFT ORG PAY METHOD 1",
      "CurrencyCode": "AED",
      "EffectiveEndDate": "4712-12-31",
      "EffectiveStartDate": "2010-01-01",
      "PaymentTypeName": "EFT",
      "Category": "MT",
      "LegislationCode": "AE",
      "LegislativeDataGroupId": 300100002694011,
      "links": []
    }
  ],
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0,
  "links": []
}
Back to Top