Skip to main content
POST
Create an adhoc proposal

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.

Body

userKey
string<uuid>
entityKey
string<uuid>
sendToClient
boolean
name
string | null
note
string | null
startDate
string<date-time> | null
endDate
string<date-time> | null
startOnAcceptance
boolean | null
currencyID
integer<int32> | null
lengthID
integer<int32> | null
terms
integer<int32> | null
refNo
string | null
services
object[] | null
xpmJobs
object[] | null
fyiJobs
object[] | null
invoices
object[] | null
recurringBillings
object[] | null
requestPaymentDetails
boolean
paymentDetailsType
integer<int32> | null
sendSms
boolean | null
expiryDate
string<date-time> | null
identityVerification
boolean
verificationMethod
string | null
identityPeople
object[] | null
onboarding
object

Response

OK

engagementKey
string<uuid>
sentToClient
boolean