Sign in

v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Allowances

Create an allowance

post/allowances

Request body

work_assignment_idstring required

Must belong to a work assignment associated with an entity of type Employee.

business_preset_idstring
allowance_type'automobile_and_motor_vehicle' | 'cell_phone_allowance' | 'child_care_expenses' | 'child_eduction_non_taxable' | 'child_eduction_taxable' | 'clothing_non_taxable' | 'clothing_taxable' | 'education_and_professional_development' | 'housing_allowance_cash' | 'internet_allowance' | 'meals_taxable' | 'moving_allowance_non_taxable' | 'moving_allowance_taxable' | 'municipal_officers_expense' | 'non_taxable_allowance' | 'overtime_meals_non_taxable' | 'parking_allowance' | 'professional_membership' | 'professional_membership_dues_taxable' | 'social_event_allowance' | 'taxable_cash_allowance' | 'tools_allowance' | 'transit_pass' | 'travelling_allowance_non_taxable' | 'travelling_allowance_taxable' | 'utilities_allowance' | 'vehicle_allowance_non_taxable'

The type of allowance, which determines how it is taxed and reported on Pay Stubs.

Must be present when business_preset_id is either empty or not set.

amountnumber required

The monetary amount applied each time this allowance is included on a Pay Stub.

titlestring nullable
frequency'once' | 'per_month' | 'per_payroll' required

The frequency at which this allowance is applied to Pay Stubs. When per_month, the amount is distributed evenly across all Payrolls in the calendar month.

effective_fromstring date required

The date from which this allowance is applied to Pay Stubs.

effective_tostring date

The date after which this allowance is no longer applied. null if the allowance applies indefinitely.

expense_accounting_code_idstring
liability_accounting_code_idstring
external_refstring
date_basis'by_pay_date' | 'by_period_end_date' | 'by_period_start_date'

Which payroll date determines the calendar month for the allocation. Applies only to per_month recurrences.

pay_period_cadenceinteger[]

Which pay periods within the month receive the allocation. An array of 1-based positions; -1 is the final period. Applies only to per_month recurrences.

Response

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

The type of the object in Nmbr ("allowance").