Field NationDeveloper Platform
Field NationDeveloper Platform
Overview

Work Orders

List Work Order Bonuses GETCreate Work Order Bonus POSTList Work Order Discounts GETUpdate Work Order Expense PUTList Work Order Expenses GETCreate Work Order Expense POSTGet Work Order Increase GETUpdate Work Order Pay Increase PUTList Work Order Increases GETGet work order pay GETUpdate Work Order Pay PUTList Work Order Penalties GETCreate Work Order Penalty POST

Resources

FinancialsFinances

Update Work Order Pay

Update the pay configuration for a work order. Only provided fields are changed.

PUT
/api/rest/v2/workorders/{work_order_id}/pay

Authorization

access_token
access_token<token>

OAuth 2.0 Access Token

In: query

Path Parameters

work_order_id*integer

Work Order ID

Request Body

application/json

work order pay model

type*string

Pay type

Value in"fixed" | "hourly" | "device" | "blended" | ""
base*

Pay base

additional?

Pay additional

hours?number

Approximate hours to complete

finance?

Pay finance

bonuses?

Bonuses

penalties?

Penalties

curl -X PUT "https://api-sandbox.fndev.net/api/rest/v2/workorders/0/pay" \  -H "Content-Type: application/json" \  -d '{    "type": "fixed",    "base": {      "units": 1,      "amount": 60    },    "hours": 2  }'
{
  "work_order_id": 1001,
  "type": "fixed",
  "base": {
    "units": 0,
    "amount": 0
  },
  "additional": {
    "units": 0,
    "amount": 50
  },
  "fees": [],
  "finance": {
    "id": 123,
    "terms": "string_value",
    "description": "Sample description text.",
    "limit": 0,
    "invoiced_account": true,
    "locked": true
  },
  "hold": {
    "id": 123,
    "amount": 50,
    "charged": true
  },
  "hours": 0,
  "reported_hours": 0,
  "number_of_devices": 0,
  "minimum_payment": 0,
  "range": {
    "min": 0,
    "max": 0
  },
  "labor_sum": 0,
  "fees_cancellation_pending": true,
  "passive_cancellation_amount": 0,
  "fee_cancellation_queued": "string_value",
  "fee_cancellation_charged": "string_value",
  "status_id": "string_value",
  "funding": [],
  "invoice": {
    "id": 123,
    "sent": {
      "utc": "string_value",
      "local": {
        "date": "2025-01-01",
        "time": "12:00:00"
      }
    },
    "paid": {
      "utc": "string_value",
      "local": {
        "date": "2025-01-01",
        "time": "12:00:00"
      }
    }
  },
  "bonuses": {
    "metadata": {
      "total": 100,
      "page": 0,
      "pages": 5,
      "per_page": 20
    },
    "sum": {
      "all": 0,
      "charged": 0,
      "uncharged": 0
    },
    "results": [],
    "actions": []
  },
  "expenses": {
    "metadata": {
      "total": 100,
      "page": 0,
      "pages": 5,
      "per_page": 20
    },
    "sum": {
      "all": 0,
      "charged": 0,
      "uncharged": 0,
      "pending": 0,
      "approved": 0,
      "approved_amount": 0,
      "denied": 0
    },
    "results": [],
    "actions": []
  },
  "penalties": {
    "metadata": {
      "total": 100,
      "page": 0,
      "pages": 5,
      "per_page": 20
    },
    "sum": {
      "all": 0,
      "charged": 0,
      "uncharged": 0
    },
    "results": [],
    "actions": []
  },
  "discounts": {
    "metadata": {
      "total": 100,
      "page": 0,
      "pages": 5,
      "per_page": 20
    },
    "sum": {
      "all": 0
    },
    "results": [],
    "actions": []
  },
  "increases": {
    "metadata": {
      "total": 100,
      "page": 0,
      "pages": 5,
      "per_page": 20
    },
    "sum": {
      "all": 0
    },
    "results": [],
    "actions": [],
    "minimum": 0
  },
  "max_pay": 0,
  "total": 100,
  "max_pay_limit": 0,
  "calculated_total": {
    "total": {
      "min": 0,
      "max": 0
    }
  }
}
{
  "status": 500,
  "message": "Operation successful."
}
{
  "status": 500,
  "message": "Operation successful."
}

Response Body

application/json

application/json

application/json

Last updated on

Get work order pay GET

Previous Page

List Work Order Penalties GET

Next Page

curl -X PUT "https://api-sandbox.fndev.net/api/rest/v2/workorders/0/pay" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "fixed",
    "base": {
      "units": 1,
      "amount": 60
    },
    "hours": 2
  }'