Payment Rules Information#
Functionality:#
This function retrieves information as seen on IPPM, for an employee's payment rules.Parameters:#
| EEM_ID | The actual ID for the employment record of the employee you are getting data for |
| WHAT | Identifies which element of the IPPM display you want to access. This must be one of the values noted below. |
| SPLIT_SEQUENCE | Optional. Identifies which split sequence you want to access. This must be one of the values noted below. |
| AS_OF | Optional. Provides a date frame to retrieve the data. If it is not provided, the current system date will be used. |
WHAT Parameter Values#
| BANK_ACCOUNT | The bank account as defined on the Payment Rules record |
| BANK_TRANSIT_CODE | The transit code of the bank linked to this record (from IPBL) |
| BANK_NAME | The name of the bank linked to this record (from IPBL) |
| BANK_ACCOUNT_TYPE | The saved value of the BANK_ACCOUNT_TYPE |
| AMOUNT | The dollar amount to be applied against this payment split rule |
| SPLIT_SEQUENCE | The actual split sequence number |
| NET_PAY_PERCENT | The percentage of net pay to be applied against this payment split rule |
| PAY_REMAINING | The value returned will either be 1 (if the toggle is on) or N if the toggle is off. The data in the database is actually 1 or NULL. |
| PAID_TO_ORDER_OF | Who htis payment should be Paid to the order of, if identified on IPPM |
SPLIT_SEQUENCE Parameter Values - OPTIONAL#
| FIRST | Default if not provided. The first split sequence in ascending order (regardless of split sequence code). |
| LAST | The last split sequence in ascending order |
| PAY REMAIN | The one split sequence record with the PAY_REMAINING toggle on |
| a number from 1 to 999 | This reflects an ordinal number (1 is first, 2 is second, etc. rather than looking for an exact match for sequence number) |
Returns: #
Varchar2 (regardless of the type of data being requested)Errors: #
- If an invalid WHAT parameter is passed, then BAD WHAT is returned
- If bad data, or no data is found then ERROR is returned
Example: #
P2K_PU.PPR(~,'BANK_TRANSIT_CODE','PAY REMAIN')
Will return the BANK_TRANSIT_CODE for the payment rules record that is marked with the PAY_REMAINING toggle on.
