Skip to content
BuildWorkPro Docs

Business review — Sold, Billed, Collected, Owed vs the prior period

GET
/reports/review
 
curl --request GET \
  --url 'https://app.buildworkpro.com/api/v1/reports/review?compare=false' \
  --header 'Authorization: Bearer <token>'

The weekly business review: four scorecard tiles with definitions and honest deltas, plus Money / Sales / Work sections. Role-shaped. Balances are as of date (the caller’s calendar day); flows cover dateFrom–dateTo.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
dateFrom
string format: date-time
dateTo
string format: date-time
date
string
/^\d{4}-\d{2}-\d{2}$/
tz
string
<= 64 characters
preset
string
<= 32 characters
compare
boolean
customerId
integer
> 0
projectId
integer
> 0
estimatorId
integer
> 0
source
string
<= 64 characters
status
string
<= 32 characters
projectType
string
<= 32 characters
includeCompleted
boolean

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Business review

Media type application/json
object
data
required
object
window
required
object
from
required
string
to
required
string
label
required
string
scorecard
required
Array<object>
object
key
required
string
label
required
string
definition
required
string
value
required
string
kind
required
string
Allowed values: money count percent days
detail
string
linkTo
string
delta
object
kind
required
string
Allowed values: percent money
value
required
string
direction
required
string
Allowed values: up down flat
goodWhen
required
string
Allowed values: up down
sections
required
object
key
additional properties
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer
Example 
{
  "data": {
    "scorecard": [
      {
        "kind": "money",
        "delta": {
          "kind": "percent",
          "direction": "up",
          "goodWhen": "up"
        }
      }
    ]
  }
}

403

Section titled “ 403 ”

Error

Media type application/problem+json
object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string
Example generated 
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

422

Section titled “ 422 ”

Error

Media type application/problem+json
object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string
Example generated 
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}