Navigation :
Update Pay
Updates pay rate by work order id.
URLS
Environment |
Method |
URL |
Sandbox |
|
https://api-sandbox.fndev.net/api/rest/v2/workorders/work_order_id/pay |
Production |
|
https://api.fieldnation.com/api/rest/v2/workorders/work_order_id/pay |
Path Parameters
Parameter |
Type |
Example |
Notes |
work_order_id |
integer
|
1753 |
Work Order ID.
|
Query Parameters
Parameter |
Type |
Example |
Notes |
access_token |
string
|
abc123defg459hijk786lmn45 |
Required. |
Body Parameters
Body parameters will vary depending on your pay rate type. Refer to Pay Rates for parameter details.
Note: Make sure to pass the base and additional objects to clear out any existing pay options.
Examples
Fixed Pay
Total amount: $400.
{
"type":"fixed",
"base":{
"amount":"300",
"units":1
},
"additional":{
"amount":0,
"units":0
}
}
Hourly
Hourly amount: $25 / Max hours: 4.
{
"type":"hourly",
"base":{
"amount":25,
"units":4
},
"additional":{
"amount":0,
"units":0
}
}
Per Device
Pay per device: $400 / Max devices: 2.
{
"type":"device",
"base":{
"amount":400,
"units":2
},
"additional":{
"amount":0,
"units":0
}
}
Blended Pay
Pay $400 total for the first 2 hours / and then $25 per hour for up to 1 additional hours.
{
"type":"blended",
"base":{
"amount":400,
"units":2
},
"additional":{
"amount":25,
"units":1
}
}
Response
Returns the Pay Response by Work Order. Refer to Pay for parameter details and examples.
Errors
Standard HTTP and OAuth error codes.
Examples
400 Bad Request: Invalid Work Order ID.
{
"status_code": 400,
"message": "(401) Unauthorized"
}