Edit proposal details
curl --request PATCH \
--url https://anzapi.onboardme.app/api/v1/proposals/{key}/details \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"note": "<string>",
"welcomeMessageID": 123,
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"startOnAcceptance": true,
"currencyID": 123,
"lengthID": 123,
"expiryDate": "2023-11-07T05:31:56Z",
"terms": 123,
"termsDetailsOverride": "<string>",
"stpID": 123,
"stpDetailsOverride": "<string>",
"documents": [
{
"documentID": 123,
"detailsOverride": "<string>"
}
],
"attachmentID": 123,
"coverPageID": 123,
"emailSubject": "<string>",
"emailContent": "<string>",
"packages": [
{
"packageNumber": 123,
"name": "<string>",
"price": 123,
"text": "<string>"
}
],
"popularPackage": 123,
"showServiceMenu": true,
"serviceGrouping": 123,
"sendSms": true,
"requestPaymentDetails": true,
"paymentDetailsType": 123,
"payerID": "<string>",
"businessSignatoryUserKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": true,
"approverUserKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"includeCdd": true
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/proposals/{key}/details"
payload = {
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"note": "<string>",
"welcomeMessageID": 123,
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"startOnAcceptance": True,
"currencyID": 123,
"lengthID": 123,
"expiryDate": "2023-11-07T05:31:56Z",
"terms": 123,
"termsDetailsOverride": "<string>",
"stpID": 123,
"stpDetailsOverride": "<string>",
"documents": [
{
"documentID": 123,
"detailsOverride": "<string>"
}
],
"attachmentID": 123,
"coverPageID": 123,
"emailSubject": "<string>",
"emailContent": "<string>",
"packages": [
{
"packageNumber": 123,
"name": "<string>",
"price": 123,
"text": "<string>"
}
],
"popularPackage": 123,
"showServiceMenu": True,
"serviceGrouping": 123,
"sendSms": True,
"requestPaymentDetails": True,
"paymentDetailsType": 123,
"payerID": "<string>",
"businessSignatoryUserKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": True,
"approverUserKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"includeCdd": True
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
note: '<string>',
welcomeMessageID: 123,
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
startOnAcceptance: true,
currencyID: 123,
lengthID: 123,
expiryDate: '2023-11-07T05:31:56Z',
terms: 123,
termsDetailsOverride: '<string>',
stpID: 123,
stpDetailsOverride: '<string>',
documents: [{documentID: 123, detailsOverride: '<string>'}],
attachmentID: 123,
coverPageID: 123,
emailSubject: '<string>',
emailContent: '<string>',
packages: [{packageNumber: 123, name: '<string>', price: 123, text: '<string>'}],
popularPackage: 123,
showServiceMenu: true,
serviceGrouping: 123,
sendSms: true,
requestPaymentDetails: true,
paymentDetailsType: 123,
payerID: '<string>',
businessSignatoryUserKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
requiresApproval: true,
approverUserKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
includeCdd: true
})
};
fetch('https://anzapi.onboardme.app/api/v1/proposals/{key}/details', 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}/details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'userKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'note' => '<string>',
'welcomeMessageID' => 123,
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'startOnAcceptance' => true,
'currencyID' => 123,
'lengthID' => 123,
'expiryDate' => '2023-11-07T05:31:56Z',
'terms' => 123,
'termsDetailsOverride' => '<string>',
'stpID' => 123,
'stpDetailsOverride' => '<string>',
'documents' => [
[
'documentID' => 123,
'detailsOverride' => '<string>'
]
],
'attachmentID' => 123,
'coverPageID' => 123,
'emailSubject' => '<string>',
'emailContent' => '<string>',
'packages' => [
[
'packageNumber' => 123,
'name' => '<string>',
'price' => 123,
'text' => '<string>'
]
],
'popularPackage' => 123,
'showServiceMenu' => true,
'serviceGrouping' => 123,
'sendSms' => true,
'requestPaymentDetails' => true,
'paymentDetailsType' => 123,
'payerID' => '<string>',
'businessSignatoryUserKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'requiresApproval' => true,
'approverUserKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'includeCdd' => true
]),
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}/details"
payload := strings.NewReader("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"welcomeMessageID\": 123,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"startOnAcceptance\": true,\n \"currencyID\": 123,\n \"lengthID\": 123,\n \"expiryDate\": \"2023-11-07T05:31:56Z\",\n \"terms\": 123,\n \"termsDetailsOverride\": \"<string>\",\n \"stpID\": 123,\n \"stpDetailsOverride\": \"<string>\",\n \"documents\": [\n {\n \"documentID\": 123,\n \"detailsOverride\": \"<string>\"\n }\n ],\n \"attachmentID\": 123,\n \"coverPageID\": 123,\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"packages\": [\n {\n \"packageNumber\": 123,\n \"name\": \"<string>\",\n \"price\": 123,\n \"text\": \"<string>\"\n }\n ],\n \"popularPackage\": 123,\n \"showServiceMenu\": true,\n \"serviceGrouping\": 123,\n \"sendSms\": true,\n \"requestPaymentDetails\": true,\n \"paymentDetailsType\": 123,\n \"payerID\": \"<string>\",\n \"businessSignatoryUserKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"requiresApproval\": true,\n \"approverUserKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"includeCdd\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://anzapi.onboardme.app/api/v1/proposals/{key}/details")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"welcomeMessageID\": 123,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"startOnAcceptance\": true,\n \"currencyID\": 123,\n \"lengthID\": 123,\n \"expiryDate\": \"2023-11-07T05:31:56Z\",\n \"terms\": 123,\n \"termsDetailsOverride\": \"<string>\",\n \"stpID\": 123,\n \"stpDetailsOverride\": \"<string>\",\n \"documents\": [\n {\n \"documentID\": 123,\n \"detailsOverride\": \"<string>\"\n }\n ],\n \"attachmentID\": 123,\n \"coverPageID\": 123,\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"packages\": [\n {\n \"packageNumber\": 123,\n \"name\": \"<string>\",\n \"price\": 123,\n \"text\": \"<string>\"\n }\n ],\n \"popularPackage\": 123,\n \"showServiceMenu\": true,\n \"serviceGrouping\": 123,\n \"sendSms\": true,\n \"requestPaymentDetails\": true,\n \"paymentDetailsType\": 123,\n \"payerID\": \"<string>\",\n \"businessSignatoryUserKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"requiresApproval\": true,\n \"approverUserKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"includeCdd\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/proposals/{key}/details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"welcomeMessageID\": 123,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"startOnAcceptance\": true,\n \"currencyID\": 123,\n \"lengthID\": 123,\n \"expiryDate\": \"2023-11-07T05:31:56Z\",\n \"terms\": 123,\n \"termsDetailsOverride\": \"<string>\",\n \"stpID\": 123,\n \"stpDetailsOverride\": \"<string>\",\n \"documents\": [\n {\n \"documentID\": 123,\n \"detailsOverride\": \"<string>\"\n }\n ],\n \"attachmentID\": 123,\n \"coverPageID\": 123,\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"packages\": [\n {\n \"packageNumber\": 123,\n \"name\": \"<string>\",\n \"price\": 123,\n \"text\": \"<string>\"\n }\n ],\n \"popularPackage\": 123,\n \"showServiceMenu\": true,\n \"serviceGrouping\": 123,\n \"sendSms\": true,\n \"requestPaymentDetails\": true,\n \"paymentDetailsType\": 123,\n \"payerID\": \"<string>\",\n \"businessSignatoryUserKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"requiresApproval\": true,\n \"approverUserKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"includeCdd\": true\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
Edit proposal details
Change individual fields in a proposal’s details section.
PATCH
/
api
/
v1
/
proposals
/
{key}
/
details
Edit proposal details
curl --request PATCH \
--url https://anzapi.onboardme.app/api/v1/proposals/{key}/details \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"note": "<string>",
"welcomeMessageID": 123,
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"startOnAcceptance": true,
"currencyID": 123,
"lengthID": 123,
"expiryDate": "2023-11-07T05:31:56Z",
"terms": 123,
"termsDetailsOverride": "<string>",
"stpID": 123,
"stpDetailsOverride": "<string>",
"documents": [
{
"documentID": 123,
"detailsOverride": "<string>"
}
],
"attachmentID": 123,
"coverPageID": 123,
"emailSubject": "<string>",
"emailContent": "<string>",
"packages": [
{
"packageNumber": 123,
"name": "<string>",
"price": 123,
"text": "<string>"
}
],
"popularPackage": 123,
"showServiceMenu": true,
"serviceGrouping": 123,
"sendSms": true,
"requestPaymentDetails": true,
"paymentDetailsType": 123,
"payerID": "<string>",
"businessSignatoryUserKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": true,
"approverUserKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"includeCdd": true
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/proposals/{key}/details"
payload = {
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"note": "<string>",
"welcomeMessageID": 123,
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"startOnAcceptance": True,
"currencyID": 123,
"lengthID": 123,
"expiryDate": "2023-11-07T05:31:56Z",
"terms": 123,
"termsDetailsOverride": "<string>",
"stpID": 123,
"stpDetailsOverride": "<string>",
"documents": [
{
"documentID": 123,
"detailsOverride": "<string>"
}
],
"attachmentID": 123,
"coverPageID": 123,
"emailSubject": "<string>",
"emailContent": "<string>",
"packages": [
{
"packageNumber": 123,
"name": "<string>",
"price": 123,
"text": "<string>"
}
],
"popularPackage": 123,
"showServiceMenu": True,
"serviceGrouping": 123,
"sendSms": True,
"requestPaymentDetails": True,
"paymentDetailsType": 123,
"payerID": "<string>",
"businessSignatoryUserKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requiresApproval": True,
"approverUserKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"includeCdd": True
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
note: '<string>',
welcomeMessageID: 123,
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
startOnAcceptance: true,
currencyID: 123,
lengthID: 123,
expiryDate: '2023-11-07T05:31:56Z',
terms: 123,
termsDetailsOverride: '<string>',
stpID: 123,
stpDetailsOverride: '<string>',
documents: [{documentID: 123, detailsOverride: '<string>'}],
attachmentID: 123,
coverPageID: 123,
emailSubject: '<string>',
emailContent: '<string>',
packages: [{packageNumber: 123, name: '<string>', price: 123, text: '<string>'}],
popularPackage: 123,
showServiceMenu: true,
serviceGrouping: 123,
sendSms: true,
requestPaymentDetails: true,
paymentDetailsType: 123,
payerID: '<string>',
businessSignatoryUserKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
requiresApproval: true,
approverUserKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
includeCdd: true
})
};
fetch('https://anzapi.onboardme.app/api/v1/proposals/{key}/details', 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}/details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'userKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'note' => '<string>',
'welcomeMessageID' => 123,
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'startOnAcceptance' => true,
'currencyID' => 123,
'lengthID' => 123,
'expiryDate' => '2023-11-07T05:31:56Z',
'terms' => 123,
'termsDetailsOverride' => '<string>',
'stpID' => 123,
'stpDetailsOverride' => '<string>',
'documents' => [
[
'documentID' => 123,
'detailsOverride' => '<string>'
]
],
'attachmentID' => 123,
'coverPageID' => 123,
'emailSubject' => '<string>',
'emailContent' => '<string>',
'packages' => [
[
'packageNumber' => 123,
'name' => '<string>',
'price' => 123,
'text' => '<string>'
]
],
'popularPackage' => 123,
'showServiceMenu' => true,
'serviceGrouping' => 123,
'sendSms' => true,
'requestPaymentDetails' => true,
'paymentDetailsType' => 123,
'payerID' => '<string>',
'businessSignatoryUserKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'requiresApproval' => true,
'approverUserKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'includeCdd' => true
]),
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}/details"
payload := strings.NewReader("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"welcomeMessageID\": 123,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"startOnAcceptance\": true,\n \"currencyID\": 123,\n \"lengthID\": 123,\n \"expiryDate\": \"2023-11-07T05:31:56Z\",\n \"terms\": 123,\n \"termsDetailsOverride\": \"<string>\",\n \"stpID\": 123,\n \"stpDetailsOverride\": \"<string>\",\n \"documents\": [\n {\n \"documentID\": 123,\n \"detailsOverride\": \"<string>\"\n }\n ],\n \"attachmentID\": 123,\n \"coverPageID\": 123,\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"packages\": [\n {\n \"packageNumber\": 123,\n \"name\": \"<string>\",\n \"price\": 123,\n \"text\": \"<string>\"\n }\n ],\n \"popularPackage\": 123,\n \"showServiceMenu\": true,\n \"serviceGrouping\": 123,\n \"sendSms\": true,\n \"requestPaymentDetails\": true,\n \"paymentDetailsType\": 123,\n \"payerID\": \"<string>\",\n \"businessSignatoryUserKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"requiresApproval\": true,\n \"approverUserKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"includeCdd\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://anzapi.onboardme.app/api/v1/proposals/{key}/details")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"welcomeMessageID\": 123,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"startOnAcceptance\": true,\n \"currencyID\": 123,\n \"lengthID\": 123,\n \"expiryDate\": \"2023-11-07T05:31:56Z\",\n \"terms\": 123,\n \"termsDetailsOverride\": \"<string>\",\n \"stpID\": 123,\n \"stpDetailsOverride\": \"<string>\",\n \"documents\": [\n {\n \"documentID\": 123,\n \"detailsOverride\": \"<string>\"\n }\n ],\n \"attachmentID\": 123,\n \"coverPageID\": 123,\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"packages\": [\n {\n \"packageNumber\": 123,\n \"name\": \"<string>\",\n \"price\": 123,\n \"text\": \"<string>\"\n }\n ],\n \"popularPackage\": 123,\n \"showServiceMenu\": true,\n \"serviceGrouping\": 123,\n \"sendSms\": true,\n \"requestPaymentDetails\": true,\n \"paymentDetailsType\": 123,\n \"payerID\": \"<string>\",\n \"businessSignatoryUserKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"requiresApproval\": true,\n \"approverUserKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"includeCdd\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/proposals/{key}/details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"welcomeMessageID\": 123,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"startOnAcceptance\": true,\n \"currencyID\": 123,\n \"lengthID\": 123,\n \"expiryDate\": \"2023-11-07T05:31:56Z\",\n \"terms\": 123,\n \"termsDetailsOverride\": \"<string>\",\n \"stpID\": 123,\n \"stpDetailsOverride\": \"<string>\",\n \"documents\": [\n {\n \"documentID\": 123,\n \"detailsOverride\": \"<string>\"\n }\n ],\n \"attachmentID\": 123,\n \"coverPageID\": 123,\n \"emailSubject\": \"<string>\",\n \"emailContent\": \"<string>\",\n \"packages\": [\n {\n \"packageNumber\": 123,\n \"name\": \"<string>\",\n \"price\": 123,\n \"text\": \"<string>\"\n }\n ],\n \"popularPackage\": 123,\n \"showServiceMenu\": true,\n \"serviceGrouping\": 123,\n \"sendSms\": true,\n \"requestPaymentDetails\": true,\n \"paymentDetailsType\": 123,\n \"payerID\": \"<string>\",\n \"businessSignatoryUserKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"requiresApproval\": true,\n \"approverUserKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"includeCdd\": true\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
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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
}
]
}