List Employee Payout Fields

---

GET /services/api/v1/employee_payout_fields

Returns a list of employee payout fields.

Response

200

Results list.

Example

{
  "entries": [
    {
      "id": "RrB7LYD2",
      "type_of": "gross",
      "accessor": "gross",
      "name_de": "Bruttogebetrag",
      "name_it": "Importo lordo",
      "name_en": "Gross amount",
      "hint_de": null,
      "hint_it": null,
      "hint_en": null,
      "placeholder_de": null,
      "placeholder_it": null,
      "placeholder_en": null,
      "values": null
    },
    {
      "id": "R5BPAYxp",
      "type_of": "text",
      "accessor": "cf_43324",
      "name_de": "Sehr wichtiger Code",
      "name_it": "Codice molto importante",
      "name_en": "Very important code",
      "hint_de": null,
      "hint_it": null,
      "hint_en": null,
      "placeholder_de": null,
      "placeholder_it": null,
      "placeholder_en": null,
      "values": [
        {
          "id": "code_a",
          "label_de": "Code A",
          "label_it": "Codice A",
          "label_en": "Code A"
        },
        {
          "id": "code_b",
          "label_de": "Code B",
          "label_it": "Codice B",
          "label_en": "Code B"
        },
        {
          "id": "code_c",
          "label_de": "Code C",
          "label_it": "Codice C",
          "label_en": "Code C"
        },
        {
          "id": "code_unknown",
          "label_de": "Unbekannter Code",
          "label_it": "Codice sconosciuto",
          "label_en": "Unknown code"
        }
      ]
    }
  ],
  "current_page": 1,
  "per_page": 30,
  "total_entries": 2
}

Schema

Attribute	Type	Description
id	string	Employee payout field id.
type_of	string	Type of the employee payout field.
accessor	string	Accessor for the employee payout field.
name_{locale}	string	Name of the employee payout field in all locales of the business.
hint_{locale}	string	Hint for the employee payout field in all locales of the business.
placeholder_{locale}	string	Placeholder for the employee payout field in all locales of the business.
values	json[]	Possible values for the employee payout field as seen in the values table below.

Values

"values": [
  {
    "id": "unknown",
    "label_de": "-",
    "label_it": "-",
    "label_en": "-",
  },
  {
    "id": "c1",
    "label_de": "C1 (ehemals A)",
    "label_it": "C1 (ex A)",
    "label_en": "C1 (formerly A)",
  },
  ...
]

Attribute	Type	Description
id	string	The identifier of the value
label_{locale}	string	Label of the employee payout field value in all locales of the business.

Employee Payout Field Types

Employee Payout Field Type	Type	Accessor	Description
text	string	cf_{number}	Short text string.
currency	float	cf_{number}	Float number input. Rounded to 2 decimals.
integer	integer	cf_{number}	Integer input.
float	integer	cf_{number}	Float input.
select_single	string	cf_{number}	Single value dropdown. Possible values are provided in the 'values' field.
select_multiple	string[]	cf_{number}	Multi value dropdown. Possible values are provided in the 'values' field.
select_radio	string	cf_{number}	Radio button select. Possible values are provided in the 'values' field.
checkbox	boolean	cf_{number}	Simple checkbox.
date	string	cf_{number}	Date field for ISO 8601 timestamps.
datetime	string	cf_{number}	Datetime field for ISO 8601 datetime-timestamps.
notes	string	notes	Text input field.
gross	float	gross	Gross payout.
net	float	net	Net payout.