Skip to navigation
API ReferencePayroll

List PF Options

Returns the PF contribution options, and which ones a salary structure for a month can use. Requires Payroll Pro. Not paginated.

  • value uses the same names as employee_pf in List Salary Templates.
  • wage_ceiling and max_amount are 2-decimal strings, or null when uncapped.
  • Options not offered for the month have is_selectable false. They are still listed so saved ones can be labelled.

Authentication

AuthorizationApi-Key

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

Query parameters

monthstringOptional

Month to return the options for, YYYY-MM. Optional. Without it, the options offered today.

Response

PF options for the month.
messagestring
statusboolean
dataobject

Errors

400
Bad Request Error
403
Forbidden Error