Pay Rates
The pay object supports Fixed Pay, Per Hour, Per Device, and Blended pay rate options. Below is a list of parameters, along with a JSON example for each option.
Fixed Pay Object
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| type | string | "type": "fixed" | Payment > Fixed Pay. |
| base | object | “base”: { } | Includes amount and units. |
| amount | decimal | “amount”:400 | The total dollar amount. |
| units | integer | “units”:1 | For Fixed Pay, units will always be 1. |
Fixed Pay Examples
Pay Object, Fixed Pay
{
"work_order_id": 4047,
"type": "fixed",
"base": {
"units": 1,
"amount": 400
},
"additional": {
"units": 0,
"amount": 0
},
"hold": {
"id": 0,
"amount": 0,
"charged": false
},
"fees": [
{
"name": "cancellation",
"id": 0,
"amount": 0,
"queued": false,
"charged": false,
"hours24_applicable": false,
"calculation": "fixed",
"at_risk": false
},
{
"name": "flat",
"amount": 0,
"charged": false
},
{
"name": "buyer",
"amount": 0,
"calculation": "percent",
"modifier": 0,
"charged": false,
"undetermined_service_fee": false,
"min_amount": 0,
"max_amount": 0
}
],
"payment": {
"id": 0,
"amount": 0,
"charged": false,
"date": {
"utc": "",
"local": {
"date": "",
"time": ""
}
}
},
"finance": {
"id": 0,
"terms": "",
"description": "Default",
"limit": 0
},
"can_view": true,
"reported_hours": 0,
"number_of_devices": 0,
"minimum_payment": 20,
"range": {
"min": 400,
"max": 400
},
"actions": [
"edit"
],
"labor_sum": 400,
"fees_cancellation_pending": false,
"passive_cancellation_amount": 30,
"fee_cancellation_queued": "0",
"fee_cancellation_charged": "0",
"funding": [
{
"id": 0,
"name": "Pre-fund",
"amount": 8740,
"custom_name": "Pre-fund | Available: $8,740.00"
}
],
"correlation_id": "62fe5768a4d2162185d81a4eaa36d18a81fcbd31",
"bonuses": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0,
"charged": 0,
"uncharged": 0
},
"results": [],
"actions": [
"add"
]
},
"penalties": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0,
"charged": 0,
"uncharged": 0
},
"results": [],
"actions": [
"add"
]
},
"discounts": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0
},
"results": [],
"actions": []
},
"expenses": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0,
"charged": 0,
"uncharged": 0
},
"results": [],
"actions": [
"add"
]
},
"increases": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"minimum": 20,
"sum": {
"all": 0
},
"results": [],
"actions": []
},
"pricing_insights": {
"region": {
"name": "Minneapolis, MN",
"id": 1453,
"distance": 0.0013742820998470138
},
"providers": {
"marketplace": 51
},
"average_rate": {
"first_quartile": 0,
"median": 0,
"third_quartile": 0
},
"average_fixed_rate": {
"first_quartile": 0,
"median": 0,
"third_quartile": 0
},
"comparison": ""
},
"max_pay": 400,
"total": 400,
"calculated_total": {
"total": {
"min": 400,
"max": 400
}
},
"fn_process_payment": "1"
}
Create Work Order, Fixed Pay
Total amount: $400.
"pay":{
"type":"fixed",
"base":{
"amount":400,
"units":1
}
}Per Hour Object
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| type | string | "type": "hourly" | Payment > Per Hour. |
| base | object | “base”: { } | Includes amount and units. |
| amount | decimal | “amount”:25 | Hourly amount. |
| units | integer | “units”:4 | Max hours. |
Per Hour Examples
Pay Object, Hourly
{
"work_order_id": 1653,
"type": "hourly",
"base": {
"units": 4,
"amount": 12
},
"additional": {
"units": 0,
"amount": 0
},
"hold": {
"id": 0,
"amount": 0,
"charged": false
},
"fees": [
{
"name": "cancellation",
"id": 0,
"amount": 0,
"queued": false,
"charged": false,
"hours24_applicable": false,
"calculation": "fixed",
"at_risk": false
},
{
"name": "flat",
"amount": 0,
"charged": false
},
{
"name": "buyer",
"amount": 0,
"calculation": "percent",
"modifier": 0,
"charged": false,
"undetermined_service_fee": false,
"min_amount": 0,
"max_amount": 0
}
],
"payment": {
"id": 0,
"amount": 0,
"charged": false,
"date": {
"utc": "",
"local": {
"date": "",
"time": ""
}
}
},
"finance": {
"id": 0,
"terms": "",
"description": "Default",
"limit": 0
},
"can_view": true,
"reported_hours": 0,
"number_of_devices": 0,
"minimum_payment": 20,
"range": {
"min": 12,
"max": 48
},
"actions": [
"edit"
],
"labor_sum": 12,
"fees_cancellation_pending": false,
"passive_cancellation_amount": 30,
"fee_cancellation_queued": "0",
"fee_cancellation_charged": "0",
"funding": [
{
"id": 0,
"name": "Pre-fund",
"amount": 10000,
"custom_name": "Pre-fund | Available: $10,000.00"
}
],
"correlation_id": "278d66b013023f5d46c0478a050c9a165f947c42",
"bonuses": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0,
"charged": 0,
"uncharged": 0
},
"results": [],
"actions": [
"add"
]
},
"penalties": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0,
"charged": 0,
"uncharged": 0
},
"results": [],
"actions": [
"add"
]
},
"discounts": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0
},
"results": [],
"actions": []
},
"expenses": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0,
"charged": 0,
"uncharged": 0
},
"results": [],
"actions": [
"add"
]
},
"increases": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"minimum": 20,
"sum": {
"all": 0
},
"results": [],
"actions": []
},
"pricing_insights": {
"region": {
"name": "Phoenix, AZ",
"id": 1380,
"distance": 0.009667828496366772
},
"providers": {
"marketplace": 27
},
"average_rate": {
"first_quartile": 47,
"median": 55,
"third_quartile": 62
},
"average_fixed_rate": {
"first_quartile": 0,
"median": 0,
"third_quartile": 0
},
"comparison": "negative"
},
"max_pay": 48,
"total": 12,
"calculated_total": {
"total": {
"min": 12,
"max": 48
}
},
"fn_process_payment": "1"
}
Create Work Order, Per Hour
Hourly amount: $25 / Max hours: 4.
"pay":{
"type":"hourly",
"base":{
"amount":25,
"units":4
}
}Per Device Object
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| type | string | "type": "device" | Payment > Per Device. |
| base | object | “base”: { } | Includes amount and units. |
| amount | decimal | “amount”:400 | Pay per device. |
| units | integer | “units”:2 | Max devices. |
Per Device Examples
Pay Object, Per Device
{
"work_order_id": 4049,
"type": "device",
"base": {
"units": 2,
"amount": 400
},
"additional": {
"units": 0,
"amount": 0
},
"hold": {
"id": 0,
"amount": 0,
"charged": false
},
"fees": [
{
"name": "cancellation",
"id": 0,
"amount": 0,
"queued": false,
"charged": false,
"hours24_applicable": false,
"calculation": "fixed",
"at_risk": false
},
{
"name": "flat",
"amount": 0,
"charged": false
},
{
"name": "buyer",
"amount": 0,
"calculation": "percent",
"modifier": 0,
"charged": false,
"undetermined_service_fee": false,
"min_amount": 0,
"max_amount": 0
}
],
"payment": {
"id": 0,
"amount": 0,
"charged": false,
"date": {
"utc": "",
"local": {
"date": "",
"time": ""
}
}
},
"finance": {
"id": 0,
"terms": "",
"description": "Default",
"limit": 0
},
"can_view": true,
"reported_hours": 0,
"number_of_devices": 0,
"minimum_payment": 20,
"range": {
"min": 400,
"max": 800
},
"actions": [
"edit"
],
"labor_sum": 400,
"fees_cancellation_pending": false,
"passive_cancellation_amount": 30,
"fee_cancellation_queued": "0",
"fee_cancellation_charged": "0",
"funding": [
{
"id": 0,
"name": "Pre-fund",
"amount": 8740,
"custom_name": "Pre-fund | Available: $8,740.00"
}
],
"correlation_id": "2dd4ab78eb88b32fea11596a606b93e9aa3c2cd2",
"bonuses": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0,
"charged": 0,
"uncharged": 0
},
"results": [],
"actions": [
"add"
]
},
"penalties": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0,
"charged": 0,
"uncharged": 0
},
"results": [],
"actions": [
"add"
]
},
"discounts": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0
},
"results": [],
"actions": []
},
"expenses": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0,
"charged": 0,
"uncharged": 0
},
"results": [],
"actions": [
"add"
]
},
"increases": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"minimum": 20,
"sum": {
"all": 0
},
"results": [],
"actions": []
},
"pricing_insights": {
"region": {
"name": "Minneapolis, MN",
"id": 1453,
"distance": 0.0013742820998470138
},
"providers": {
"marketplace": 51
},
"average_rate": {
"first_quartile": 0,
"median": 0,
"third_quartile": 0
},
"average_fixed_rate": {
"first_quartile": 0,
"median": 0,
"third_quartile": 0
},
"comparison": ""
},
"max_pay": 800,
"total": 400,
"calculated_total": {
"total": {
"min": 400,
"max": 800
}
},
"fn_process_payment": "1"
}
Create Work Order, Per Device
Pay per device: $400 / Max devices: 2.
"pay":{
"type":"device",
"base":{
"amount":400,
"units":2
}
}Blended Pay Object
| Parameter | Type | Example | Mapping/Notes |
|---|---|---|---|
| type | string | "type": "blended" | Payment > Blended. |
| base | object | "base": { } | Includes amount and units. |
| amount | decimal | "amount":400 | Total Fixed pay for the first x hours. |
| units | integer | "units":2 | First x Hours. |
| additional | object | "additional": { } | Includes amount and units. |
| amount | decimal | "amount":25 | Hourly rate. |
| units | integer | "units":1 | Additional Hours (after x hours). |
Blended Pay Examples
Pay Object, Blended Pay
{
"work_order_id": 4050,
"type": "blended",
"base": {
"units": 2,
"amount": 400
},
"additional": {
"units": 1,
"amount": 25
},
"hold": {
"id": 0,
"amount": 0,
"charged": false
},
"fees": [
{
"name": "cancellation",
"id": 0,
"amount": 0,
"queued": false,
"charged": false,
"hours24_applicable": false,
"calculation": "fixed",
"at_risk": false
},
{
"name": "flat",
"amount": 0,
"charged": false
},
{
"name": "buyer",
"amount": 0,
"calculation": "percent",
"modifier": 0,
"charged": false,
"undetermined_service_fee": false,
"min_amount": 0,
"max_amount": 0
}
],
"payment": {
"id": 0,
"amount": 0,
"charged": false,
"date": {
"utc": "",
"local": {
"date": "",
"time": ""
}
}
},
"finance": {
"id": 0,
"terms": "",
"description": "Default",
"limit": 0
},
"can_view": true,
"reported_hours": 0,
"number_of_devices": 0,
"minimum_payment": 20,
"range": {
"min": 400,
"max": 425
},
"actions": [
"edit"
],
"labor_sum": 400,
"fees_cancellation_pending": false,
"passive_cancellation_amount": 30,
"fee_cancellation_queued": "0",
"fee_cancellation_charged": "0",
"funding": [
{
"id": 0,
"name": "Pre-fund",
"amount": 8740,
"custom_name": "Pre-fund | Available: $8,740.00"
}
],
"correlation_id": "2bd07bc72a6fd8d06a2dc70fde17d0daf7584d59",
"bonuses": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0,
"charged": 0,
"uncharged": 0
},
"results": [],
"actions": [
"add"
]
},
"penalties": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0,
"charged": 0,
"uncharged": 0
},
"results": [],
"actions": [
"add"
]
},
"discounts": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0
},
"results": [],
"actions": []
},
"expenses": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"sum": {
"all": 0,
"charged": 0,
"uncharged": 0
},
"results": [],
"actions": [
"add"
]
},
"increases": {
"metadata": {
"total": 0,
"per_page": 0,
"page": 1,
"pages": 1
},
"minimum": 20,
"sum": {
"all": 0
},
"results": [],
"actions": []
},
"pricing_insights": {
"region": {
"name": "Minneapolis, MN",
"id": 1453,
"distance": 0.0013742820998470138
},
"providers": {
"marketplace": 51
},
"average_rate": {
"first_quartile": 0,
"median": 0,
"third_quartile": 0
},
"average_fixed_rate": {
"first_quartile": 0,
"median": 0,
"third_quartile": 0
},
"comparison": ""
},
"max_pay": 425,
"total": 400,
"calculated_total": {
"total": {
"min": 400,
"max": 425
}
},
"fn_process_payment": "1"
}
Create Work Order, Blended Pay
Pay $400 total for the first 2 hours / and then $25 per hour for up to 1 additional hours.
"pay":{
"type":"blended",
"base":{
"amount":400,
"units":2
},
"additional":{
"amount":25,
"units":1
}
}