---
title: "Aggregate pay-app totals and breakdown by status"
method: GET
path: "/pay-apps/summary"
tags: ["PayApps"]
---

# Aggregate pay-app totals and breakdown by status

`GET /pay-apps/summary`

## Request

- Base URL: `https://app.buildworkpro.com/api/v1`
- URL: `https://app.buildworkpro.com/api/v1/pay-apps/summary`
- Auth: HTTP bearer

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

## Query parameters

- `dateFrom` string, date-time
- `dateTo` string, date-time
- `projectId` integer

## Response `200`

Pay-app summary

- object
  - `data` object, required
    - `totals` object, required
      - `count` integer, required
      - `invoiced_total` string, required
      - `paid_total` string, required
      - `outstanding_total` string, required
    - `by_status` object[], required
      - `status` string, required
      - `count` integer, required
      - `current_billed_total` string, required
  - `meta` ResponseMeta, required
    - `request_id` string: Server-generated request identifier
    - `pagination` PaginationMeta
      - `cursor` string, nullable, required: Opaque cursor for the next page; null when no more results
      - `has_more` boolean, required: Whether more pages are available after this one
      - `count` integer, required: Items in this page

## Other responses

- `403`: Error
- `422`: Error

---

[API](https://skmtc.dev/buildworkpro/apis/buildworkpro-api.md) · [All operations](https://skmtc.dev/buildworkpro/apis/buildworkpro-api/llms.txt) · [OpenAPI document](https://skmtc.dev/buildworkpro/apis/buildworkpro-api/revisions/441cf40012f7?raw)