Skip to content
BuildWorkPro Docs

Create pay application (draft)

POST
/pay-apps
 
curl --request POST \
  --url https://app.buildworkpro.com/api/v1/pay-apps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "payAppNumber": "example", "projectId": 1, "periodStart": "example", "periodEnd": "example", "contractSum": "example", "changeOrdersTotal": "example", "retainagePercent": "example", "includeNotary": true, "changeOrders": { "additionalProperty": "example" }, "voidedBy": 1, "voidedAt": "example", "voidReason": "example", "sentAt": "example", "sentBy": 1, "notes": "example" }'

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “ Header Parameters ”
Idempotency-Key
string format: uuid
<= 255 characters

Idempotent retry key for mutating operations. The first request with a given key executes normally and BuildWorkPro caches the response. Replaying the same key with the same request body (method + path + JSON body, SHA-256 hashed) returns the cached response without re-executing the mutation. Replaying with a DIFFERENT body returns 409 idempotency_key_reused. The cache TTL is 24 hours; after expiry the key is treated as a new operation. Keys are tenant-scoped. Recommended: a fresh UUID v4 per logical operation.

Request Body

Section titled “ Request Body ”
Media type application/json
object
payAppNumber
string
projectId
required
integer
>= -2147483648 <= 2147483647
periodStart
string | null
periodEnd
string | null
contractSum
string | null
changeOrdersTotal
string | null
retainagePercent
string | null
includeNotary
boolean
changeOrders
Any of:
string
voidedBy
integer | null
>= -2147483648 <= 2147483647
voidedAt
string | null
voidReason
string | null
sentAt
string | null
sentBy
integer | null
>= -2147483648 <= 2147483647
notes
string | null
Example generated 
{
  "payAppNumber": "example",
  "projectId": 1,
  "periodStart": "example",
  "periodEnd": "example",
  "contractSum": "example",
  "changeOrdersTotal": "example",
  "retainagePercent": "example",
  "includeNotary": true,
  "changeOrders": {
    "additionalProperty": "example"
  },
  "voidedBy": 1,
  "voidedAt": "example",
  "voidReason": "example",
  "sentAt": "example",
  "sentBy": 1,
  "notes": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

Created

Media type application/json
object
data
required
object
id
required
integer
payAppNumber
required
string
projectId
required
integer
status
required
string
periodStart
required
Any of:
string format: date-time
periodEnd
required
Any of:
string format: date-time
contractSum
required
string | null
changeOrdersTotal
required
string | null
revisedContractSum
required
string | null
previouslyBilled
required
string | null
currentBilled
required
string | null
materialsStored
required
string | null
totalCompleted
required
string | null
retainagePercent
required
string | null
retainageAmount
required
string | null
currentPaymentDue
required
string | null
notes
string | null
includeNotary

Print the notary acknowledgment block on the pay application PDF. Defaults to true.

boolean
createdAt
required
Any of:
string format: date-time
updatedAt
required
Any of:
string format: date-time
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 generated 
{
  "data": {
    "id": 1,
    "payAppNumber": "example",
    "projectId": 1,
    "status": "example",
    "periodStart": "2026-04-15T12:00:00Z",
    "periodEnd": "2026-04-15T12:00:00Z",
    "contractSum": "example",
    "changeOrdersTotal": "example",
    "revisedContractSum": "example",
    "previouslyBilled": "example",
    "currentBilled": "example",
    "materialsStored": "example",
    "totalCompleted": "example",
    "retainagePercent": "example",
    "retainageAmount": "example",
    "currentPaymentDue": "example",
    "notes": "example",
    "includeNotary": true,
    "createdAt": "2026-04-15T12:00:00Z",
    "updatedAt": "2026-04-15T12:00:00Z"
  },
  "meta": {
    "request_id": "example",
    "pagination": {
      "cursor": "example",
      "has_more": true,
      "count": 1
    }
  }
}

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"
    }
  ]
}