Set the proposal eForm
curl --request PUT \
--url https://anzapi.onboardme.app/api/v1/proposals/{key}/eform \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"formTemplateID": 123
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/proposals/{key}/eform"
payload = {
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"formTemplateID": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({userKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a', formTemplateID: 123})
};
fetch('https://anzapi.onboardme.app/api/v1/proposals/{key}/eform', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://anzapi.onboardme.app/api/v1/proposals/{key}/eform",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'userKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'formTemplateID' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://anzapi.onboardme.app/api/v1/proposals/{key}/eform"
payload := strings.NewReader("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"formTemplateID\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://anzapi.onboardme.app/api/v1/proposals/{key}/eform")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"formTemplateID\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/proposals/{key}/eform")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"formTemplateID\": 123\n}"
response = http.request(request)
puts response.read_body{
"engagementKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"statusName": "<string>",
"billingNeedsReview": true,
"pricing": {
"engagementKey": "8f9e2b1c-3d4a-5e6f-7890-abcdef012345",
"name": "FY25 tax engagement – Acme Pty Ltd",
"statusName": "Accepted",
"createBills": true,
"servicesTotal": 2695,
"invoicesTotal": 2695,
"services": [
{
"serviceID": 12040,
"serviceName": "Annual compliance — company",
"price": 2450,
"quantity": 1,
"taxAmount": 245,
"lineTotal": 2695
}
]
},
"section": null
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Proposal updates
Set the proposal eForm
Set or clear the eForm attached to a proposal.
PUT
/
api
/
v1
/
proposals
/
{key}
/
eform
Set the proposal eForm
curl --request PUT \
--url https://anzapi.onboardme.app/api/v1/proposals/{key}/eform \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"formTemplateID": 123
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/proposals/{key}/eform"
payload = {
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"formTemplateID": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({userKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a', formTemplateID: 123})
};
fetch('https://anzapi.onboardme.app/api/v1/proposals/{key}/eform', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://anzapi.onboardme.app/api/v1/proposals/{key}/eform",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'userKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'formTemplateID' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://anzapi.onboardme.app/api/v1/proposals/{key}/eform"
payload := strings.NewReader("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"formTemplateID\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://anzapi.onboardme.app/api/v1/proposals/{key}/eform")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"formTemplateID\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/proposals/{key}/eform")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"formTemplateID\": 123\n}"
response = http.request(request)
puts response.read_body{
"engagementKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"statusName": "<string>",
"billingNeedsReview": true,
"pricing": {
"engagementKey": "8f9e2b1c-3d4a-5e6f-7890-abcdef012345",
"name": "FY25 tax engagement – Acme Pty Ltd",
"statusName": "Accepted",
"createBills": true,
"servicesTotal": 2695,
"invoicesTotal": 2695,
"services": [
{
"serviceID": 12040,
"serviceName": "Annual compliance — company",
"price": 2450,
"quantity": 1,
"taxAmount": 245,
"lineTotal": 2695
}
]
},
"section": null
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
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
Body
application/jsontext/jsonapplication/*+json
Response
OK
Show child attributes
Show child attributes
Example:
{
"engagementKey": "8f9e2b1c-3d4a-5e6f-7890-abcdef012345",
"name": "FY25 tax engagement – Acme Pty Ltd",
"statusName": "Accepted",
"createBills": true,
"servicesTotal": 2695,
"invoicesTotal": 2695,
"services": [
{
"serviceID": 12040,
"serviceName": "Annual compliance — company",
"price": 2450,
"quantity": 1,
"taxAmount": 245,
"lineTotal": 2695
}
]
}