1. Implementing Payroll for Kuwait
  2. Parameters for Calculation Information Payroll Formulas

Parameters for Calculation Information Payroll Formulas

Parameters for Calculation Information Payroll Formulas

Input and Output Parameters for the Calculation Information Payroll Formulas

  1. CALL_CALC_VALUE (Fast Formula)

    • Inputs

      Name

      Data Type

      Use To

      Base

      Number

      Mandatory. The amount that the calculation would be based on. For example, if the calculation is a Flat Rate, the Rate is applied to Base for calculating the return value.

      Range_Value

      Number

      Optional. Defaulted to Base when no value is specified. Range Value is used with the From and To values on the Range Items for identifying the Range Item to use for the calculation. For example, an Allowance could be based on the Number of Children and Employee has. The Range Value could be the Number of Children, but the Base could be Gross Earnings (as the Allowance is a factor of the Gross Earnings).

      Calculation_factor

      Number

      Optional. Default Value 1. Some Calculation Types use a factor (z). For example, Standard Formula 1, using this parameter the caller can specify the factor to use.

      Range_offset

      Number

      Optional. Default 0. This is similar to the Range Value. In this case, it defines the amount that has previously been considered. For example, when calculating an Incremental Rate for a Payroll Period, a previous Payroll Run may have calculated on a base/range of $2000. So there's a $2000 offset for the current Payroll Run.

      Range_low_override

      Array of Numbers

      Optional. Default Empty Array. The low and high overrides work in combination, the number of rows in the arrays must match the number of Range Items in the Value Definition to be processed. Certain statutory Value Definitions are allowed to override the Ranges (From and To values).

      Range_high_override

      Array of Numbers

      Optional. Default Empty Array. See Range_low_override.

      Value_name

      Array of Strings

      Optional. Default Empty Array. Some Calculation Types allow parts of the Calculation to be overridden. This is performed by the value_* parameters, these arrays must have equal numbers of entries. Value_name contains the Name of the attribute (typically a DB Item) to be overridden. Value_Value contains the override value and Value_datatype is the data type of the override.

      Value_value

      Array of Strings

      Optional. Default Empty Array. See Override_name.

      Value_datatype

      Array of Strings

      Optional. Default Empty Array. See Override_name.

    • Outputs

      Name

      Data Type

      Use To

      Ded_amount

      Number

      This amount is the returned calculated value.

      Periodicity

      String

      Some Calculation Types return the frequency of the Amount returned. For example, 'YEAR' meaning Annually, hence a calculated amount of $50000 with a periodicity of Year (annually).

      Out_uom

      String

      The Unit of Measure of the calculated Value.

  2. CALC_DIR_EXISTS (Formula Function)

    • Outputs

      Name

      Data Type

      Use To

      Exists

      String

      Y or N.

  3. GET_CALC_DETAILS (Fast Formula)

    • Outputs

      Name

      Data Type

      Use To

      Ded_amount

      Number

      This amount is the returned calculated value.

      Periodicity

      String

      Some Calculation Types return the frequency of the Amount returned. For example, 'YEAR' meaning Annually, hence a calculated amount of $50000 with a periodicity of Year (annually).

      Out_uom

      String

      The Unit of Measure of the calculated Value.

      High_value

      Array of Number

      Range Item High Value

      Base

      Array of Number

      Base used for this portion of the calculation.

      Rate

      Array of Number

      Rate Used for this portion of the calculation.

      Flat_amount

      Array of Number

      Flat Amount used for this portion of the calculation.

      Multiplier

      Array of Number

      The multiplier used for this portion of the calculation.

      Parameter

      Array of String

      The parameter used for this portion of the calculation.

      Value_a

      Array of Number

      Value A used for this portion of the Calculation.

      Value_b

      Array of Number

      Value B used for this portion of the Calculation.

      Value_c

      Array of Number

      Value C used for this portion of the Calculation.

      Val_def_name

      Array of String

      Name of the Value Definition used.

      Override_flags

      Array of String

      Override Types used for this portion of the calculation.

  4. CALC_DIR__GET_OVERRIDE_LEVEL (Fast Formula)

    • Inputs

      Name

      Data Type

      Use To

      Override_type

      String

      Type of Override to look for.

    • Outputs

      Name

      Data Type

      Use To

      Level

      String

      The level at which the override was found.