Leave_accrual_rule

A leave accrual rule [Leave_accrual_rule] is a rule governing the periodic increase of employees' leave entitlement and leave balance adjustments when employees take time off.

—	XML	SOAP	REST	Database table
Object	`Leave_accrual_rule`	`oaLeave_accrual_rule`	—	`leave_accrual_rule`
Supported Commands	`Add`, `Read`, `Modify`	`add()`, `read()`, `modify()`, `upsert()`	—	—

—

XML

SOAP

REST

Database table

Object

Leave_accrual_rule

oaLeave_accrual_rule

—

leave_accrual_rule

Supported Commands

Add, Read, Modify

add(), read(), modify(), upsert()

—

The Leave_accrual_rule object has the following properties:

XML / SOAP	Database	Description
`active`	`active`	A 1/0 field indicating whether this is an active leave accrual rule. Defaults to 1 if not set when adding a leave accrual rule.
`amount`	`amount`	The number of hours per period.
`cap`	`cap`	Number of hours to cap the accrual at.
`category_filter`	`category_filter`	CSV list of categories that will trigger a draw down.
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`draw_down_when`	`draw_down_when`	Generate the draw down when: R -When leave accrual is run. A -When a timesheet is approved.
`grace_days`	`grace_days`	How many days is the grace period before accrued time is lost.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.
`lose_how`	`lose_how`	How is accrued time lost: N -Never A -The users anniversary date Y -End of year
`name`	`name`	[Required] The name for the leave accrual rule.
`notes`	`notes`	Notes associated with the leave accrual rule.
`period`	`period`	The period for the cap.
`project_filter`	`project_filter`	CSV list of projects that will trigger a draw down.
`project_task_filter`	`project_task_filter`	CSV list of project_tasks that will trigger a draw down.
`timetype_filter`	`timetype_filter`	CSV list of timetypes that will trigger a draw down.
`timing`	`timing`	When the accrual is applied: S -start of the period. E -end of the period.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.

XML / SOAP

Database

Description

active

A 1/0 field indicating whether this is an active leave accrual rule. Defaults to 1 if not set when adding a leave accrual rule.

amount

The number of hours per period.

cap

Number of hours to cap the accrual at.

category_filter

CSV list of categories that will trigger a draw down.

created

[Read-only] Time the record was created. See Date Fields.

draw_down_when

Generate the draw down when:

R -When leave accrual is run.
A -When a timesheet is approved.

grace_days

How many days is the grace period before accrued time is lost.

id

[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.

lose_how

How is accrued time lost:

N -Never
A -The users anniversary date
Y -End of year

name

[Required] The name for the leave accrual rule.

notes

Notes associated with the leave accrual rule.

period

The period for the cap.

project_filter

CSV list of projects that will trigger a draw down.

project_task_filter

CSV list of project_tasks that will trigger a draw down.

timetype_filter

CSV list of timetypes that will trigger a draw down.

timing

When the accrual is applied:

S -start of the period.
E -end of the period.

updated

[Read-only] Time the record was last updated or modified. See Date Fields.