Skip to main content
GET
Get proposal pricing, billing, and jobs

Authorizations

Authorization
string
header
required

Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.

Path Parameters

key
string<uuid>
required

Proposal key (identifier).

Response

OK

engagementKey
string<uuid>
name
string | null
statusID
integer<int32>
statusName
string | null
startDate
string<date-time>
endDate
string<date-time> | null
currencyID
integer<int32>
currencyName
string | null
createBills
boolean
recurringBilling
integer<int32>
createXpmJobs
boolean
createFyiJobs
boolean
servicesTotal
number<double>
invoicesTotal
number<double>
services
object[] | null
invoices
object[] | null
recurringBillings
object[] | null
xpmJobs
object[] | null
fyiJobs
object[] | null