Record a crew payout

Records what a crew is owed for a completed work order. Pass work_order_id at the top level of the body, and amount (in dollars) and an optional pay_method inside a crew_payout object.

  • The work order must be completed, must have a crew assigned, and must not already have a payout. The payout is made out to the work order's crew.
  • amount must be greater than zero. pay_method is flat, per_square or per_line_item.
  • New payouts start with status owed. If the work order or amount does not qualify, the request returns 422 with an errors list.
  • The token's role must have the Work production jobs or Manage payroll permission, and the token needs the write scope.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
crew_payout
object
Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json