> ## 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 Payee Allowances - Timesheet

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 a Payee Allowance of
Record Type Timesheet. The intended audience for this document are System Administrators / Standard
Users.

## Steps

### Create a new Timesheet Allowance record

The Timesheet Allowance record is used to define Allowances that are available for an Employee to
submit with Timesheet Entries. The record holds general Assignment information, Timesheet Allowance
Details, and Pay Codes.

Create a Timesheet Payee Allowance by following the below steps:

<Columns cols={2}>
  <div>
    1. Navigate to the **Payee** record.
       1. To identify a Payee record from
          an Employee record, enter the
          Employee name into the **Global**
          **Search.** (see Figure 1).

       2. Select the **Employee** record
          from the suggestions provided.

       3. Open the **Related** tab (see
          Figure 2).

       4. Identify the **Payee** related list.

       5. Select the **Payee** record.
  </div>

  <div>
    <Frame>
      <img src="https://mintcdn.com/2cloudnine-2edf05eb/qcm1yaaRuYhzkzMJ/images/generated/reference-guides/data-set-up-and-creation/qrg-create-payee-allowances-timesheet/qrg-create-payee-allowances-timesheet-pdf-0-figure-1.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=d32a9047489c261e82f9c7f0f072ed31" alt="Screenshot from QRG Create Payee Allowances - Timesheet" width="458" height="198" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-payee-allowances-timesheet/qrg-create-payee-allowances-timesheet-pdf-0-figure-1.png" />
    </Frame>
  </div>
</Columns>

<Frame>
  <img src="https://mintcdn.com/2cloudnine-2edf05eb/qcm1yaaRuYhzkzMJ/images/generated/reference-guides/data-set-up-and-creation/qrg-create-payee-allowances-timesheet/qrg-create-payee-allowances-timesheet-pdf-0-figure-2.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=98ed1fd82de0bd162158ed8321637012" alt="Screenshot from QRG Create Payee Allowances - Timesheet" width="976" height="600" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-payee-allowances-timesheet/qrg-create-payee-allowances-timesheet-pdf-0-figure-2.png" />
</Frame>

2. Click on the **Allowances** tab options (see Figure 3).
3. Click on the **New** button.

<Frame>
  <img src="https://mintcdn.com/2cloudnine-2edf05eb/qcm1yaaRuYhzkzMJ/images/generated/reference-guides/data-set-up-and-creation/qrg-create-payee-allowances-timesheet/qrg-create-payee-allowances-timesheet-pdf-1-figure-3.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=580b9fe8b3f27d360618696b458f385b" alt="Screenshot from QRG Create Payee Allowances - Timesheet" width="976" height="406" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-payee-allowances-timesheet/qrg-create-payee-allowances-timesheet-pdf-1-figure-3.png" />
</Frame>

4. Select **Timesheet Allowance** 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-payee-allowances-timesheet/qrg-create-payee-allowances-timesheet-pdf-1-figure-4.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=4e70f3bb732f4a8408689f8ee035e166" alt="Screenshot from QRG Create Payee Allowances - Timesheet" width="976" height="600" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-payee-allowances-timesheet/qrg-create-payee-allowances-timesheet-pdf-1-figure-4.png" />
</Frame>

5. Populate the following required fields to provide the base details of the Allowance: (see Figure 5)
   1. **Payee Allowance Name**
   2. **Employee**
   3. **Payee**
   4. **Assignment**
   5. **Payment Entity**
   6. **Available on Employee Community**
   7. **Timesheet Frequency**
   8. **Pay Code**
   9. **Effective Date**
6. The **Template Group** field must always be left blank when creating the record manually. It gets
   populated automatically when a Payee Allowance record is generated by a Payee Allowance
   Template Group being populated on the Assignment.
7. Populate the following optional fields as needed:
   1. To define any required rules and limits that will be used in assessing and determining
      Allowances payable, populate the following optional fields as needed. If left blank the
      rule/limit will not apply:
      1. **Maximum Quantity per Day**
      2. **Maximum Quantity per Timesheet**
      3. **Expiry Date**
   2. To prevent the Status of the Payee Allowance from being automatically updated by the
      automatic status update scheduled job, check the **Exclude From Auto Update** checkbox.
8. Click **Save** .

