> ## 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 - Allowance Pay Codes STP2

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 Allowance Pay Codes.
The intended audience for this document are system administrators / standard users.

## Steps

### Create a new Allowance Pay Code record

Pay Codes are applied to Pay Transactions, Payee Allowances and Interpretation Rules processed for an
Employee.

The Allowance Pay Code record is used to define the Pay Codes for Allowance payments made to a Payee.
The record holds General Information and Pay Code Setup details.

Create an Allowance 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/KpcZiIUGJHaHQraR/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes/qrg-create-pay-codes-allowance-pay-codes-pdf-0-figure-1.png?fit=max&auto=format&n=KpcZiIUGJHaHQraR&q=85&s=2240c77a423f6fa4edc6027f03d142eb" alt="Screenshot from QRG Create Pay Codes - Allowance Pay Codes" width="456" height="202" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes/qrg-create-pay-codes-allowance-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/KpcZiIUGJHaHQraR/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes/qrg-create-pay-codes-allowance-pay-codes-pdf-0-figure-2.png?fit=max&auto=format&n=KpcZiIUGJHaHQraR&q=85&s=72ddf4cc5d762205fbb1f3a29b6d735f" alt="Screenshot from QRG Create Pay Codes - Allowance Pay Codes" width="456" height="362" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes/qrg-create-pay-codes-allowance-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/KpcZiIUGJHaHQraR/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes/qrg-create-pay-codes-allowance-pay-codes-pdf-0-figure-3.png?fit=max&auto=format&n=KpcZiIUGJHaHQraR&q=85&s=3f83d4c37bc4534a8744e3baac08224d" alt="Screenshot from QRG Create Pay Codes - Allowance Pay Codes" width="976" height="194" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes/qrg-create-pay-codes-allowance-pay-codes-pdf-0-figure-3.png" />
</Frame>

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

<Frame>
  <img src="https://mintcdn.com/2cloudnine-2edf05eb/KpcZiIUGJHaHQraR/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes/qrg-create-pay-codes-allowance-pay-codes-pdf-1-figure-4.png?fit=max&auto=format&n=KpcZiIUGJHaHQraR&q=85&s=185873681b8da0b08db872e5c6b5e18e" alt="Screenshot from QRG Create Pay Codes - Allowance Pay Codes" width="976" height="578" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes/qrg-create-pay-codes-allowance-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 Allowance Pay
      Code (see Figure 5):
      1. **Pay Code Name**
      2. **Description**
      3. **Pay Advice Description**
      4. **Invoice Name**
      5. **Pay Advice Sort Order**

   <Frame>
     <img src="https://mintcdn.com/2cloudnine-2edf05eb/KpcZiIUGJHaHQraR/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes/qrg-create-pay-codes-allowance-pay-codes-pdf-2-figure-5.png?fit=max&auto=format&n=KpcZiIUGJHaHQraR&q=85&s=fead8d31dbd32bdea6a61be529f15568" alt="Screenshot from QRG Create Pay Codes - Allowance Pay Codes" width="976" height="724" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes/qrg-create-pay-codes-allowance-pay-codes-pdf-2-figure-5.png" />
   </Frame>

   <Warning>
     The External ID / External Id fields are available and should only be populated where
     system integration is required for the record.
   </Warning>

   2. Populate the following required fields to provide the base details of the Allowance Pay
      Code (see Figure 6):
      1. **Pay Rate Multiplier**
      2. **Invoice Taxable**
      3. **STP Allowance Type**
   3. Populate the following optional fields as required (see Figure 6):
      1. To determine the multiplier which should be applied to Invoice Rates using this
         Pay Code, populate the **Invoice Rate Multiplier** field.
      2. If Other is selected for **STP Allowance Type**, you are also required to populate the
         **STP Allowance Other Description** field with a description of the Allowance Type.
      3. If Payroll Tax needs to be reported for Pay Transactions using this Pay Code, check
         the **AU Payroll Tax Reportable?** checkbox.
      4. 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.
      5. If Marginal Tax should be applied to Pay Transactions using this Pay Code, check
         the **PAYG Marginal Tax** checkbox.
      6. If Pay Transactions associated with this Pay Code are exempt from the taxable
         earnings calculations, check the **PAYG Tax Exempt?** checkbox.
      7. If Pay Transactions associated with this Pay Code should be exempt from GST,
         during the Australian Contractor Payroll calculation, populate the **GST Exempt?**
         field.
      8. If Pay Transactions associated with this Pay Code will contribute to the Total
         Quantity sum during Pay Batch processing, check the **Contributes to Total**
         **Quantity** checkbox.
      9. To sum the units worked against this Pay Code during Pay Batch Calculation for
         the purposes of Quantity Based Deduction Calculation, check the **Contributes to**
         **Dedn Qty Worked** checkbox.
      10. To exclude any transactions related to this Pay Code from the standard Pay Advice
          PDF, check the **Exclude From Pay Advice** checkbox.
      11. To determine the ATO Allowance Type, select from the picklist values available in
          the **ATO Allowance Type** field.

          * If Other is selected, you are also required to populate the **ATO Other**
            **Allowance Type Description** field with a description of the Allowance
            Type.

