Navigation :

Bonuses

A bonus object includes the total sum of all bonuses, the bonus amount, and bonus name and description. You can manage bonuses from Company Settings > Payments > Bonuses and Penalties. The table below describes each parameter in the bonuses results and how it maps to the Field Nation Platform.

Note: You can only add a bonus when a work order is in Draft status.

Bonus Object

Parameter	Type	Example	Mapping/Notes
id	integer	"id": 3	Work Order Bonus ID.
charged	boolean	"charged": false	Bonus applied, true or false.
calculation	string	"calculation": "fixed"	Dollar or Percentage Bonus. Options fixed, percent
modifier	decimal	"modifier": 35	Dollar Amount or Percentage Amount.
name	string	"name": "Dollar Amount Bonus"	Bonus Name.
description	string	"description": "Example rule explanation."	Rule Explanation.
amount	decimal	"amount": 35	If percentage, this is the calculated dollar amount based on total pay.

Examples

Bonus Object, Dollar Amount

{
   "id": 3,
   "charged": false,
   "calculation": "fixed",
   "modifier": 35,
   "name": "Dollar Amount Bonus",
   "description": "Example rule explanation.",
   "amount": 35,
   "actions": []
}

Bonus Object, Percentage

{
   "id":4,
   "charged":false,
   "calculation":"percent",
   "modifier":2,
   "name":"Percentage Bonus",
   "description":"Example rule explanation.",
   "amount":8,
   "actions":[]
}

Bonus Response by Company

{
    "actions": [],
    "metadata": {
        "total": 2,
        "page": 1,
        "pages": 1,
        "per_page": 25,
        "columns": "bonus_id:175,modifier:175,type:175,name:175,description:175",
        "view": "list",
        "sort": "",
        "order": "asc",
        "list": "bonuses",
        "available_columns": [],
        "available_filters": []
    },
    "params": [],
    "lists": [],
    "results": [
        {
            "id": 3,
            "name": "Dollar Amount Bonus",
            "type": "Fixed",
            "modifier": "35",
            "description": "Example rule explanation."
        },
        {
            "id": 4,
            "name": "Percentage Bonus",
            "type": "Percent",
            "modifier": "2",
            "description": "Example rule explanation."
        }
    ],
    "correlation_id": "bonuses"
}

Work Order Bonuses Response

You can locate bonuses in the work order > pay object. Refer to Pay for more information.

Bonuses Response by Work Order

{
    "metadata": {
        "total": 2,
        "per_page": 2,
        "page": 1,
        "pages": 1
    },
    "sum": {
        "all": 43,
        "charged": 0,
        "uncharged": 43
    },
    "results": [
        {
            "id": 3,
            "charged": false,
            "calculation": "fixed",
            "modifier": 35,
            "name": "Dollar Amount Bonus",
            "description": "Example rule explanation.",
            "amount": 35,
            "actions": []
        },
        {
            "id": 4,
            "charged": false,
            "calculation": "percent",
            "modifier": 2,
            "name": "Percentage Bonus",
            "description": "Example rule explanation.",
            "amount": 8,
            "actions": []
        }
    ],
    "actions": [
        "add"
    ]
}