<Warning>
  The Timesheet Allowances are generally created by the use of Payee Timesheet
  Allowance Template Groups, more than by the use of Allowance Templates. Payroll
  Allowances however will utilise Allowance Templates to autocomplete some fields, or
  will create the record from scratch.
</Warning>

<Warning>
  The Employee, Payee and Payment Entity combination of the Payee Allowance must
  match those on the related Assignment.
</Warning>

<Frame>
  <img src="https://mintcdn.com/2cloudnine-2edf05eb/qcm1yaaRuYhzkzMJ/images/generated/reference-guides/data-set-up-and-creation/qrg-create-payee-allowances-timesheet/qrg-create-payee-allowances-timesheet-pdf-3-figure-5.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=d0537dd2b4d409bcdd4b479398e53c8b" alt="Screenshot from QRG Create Payee Allowances - Timesheet" width="976" height="1328" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-payee-allowances-timesheet/qrg-create-payee-allowances-timesheet-pdf-3-figure-5.png" />
</Frame>

<Danger>
  The Timesheet Frequency of the Payee Allowance Record and the Timesheet Calendar
  on the Assignment must match.
</Danger>

<Danger>
  The Allowance Statistics fields provide data on the usage of the Allowance record
  based on Payroll data, and should never be manually entered or overridden.
</Danger>

<Warning>
  The Status of the record will be automatically updated upon saving the record, based
  on the Effective Date and Expiry Date.
</Warning>

A new **Timesheet Payee Allowance** is now created (see Figure 6).

<Frame>
  <img src="https://mintcdn.com/2cloudnine-2edf05eb/qcm1yaaRuYhzkzMJ/images/generated/reference-guides/data-set-up-and-creation/qrg-create-payee-allowances-timesheet/qrg-create-payee-allowances-timesheet-pdf-4-figure-6.png?fit=max&auto=format&n=qcm1yaaRuYhzkzMJ&q=85&s=f00938305fd5d7511a4da61635fe33ad" alt="Screenshot from QRG Create Payee Allowances - Timesheet" width="976" height="498" data-path="images/generated/reference-guides/data-set-up-and-creation/qrg-create-payee-allowances-timesheet/qrg-create-payee-allowances-timesheet-pdf-4-figure-6.png" />
</Frame>

<Danger>
  Payee Allowance records CANNOT be deleted if they have related records or are used
  in other records. Deleting records is not recommended unless absolutely essential.
</Danger>

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

## Field Descriptions

**Assignment** details if this Payee Allowance Record is specific to an Assignment.

**Available on Employee Community** defines if the Timesheet Allowance will be available for Employee
selection via the Employee Community. If not, the Allowance will only be available to back office users via
the Timesheet Manager.

**Employee** is the Employee record this Payee Allowance Record relates to. This must match the Employee
of the Payee.

**Effective Date** is the date the Allowance will become effective. Allowances will not be available in the
Timesheet before this date.

**Exclude From Auto Update** when this box is checked the record will be skipped by the Automatic Status
Update scheduled job.

**Expiry Date** is the date the Allowance expires. Payments will not be made after this date. If blank, no
expiry date applies.

**Pay Code** defines the Pay Code that will be used when an Allowance is paid.

**Payee** is the Payee record this Payee Allowance Record relates to.

**Payee Allowance Name** defines the name for the Payee Allowance.

**Payment Entity** is the Payment Entity this Payee Allowance Record relates to.

**Maximum Quantity Per Day** defines the maximum quantity per day the user can define the Allowance is
to be paid. If left blank, no maximum will apply.

**Maximum Quantity Per Timesheet** defines the maximum quantity per Timesheet the user can define
the Allowance is to be paid. If left blank, no maximum will apply.

**Template Group** will only be populated if this Payee Allowance was created automatically by the use of a
Payee Allowance Template Group. For all Payee Allowance records created manually, this field should
always be left blank.

**Timesheet Frequency** defines the Timesheet Frequency on the Timesheet from which the Allowance
applies.

## Further Information

| Document                                    | Document Type     | Description                                            |
| ------------------------------------------- | ----------------- | ------------------------------------------------------ |
| QRG Create an Assignment - Temp             | Task Instructions | How to create an Assignment for Timesheet Employees    |
| QRG Create Payee Allowances - Payroll       | Task Instructions | How to create Payee Allowances for Payroll Record Type |
| QRG Create a Payee Allowance Template Group | Task Instructions | How to create a Payee Allowance Template Group         |
