Aggregate pay-app totals and breakdown by status

GET

/pay-apps/summary

• Production

Returns totals (count, invoiced_total, paid_total, outstanding_total) plus a breakdown by status. Money values are decimal strings. Date filter applies to submittedAt.

Authorizations

• bearerAuth
  pay_apps:read

Parameters

Query Parameters

dateFrom

string format: date-time

dateTo

string format: date-time

projectId

integer

> 0

Responses

200

Pay-app summary

object

data

required

object

totals

required

object

count

required

integer

invoiced_total

required

string

paid_total

required

string

outstanding_total

required

string

by_status

required

Array<object>

object

status

required

string

count

required

integer

current_billed_total

required

string

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

403

Error

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

422

Error

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