Navigation :

Penalties

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

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

Penalty Object

Parameter	Type	Example	Mapping/Notes
id	integer	"id": 3	Work Order Penalty ID.
charged	boolean	"charged": false	Penalty applied, true or false.
calculation	string	"calculation": "fixed"	Dollar or Percentage Penalty. Options fixed, percent
modifier	decimal	"modifier": 35	Dollar Amount or Percentage Amount.
name	string	"name": "Dollar Amount Penalty"	Penalty 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

Penalty Object, Dollar Amount

{
   "id":6,
   "charged":false,
   "calculation":"fixed",
   "modifier":10,
   "name":"Dollar Amount Penalty",
   "description":"Example rule explanation.",
   "amount":10,
   "actions":[]
}

Penalty Object, Percentage

{
   "id":7,
   "charged":false,
   "calculation":"percent",
   "modifier":3,
   "name":"Percentage Penalty",
   "description":"Example rule explanation.",
   "amount":12,
   "actions":[]
}

Penalties Response by Company

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

Work Order Penalties Response

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

Penalties Response by Work Order, Percentage

{
    "metadata": {
        "total": 1,
        "per_page": 1,
        "page": 1,
        "pages": 1
    },
    "sum": {
        "all": 12,
        "charged": 0,
        "uncharged": 12
    },
    "results": [
        {
            "id": 7,
            "charged": false,
            "calculation": "percent",
            "modifier": 3,
            "name": "Percentage Penalty",
            "description": "Example rule explanation.",
            "amount": 12,
            "actions": []
        }
    ],
    "actions": [
        "add"
    ]
}