ZUzuper

Get Job Estimated Profit

Changed on

Aggregates profit/revenue/cost across the job's linked estimates (DRAFT, AWAIT_RESPONSE, APPROVED, AWAIT_SIGNATURE). Proposal-type estimates (is_proposal: true) are excluded unless currently APPROVED or were APPROVED at some point in their status history. Returns an all-zero shape (not an error) if no qualifying estimates exist. total_profit_margin is computed as (profit/price)*100, with 0/-100/100 edge cases when price and/or cost are zero. If the job has a profitability field set, a difference object compares it against the computed estimate totals.

get/costing/{job_uid}/estimated_profit

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/costing/{job_uid}/estimated_profit
  • Auth
    API key in header x-api-key

Path parameters

job_uidstring required

Query parameters

estimate_uidstring

Comma-separated list of estimate_uids to restrict the aggregation to. Omit to include all qualifying estimates on the job.

Response

200

typestring
titlestring
messagestring

Example response

{
  "type": "success"
}

Changes