Field NationDeveloper Platform
Field NationDeveloper Platform
IntroductionQuick StartAPI Playground

Getting Started

API Reference

Overview
PayExpensesBonuses & PenaltiesDiscounts & Increases
Work OrdersFinancials

Pay

Managing base pay, fixed and hourly rates.


Pay Structure

The Pay object controls the payment terms for a work order.

Pay Types

Field Nation supports two primary pay models:

Choosing a Model:

  • Fixed Pay: Best for well-defined tasks (e.g., "Replace 1 Screen"). Easier budgeting.
  • Hourly Pay: Best for diagnostics or uncertain scopes. Prevents friction if the job takes longer than expected.

A flat rate for the entire job, regardless of time spent.

"pay": {
  "type": "fixed",
  "base": {
    "amount": 150.00,
    "units": 1
  }
}
  • amount: Total pay in dollars
  • units: Always 1 for fixed pay

A rate per hour, up to a maximum number of hours (capped).

"pay": {
  "type": "hourly",
  "base": {
    "amount": 65.00,
    "units": 4
  }
}
  • amount: Rate per hour
  • units: Maximum hours (cap)

Get Pay Details

GET /workorders/{id}/pay

Response

{
  "type": "hourly",
  "base": {
    "amount": 65.00,
    "units": 4
  },
  "total": {
    "amount": 195.00,
    "hours_worked": 3.0
  },
  "bonuses": [],
  "penalties": [],
  "expenses": {
    "pending": 25.00,
    "approved": 0.00
  }
}

Update Pay

PUT /workorders/{id}

{
  "pay": {
    "type": "fixed",
    "base": { "amount": 200.00 }
  }
}

Pay can only be updated before the work order reaches Work Done status.

Pay Visibility

ViewerCan See
BuyerFull pay breakdown
ProviderTheir rate + earned amount
MarketplaceDisplayed rate for requests

Pay Calculation

The final pay is calculated as:

Final Pay = Base Pay + Bonuses - Penalties + Approved Expenses

For hourly pay, base pay is calculated as:

Base Pay = min(hours_worked, max_hours) × hourly_rate

Related

  • Expenses - Reimbursable costs
  • Bonuses & Penalties - Incentives and deductions
  • Time Logs - Hours affect hourly pay
  • Create Work Order - Setting pay at creation

Last updated on

Compliance

Enforce qualifications and skill requirements on work orders.

Expenses

Managing provider expense claims and reimbursements.

On this page

Pay Structure
Pay Types
Get Pay Details
Response
Update Pay
Pay Visibility
Pay Calculation
Related