Create pay application (draft)
POST /pay-apps
POST
/pay-apps
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ” Idempotency-Key
string
Request Body
Section titled “Request Body ”object
payAppNumber
string
projectId
required
integer
periodStart
string | null
periodEnd
string | null
contractSum
string | null
changeOrdersTotal
string | null
retainagePercent
string | null
changeOrders
sentAt
string | null
sentBy
integer | null
notes
string | null
Responses
Section titled “ Responses ”Created
object
data
required
object
id
required
integer
payAppNumber
required
string
projectId
required
integer
status
required
string
contractSum
required
string | null
totalCompletedAndStored
required
string | null
retainageAmount
required
string | null
currentPaymentDue
required
string | null
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
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