Skip to main content
POST
Gaps

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required
Pattern: ^[1-9]\d{0,18}$
projectId
string
required
Pattern: ^[1-9]\d{0,18}$

Body

application/json
budgetVersion
required
Available options:
live
scopeKey
required
Available options:
project:total
comparison
enum<string>
required
Available options:
planning_itemized,
planning_specified,
planning_purchase,
itemized_specified,
itemized_purchase,
specified_purchase,
default_effective,
margin_specified,
margin_purchase
side
enum<string>
required
Available options:
cost,
client
origin
enum<string>
Available options:
pricing
issue
enum<string>
Available options:
overrun,
incomplete,
shortfall
filters
object
cursor
string
Required string length: 1 - 2048
limit
integer
default:20
Required range: 1 <= x <= 100
expectedComparison
object
expectedRevision
string
Pattern: ^[A-Za-z0-9_-]{43}$

Response

200 - application/json
budgetVersion
object
required
scope
object
required
comparison
enum<string>
required
Available options:
planning_itemized,
planning_specified,
planning_purchase,
itemized_specified,
itemized_purchase,
specified_purchase,
default_effective,
margin_specified,
margin_purchase
side
enum<string>
required
Available options:
cost,
client
summary
object
required
items
object[]
required
matchedCount
number
required
totalCount
number
required
nextCursor
string | null
required
hasMore
boolean
required
computedAt
string
required
freshness
enum<string>
required
Available options:
live
revision
string
required
changed
boolean
required
reconciliation
object
required