Skip to navigation
API ReferencePayroll

Get LWF Amount

Works out the monthly employee and employer Labour Welfare Fund amounts for a state, as the app does while setting up a salary. Requires Payroll Pro. This is a calculator: it reads no staff data.

  • frequency and deduction_months are null, and is_deferred is false, unless your company uses PT/LWF rule categories.
  • is_deferred true means the fund is charged as a lump sum in the deduction months, so the monthly amounts are 0.00.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

statestringRequired

Full state name. An unknown state returns 400.

total_earningdoubleOptional>=0
Monthly earnings. Optional. Some states work out the amount from it.
rule_categorystringOptional

Rule category to use. Optional. Allowed only when PT/LWF rule categories are switched on for your company. See List PT and LWF Rule Categories.

Response

The LWF amounts for the state.
messagestring
statusboolean
dataobject

Errors

400
Bad Request Error
403
Forbidden Error