> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.2cloudnine.com/llms.txt
> Use this file to discover all available pages before exploring further.

# QRG Create Pay Codes - Lump Sum Pay Codes

export const InlineImage = ({src, alt = "", height = "1.6em"}) => {
  return <img noZoom src={src} alt={alt} style={{
    display: "inline",
    verticalAlign: "start",
    height: height,
    margin: "0"
  }} />;
};

## Purpose

The purpose of this quick reference guide is to step through the process of creating Lump Sum Pay
Codes. The intended audience for this document are system administrators / standard users.

## Steps

### Create a new Lump Sum Pay Code record

Pay Codes are applied to Pay Transactions processed for an Employee.
The Lump Sum Pay Code record is used to define the Pay Codes used for Lump Sum payments made to a
Payee. The record holds General Information and Pay Code Setup details.

Create a Lump Sum Pay Code by following the below steps:

<Columns cols={2}>
  <div>
    1. Click on the **App Launcher** icon. (See
       Figure 1)
  </div>

  <div>
    <Frame>
      <img src="https://mintcdn.com/2cloudnine-2edf05eb/qcm1yaaRuYhzkzMJ/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-0-figure-1.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=ddef82074adf8a02c65b85ef657c21f0" alt="Screenshot from QRG Create Pay Codes - Lump Sum Pay Codes" width="456" height="202" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-0-figure-1.png" />
    </Frame>
  </div>
</Columns>

<Columns cols={2}>
  <div>
    2. Go to the **Pay Codes** object by using the
       Search function. (See Figure 2)
  </div>

  <div>
    <Frame>
      <img src="https://mintcdn.com/2cloudnine-2edf05eb/qcm1yaaRuYhzkzMJ/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-0-figure-2.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=54b8f3f09a924dde50714657c04f2544" alt="Screenshot from QRG Create Pay Codes - Lump Sum Pay Codes" width="456" height="360" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-0-figure-2.png" />
    </Frame>
  </div>
</Columns>

3. Click on the **New** button (see Figure 3)

<Frame>
  <img src="https://mintcdn.com/2cloudnine-2edf05eb/qcm1yaaRuYhzkzMJ/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-0-figure-3.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=221424eb15a0885009a1607a1f503010" alt="Screenshot from QRG Create Pay Codes - Lump Sum Pay Codes" width="976" height="194" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-0-figure-3.png" />
</Frame>

4. Select **Lump Sum** from the available record types and click on the **Next** button (see Figure 4).

<Frame>
  <img src="https://mintcdn.com/2cloudnine-2edf05eb/qcm1yaaRuYhzkzMJ/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-1-figure-4.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=bf17d48f748a5a5ee49d4cadbf4ce19c" alt="Screenshot from QRG Create Pay Codes - Lump Sum Pay Codes" width="976" height="576" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-1-figure-4.png" />
</Frame>

5. Follow this step in the sequence given below:
   1. Populate the following required fields to provide the base details of the Lump Sum Pay
      Code (see Figure 5):
      1. **Pay Code Name**
      2. **Description**
      3. **Pay Advice Description**
      4. **Pay Advice Sort Order**
   <Frame>
     <img src="https://mintcdn.com/2cloudnine-2edf05eb/qcm1yaaRuYhzkzMJ/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-1-figure-5.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=fc5b1abde027f1b53d6d52e8fdad811c" alt="Screenshot from QRG Create Pay Codes - Lump Sum Pay Codes" width="976" height="492" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-1-figure-5.png" />
   </Frame>
   2. Populate the following required fields to provide the base details of the Lump Sum Pay
      Code (see Figure 6):
      1. **Pay Rate Multiplier**
      2. **Invoice Taxable**
      3. **Lump Sum Type**
      4. **Invoice Taxable**
   3. Populate the following optional fields as required (see Figure 6):
      1. If you selected the Lump Sum Type value as ‘A’, then you will also need to select
         the Lump Sum A Type value by populating the field **Lump Sum A Type** .
      2. If Payroll Tax needs to be reported for Pay Transactions using this Pay Code, check
         the **AU Payroll Tax Reportable?** checkbox.
      3. To apply regional Payroll Tax exemptions for Pay Transactions using this Pay
         Code, select from the picklist values provided in the **AU Payroll Tax Report**
         **Exemptions** field.
      4. If Pay Transactions associated with this Pay Code are exempt from the taxable
         earnings calculations, check the **PAYG Tax Exempt?** checkbox .
      5. If Pay Transactions associated with this Pay Code should be exempt from GST
         during the Australian Contractor Payroll calculation, check the **GST Exempt?**
         checkbox.
      6. To exclude any transactions related to this Pay Code from the standard Pay
         Advice PDF, check the **Exclude From Pay Advice** checkbox.