6. Click on the **Save** button.

<Frame>
  <img src="https://mintcdn.com/2cloudnine-2edf05eb/KpcZiIUGJHaHQraR/images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes/qrg-create-pay-codes-allowance-pay-codes-pdf-3-figure-6.png?fit=max&auto=format&n=KpcZiIUGJHaHQraR&q=85&s=87a3ecc9349f354c73290684df49001a" alt="Screenshot from QRG Create Pay Codes - Allowance Pay Codes" width="976" height="826" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-pay-codes-allowance-pay-codes/qrg-create-pay-codes-allowance-pay-codes-pdf-3-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 **Allowance Pay Code** is now created (see Figure 7).

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

<Danger>
  Allowance 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>

7. To modify an existing **Allowance 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-allowance-pay-codes-inline-4-1.png" alt="Inline icon" /> that appears within fields when hovering with your
   cursor.
8. When complete, click on the **Save** button.

## Field Descriptions

**ATO Allowance Type** indicates how this allowance Pay Code will be reported during Single Touch Payroll
Lodgement processing :

* **Gross** where the Allowance should be added to the Gross Pay for Single Touch Payroll and not
  reported separately.

* **Car** where the Allowance should be reported separately and categorised under the Car Allowance
  type, according to the ATO Single Touch Payroll requirements.

* **Laundry** where the Allowance should be reported separately and categorised under the Laundry
  Allowance type, according to the ATO Single Touch Payroll requirements.

* **Meals** where the Allowance should be reported separately and categorised under the Meals
  Allowance type, according to the ATO Single Touch Payroll requirements.

* **Other** where the Allowance should be reported separately and categorised under the Other
  Allowance type, according to the ATO Single Touch Payroll requirements.

* **Transport** where the Allowance should be reported separately and categorised under the
  Transport Allowance type, according to the ATO Single Touch Payroll requirements.

* **Travel** where the Allowance should be reported separately and categorised under the Travel
  Allowance type, according to the ATO Single Touch Payroll requirements.

**ATO Other Allowance Type Description** if the ATO Allowance Type is Other, define the description of the
Allowance here.

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

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

**Contributes to Dedn Qty Worked** indicates whether the units worked of this Pay Code will be summed
during Pay Batch Calculation for the purpose of Quantity Based Deduction Calculation.

**Contributes to Total Quantity** indicates whether this Pay Code record contributes to the Total Quantity
sum displayed in Pay Batch Manager and in Payee Pay Batch records.

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

**External ID** / **External Id** defines the ID of the corresponding record in an external system that has been
used to create/update this record.

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

**Invoice Name** defines the Name that will be used on Invoices for the Pay Code, and can only be a
maximum of 15 characters. If not populated and if the Pay Code is used in Invoices, it will be blank.

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

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

**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 Marginal Tax** indicates whether marginal taxation should be applied during the Pay Batch
Calculation of Pay Transactions using this Pay Code.

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

**STP Allowance Type** defines how this allowance Pay Code will be reported in STP Phase 2.

**STP Allowance Other Description** defines what description will be reported in STP Phase 2 when the STP
Allowance Type is Other.

## Further Information

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