---
title: "Update draft pay application"
method: PATCH
path: "/pay-apps/{id}"
tags: ["PayApps"]
---

# Update draft pay application

`PATCH /pay-apps/{id}`

## Request

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

## Path parameters

- `id` integer, required

## Headers

- `Idempotency-Key` string, uuid

## Request body

- object
  - `payAppNumber` string
  - `projectId` integer
  - `periodStart` string, nullable: Calendar day, YYYY-MM-DD. A datetime is accepted and read as the day it names.
  - `periodEnd` string, nullable: Calendar day, YYYY-MM-DD. A datetime is accepted and read as the day it names.
  - `contractSum` string, nullable
  - `changeOrdersTotal` string, nullable
  - `retainagePercent` string, nullable
  - `includeNotary` boolean
  - `changeOrders` union
    - string
    - number
    - boolean
    - object
    - unknown[]
      - unknown
  - `voidedBy` integer, nullable
  - `voidedAt` string, nullable
  - `voidReason` string, nullable
  - `sentAt` string, nullable
  - `sentBy` integer, nullable
  - `notes` string, nullable

## Response `200`

Updated

- object
  - `data` PayApp, required
    - `id` integer, required
    - `payAppNumber` string, required
    - `projectId` integer, required
    - `status` string, required
    - `periodStart` string, date, nullable, required
    - `periodEnd` string, date, nullable, required
    - `contractSum` string, nullable, required
    - `changeOrdersTotal` string, nullable, required
    - `revisedContractSum` string, nullable, required
    - `previouslyBilled` string, nullable, required
    - `currentBilled` string, nullable, required
    - `materialsStored` string, nullable, required
    - `totalCompleted` string, nullable, required
    - `retainagePercent` string, nullable, required
    - `retainageAmount` string, nullable, required
    - `currentPaymentDue` string, nullable, required
    - `notes` string, nullable
    - `includeNotary` boolean: Print the notary acknowledgment block on the pay application PDF. Defaults to true.
    - `createdAt` union, required
      - string, date-time
      - string
    - `updatedAt` union, required
      - string, date-time
      - string
  - `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

- `404`: Error
- `409`: 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)