6. Click on the **Save** button.

<Frame>
  <img src="https://mintcdn.com/2cloudnine-2edf05eb/qcm1yaaRuYhzkzMJ/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-2-figure-6.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=e6f613e53d9a440c117af72caddd8269" alt="Screenshot from QRG Create Pay Codes - Lump Sum Pay Codes" width="976" height="632" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-2-figure-6.png" />
</Frame>

<Warning>
  The Pay Rate Multiplier field is applied to the Pay Rate on the Assignment Rate Record,
  to determine the Pay Rate to apply on the Pay Transactions.
</Warning>

A new **Lump Sum Pay Code** is now created (see Figure 7).

<Frame>
  <img src="https://mintcdn.com/2cloudnine-2edf05eb/qcm1yaaRuYhzkzMJ/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-3-figure-7.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=57a17a7d28b071f21cacc1b2f7f03ebd" alt="Screenshot from QRG Create Pay Codes - Lump Sum Pay Codes" width="976" height="456" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-lump-sum-pay-codes/qrg-create-pay-codes-lump-sum-pay-codes-pdf-3-figure-7.png" />
</Frame>

<Danger>
  Lump Sum Pay Codes CAN NOT be deleted if they have related records or are used in
  other records. Deleting records is not recommended unless absolutely essential.
</Danger>

<Warning>
  A Pay Code can only be edited if it has not already been referenced within Pay Transactions,
  Interpretation Rules or Payee Allowance records. A new Pay Code will need to be created if updates
  are required after this point.
</Warning>

1. To modify an existing **Lump Sum Pay Code** record, open the required record and select the **Edit**
   button available on the top right side of the page. You can also double click within fields that
   need editing or just click on the pencil icon <InlineImage src="/images/icons/qrg-create-pay-codes-lump-sum-pay-codes-inline-3-1.png" alt="Inline icon" /> that appears within fields when hovering with
   your cursor.
2. When complete, click on the **Save** button.

## Field Descriptions

**AU Payroll Tax Reportable?** determines if the Pay Code will be considered during the 2cloudnine Payroll
Tax reporting process.

**AU Payroll Tax Report Exceptions** where a Pay Code is reportable for Payroll Tax list any localities here
where the Pay Code is considered not reportable.

**Description** is the description of this Pay Code.

**Exclude From Pay Advice** indicates that any transactions related to this Pay Code will not be displayed
on the standard Pay Advice PDF.

**GST Exempt?** When set to true any Pay Transactions using this Pay Code will not attract GST during
Australian Contractor Payroll calculation.

**Invoice Taxable** indicates if the Pay Code should have tax applied to the Invoice.

**Lump Sum Type** is the Lump Sum Type as defined by the Payment Summary Classification. Picklist
values are: A, B, D, E, and W.

**Lump Sum A Type** is the Lump Sum A Type as defined by the Payment Summary Classification.

**Pay Advice Description** is the description that will be displayed to a Payee on their Pay Advice PDFs for
any Pay Transactions related to this Pay Code.

**Pay Advice Sort Order** defines the order in which Pay Codes will be displayed on Pay Advice PDFs

**Pay Code Name** is the name given to the Pay Code record that is being created.

**PAYG Tax Exempt** indicates whether Pay Transactions using this Pay Code will count toward the taxable
earnings or the non-taxable earnings of the Payee.

**Pay Rate Multiplier** is the multiplier which will be applied to Pay Transactions using this Pay Code.

## Further Information

| Document                               | Document Type     | Description                       |
| -------------------------------------- | ----------------- | --------------------------------- |
| Create Pay Codes - Allowance Pay Codes | Task Instructions | How to create Allowance Pay Codes |
| Create Pay Codes - Deduction Pay Codes | Task Instructions | How to create Deduction Pay Codes |
| Create Pay Codes - ETP Pay Codes       | Task Instructions | How to create ETP Pay Codes       |
| Create Pay Codes - Expense Pay Codes   | Task Instructions | How to create Expense Pay Codes   |
| Create Pay Codes - Payment Pay Codes   | Task Instructions | How to create Payment Pay Codes   |
