Replace billing
curl --request PUT \
--url https://anzapi.onboardme.app/api/v1/proposals/{key}/billing \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoices": [
{
"id": 123,
"remove": true,
"billDate": "2023-12-25",
"dueDate": "2023-12-25",
"billDetails": "<string>",
"refNo": "<string>",
"billNow": 123,
"syncNow": true,
"sendBill": true,
"brandingThemeID": "<string>",
"packageNumber": 123,
"lineItems": [
{
"amount": 0,
"taxAmount": 0,
"taxPercent": 50,
"total": 0,
"narration": "<string>",
"extAccountID": 123,
"extItemID": 123,
"extTaxID": 123,
"orderID": 123,
"serviceID": 123,
"trackingOptionIDs": [
"<string>"
],
"greatSoftTaskCode": "<string>",
"greatSoftAllocationCode": "<string>"
}
]
}
],
"recurringBillings": [
{
"id": 123,
"remove": true,
"frequency": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"nextRunDate": "2023-12-25",
"dueDays": 123,
"billDetails": "<string>",
"refNo": "<string>",
"brandingThemeID": "<string>",
"sendBill": true,
"billNow": 123,
"packageNumber": 123,
"lineItems": [
{
"amount": 0,
"taxAmount": 0,
"taxPercent": 50,
"total": 0,
"narration": "<string>",
"extAccountID": 123,
"extItemID": 123,
"extTaxID": 123,
"orderID": 123,
"serviceID": 123,
"trackingOptionIDs": [
"<string>"
],
"greatSoftTaskCode": "<string>",
"greatSoftAllocationCode": "<string>"
}
]
}
],
"billFromServices": {
"billNow": 123,
"packageNumber": 123,
"billDate": "2023-12-25",
"dueDate": "2023-12-25",
"sendBill": true,
"recurringSchedules": true
}
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/proposals/{key}/billing"
payload = {
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoices": [
{
"id": 123,
"remove": True,
"billDate": "2023-12-25",
"dueDate": "2023-12-25",
"billDetails": "<string>",
"refNo": "<string>",
"billNow": 123,
"syncNow": True,
"sendBill": True,
"brandingThemeID": "<string>",
"packageNumber": 123,
"lineItems": [
{
"amount": 0,
"taxAmount": 0,
"taxPercent": 50,
"total": 0,
"narration": "<string>",
"extAccountID": 123,
"extItemID": 123,
"extTaxID": 123,
"orderID": 123,
"serviceID": 123,
"trackingOptionIDs": ["<string>"],
"greatSoftTaskCode": "<string>",
"greatSoftAllocationCode": "<string>"
}
]
}
],
"recurringBillings": [
{
"id": 123,
"remove": True,
"frequency": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"nextRunDate": "2023-12-25",
"dueDays": 123,
"billDetails": "<string>",
"refNo": "<string>",
"brandingThemeID": "<string>",
"sendBill": True,
"billNow": 123,
"packageNumber": 123,
"lineItems": [
{
"amount": 0,
"taxAmount": 0,
"taxPercent": 50,
"total": 0,
"narration": "<string>",
"extAccountID": 123,
"extItemID": 123,
"extTaxID": 123,
"orderID": 123,
"serviceID": 123,
"trackingOptionIDs": ["<string>"],
"greatSoftTaskCode": "<string>",
"greatSoftAllocationCode": "<string>"
}
]
}
],
"billFromServices": {
"billNow": 123,
"packageNumber": 123,
"billDate": "2023-12-25",
"dueDate": "2023-12-25",
"sendBill": True,
"recurringSchedules": True
}
}
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',
invoices: [
{
id: 123,
remove: true,
billDate: '2023-12-25',
dueDate: '2023-12-25',
billDetails: '<string>',
refNo: '<string>',
billNow: 123,
syncNow: true,
sendBill: true,
brandingThemeID: '<string>',
packageNumber: 123,
lineItems: [
{
amount: 0,
taxAmount: 0,
taxPercent: 50,
total: 0,
narration: '<string>',
extAccountID: 123,
extItemID: 123,
extTaxID: 123,
orderID: 123,
serviceID: 123,
trackingOptionIDs: ['<string>'],
greatSoftTaskCode: '<string>',
greatSoftAllocationCode: '<string>'
}
]
}
],
recurringBillings: [
{
id: 123,
remove: true,
frequency: '<string>',
startDate: '2023-12-25',
endDate: '2023-12-25',
nextRunDate: '2023-12-25',
dueDays: 123,
billDetails: '<string>',
refNo: '<string>',
brandingThemeID: '<string>',
sendBill: true,
billNow: 123,
packageNumber: 123,
lineItems: [
{
amount: 0,
taxAmount: 0,
taxPercent: 50,
total: 0,
narration: '<string>',
extAccountID: 123,
extItemID: 123,
extTaxID: 123,
orderID: 123,
serviceID: 123,
trackingOptionIDs: ['<string>'],
greatSoftTaskCode: '<string>',
greatSoftAllocationCode: '<string>'
}
]
}
],
billFromServices: {
billNow: 123,
packageNumber: 123,
billDate: '2023-12-25',
dueDate: '2023-12-25',
sendBill: true,
recurringSchedules: true
}
})
};
fetch('https://anzapi.onboardme.app/api/v1/proposals/{key}/billing', 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}/billing",
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',
'invoices' => [
[
'id' => 123,
'remove' => true,
'billDate' => '2023-12-25',
'dueDate' => '2023-12-25',
'billDetails' => '<string>',
'refNo' => '<string>',
'billNow' => 123,
'syncNow' => true,
'sendBill' => true,
'brandingThemeID' => '<string>',
'packageNumber' => 123,
'lineItems' => [
[
'amount' => 0,
'taxAmount' => 0,
'taxPercent' => 50,
'total' => 0,
'narration' => '<string>',
'extAccountID' => 123,
'extItemID' => 123,
'extTaxID' => 123,
'orderID' => 123,
'serviceID' => 123,
'trackingOptionIDs' => [
'<string>'
],
'greatSoftTaskCode' => '<string>',
'greatSoftAllocationCode' => '<string>'
]
]
]
],
'recurringBillings' => [
[
'id' => 123,
'remove' => true,
'frequency' => '<string>',
'startDate' => '2023-12-25',
'endDate' => '2023-12-25',
'nextRunDate' => '2023-12-25',
'dueDays' => 123,
'billDetails' => '<string>',
'refNo' => '<string>',
'brandingThemeID' => '<string>',
'sendBill' => true,
'billNow' => 123,
'packageNumber' => 123,
'lineItems' => [
[
'amount' => 0,
'taxAmount' => 0,
'taxPercent' => 50,
'total' => 0,
'narration' => '<string>',
'extAccountID' => 123,
'extItemID' => 123,
'extTaxID' => 123,
'orderID' => 123,
'serviceID' => 123,
'trackingOptionIDs' => [
'<string>'
],
'greatSoftTaskCode' => '<string>',
'greatSoftAllocationCode' => '<string>'
]
]
]
],
'billFromServices' => [
'billNow' => 123,
'packageNumber' => 123,
'billDate' => '2023-12-25',
'dueDate' => '2023-12-25',
'sendBill' => true,
'recurringSchedules' => 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}/billing"
payload := strings.NewReader("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"invoices\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"billDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"billDetails\": \"<string>\",\n \"refNo\": \"<string>\",\n \"billNow\": 123,\n \"syncNow\": true,\n \"sendBill\": true,\n \"brandingThemeID\": \"<string>\",\n \"packageNumber\": 123,\n \"lineItems\": [\n {\n \"amount\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 50,\n \"total\": 0,\n \"narration\": \"<string>\",\n \"extAccountID\": 123,\n \"extItemID\": 123,\n \"extTaxID\": 123,\n \"orderID\": 123,\n \"serviceID\": 123,\n \"trackingOptionIDs\": [\n \"<string>\"\n ],\n \"greatSoftTaskCode\": \"<string>\",\n \"greatSoftAllocationCode\": \"<string>\"\n }\n ]\n }\n ],\n \"recurringBillings\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"frequency\": \"<string>\",\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"nextRunDate\": \"2023-12-25\",\n \"dueDays\": 123,\n \"billDetails\": \"<string>\",\n \"refNo\": \"<string>\",\n \"brandingThemeID\": \"<string>\",\n \"sendBill\": true,\n \"billNow\": 123,\n \"packageNumber\": 123,\n \"lineItems\": [\n {\n \"amount\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 50,\n \"total\": 0,\n \"narration\": \"<string>\",\n \"extAccountID\": 123,\n \"extItemID\": 123,\n \"extTaxID\": 123,\n \"orderID\": 123,\n \"serviceID\": 123,\n \"trackingOptionIDs\": [\n \"<string>\"\n ],\n \"greatSoftTaskCode\": \"<string>\",\n \"greatSoftAllocationCode\": \"<string>\"\n }\n ]\n }\n ],\n \"billFromServices\": {\n \"billNow\": 123,\n \"packageNumber\": 123,\n \"billDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"sendBill\": true,\n \"recurringSchedules\": true\n }\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}/billing")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"invoices\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"billDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"billDetails\": \"<string>\",\n \"refNo\": \"<string>\",\n \"billNow\": 123,\n \"syncNow\": true,\n \"sendBill\": true,\n \"brandingThemeID\": \"<string>\",\n \"packageNumber\": 123,\n \"lineItems\": [\n {\n \"amount\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 50,\n \"total\": 0,\n \"narration\": \"<string>\",\n \"extAccountID\": 123,\n \"extItemID\": 123,\n \"extTaxID\": 123,\n \"orderID\": 123,\n \"serviceID\": 123,\n \"trackingOptionIDs\": [\n \"<string>\"\n ],\n \"greatSoftTaskCode\": \"<string>\",\n \"greatSoftAllocationCode\": \"<string>\"\n }\n ]\n }\n ],\n \"recurringBillings\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"frequency\": \"<string>\",\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"nextRunDate\": \"2023-12-25\",\n \"dueDays\": 123,\n \"billDetails\": \"<string>\",\n \"refNo\": \"<string>\",\n \"brandingThemeID\": \"<string>\",\n \"sendBill\": true,\n \"billNow\": 123,\n \"packageNumber\": 123,\n \"lineItems\": [\n {\n \"amount\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 50,\n \"total\": 0,\n \"narration\": \"<string>\",\n \"extAccountID\": 123,\n \"extItemID\": 123,\n \"extTaxID\": 123,\n \"orderID\": 123,\n \"serviceID\": 123,\n \"trackingOptionIDs\": [\n \"<string>\"\n ],\n \"greatSoftTaskCode\": \"<string>\",\n \"greatSoftAllocationCode\": \"<string>\"\n }\n ]\n }\n ],\n \"billFromServices\": {\n \"billNow\": 123,\n \"packageNumber\": 123,\n \"billDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"sendBill\": true,\n \"recurringSchedules\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/proposals/{key}/billing")
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 \"invoices\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"billDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"billDetails\": \"<string>\",\n \"refNo\": \"<string>\",\n \"billNow\": 123,\n \"syncNow\": true,\n \"sendBill\": true,\n \"brandingThemeID\": \"<string>\",\n \"packageNumber\": 123,\n \"lineItems\": [\n {\n \"amount\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 50,\n \"total\": 0,\n \"narration\": \"<string>\",\n \"extAccountID\": 123,\n \"extItemID\": 123,\n \"extTaxID\": 123,\n \"orderID\": 123,\n \"serviceID\": 123,\n \"trackingOptionIDs\": [\n \"<string>\"\n ],\n \"greatSoftTaskCode\": \"<string>\",\n \"greatSoftAllocationCode\": \"<string>\"\n }\n ]\n }\n ],\n \"recurringBillings\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"frequency\": \"<string>\",\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"nextRunDate\": \"2023-12-25\",\n \"dueDays\": 123,\n \"billDetails\": \"<string>\",\n \"refNo\": \"<string>\",\n \"brandingThemeID\": \"<string>\",\n \"sendBill\": true,\n \"billNow\": 123,\n \"packageNumber\": 123,\n \"lineItems\": [\n {\n \"amount\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 50,\n \"total\": 0,\n \"narration\": \"<string>\",\n \"extAccountID\": 123,\n \"extItemID\": 123,\n \"extTaxID\": 123,\n \"orderID\": 123,\n \"serviceID\": 123,\n \"trackingOptionIDs\": [\n \"<string>\"\n ],\n \"greatSoftTaskCode\": \"<string>\",\n \"greatSoftAllocationCode\": \"<string>\"\n }\n ]\n }\n ],\n \"billFromServices\": {\n \"billNow\": 123,\n \"packageNumber\": 123,\n \"billDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"sendBill\": true,\n \"recurringSchedules\": true\n }\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
Replace billing
Replace a proposal’s invoices and recurring billings.
PUT
/
api
/
v1
/
proposals
/
{key}
/
billing
Replace billing
curl --request PUT \
--url https://anzapi.onboardme.app/api/v1/proposals/{key}/billing \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoices": [
{
"id": 123,
"remove": true,
"billDate": "2023-12-25",
"dueDate": "2023-12-25",
"billDetails": "<string>",
"refNo": "<string>",
"billNow": 123,
"syncNow": true,
"sendBill": true,
"brandingThemeID": "<string>",
"packageNumber": 123,
"lineItems": [
{
"amount": 0,
"taxAmount": 0,
"taxPercent": 50,
"total": 0,
"narration": "<string>",
"extAccountID": 123,
"extItemID": 123,
"extTaxID": 123,
"orderID": 123,
"serviceID": 123,
"trackingOptionIDs": [
"<string>"
],
"greatSoftTaskCode": "<string>",
"greatSoftAllocationCode": "<string>"
}
]
}
],
"recurringBillings": [
{
"id": 123,
"remove": true,
"frequency": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"nextRunDate": "2023-12-25",
"dueDays": 123,
"billDetails": "<string>",
"refNo": "<string>",
"brandingThemeID": "<string>",
"sendBill": true,
"billNow": 123,
"packageNumber": 123,
"lineItems": [
{
"amount": 0,
"taxAmount": 0,
"taxPercent": 50,
"total": 0,
"narration": "<string>",
"extAccountID": 123,
"extItemID": 123,
"extTaxID": 123,
"orderID": 123,
"serviceID": 123,
"trackingOptionIDs": [
"<string>"
],
"greatSoftTaskCode": "<string>",
"greatSoftAllocationCode": "<string>"
}
]
}
],
"billFromServices": {
"billNow": 123,
"packageNumber": 123,
"billDate": "2023-12-25",
"dueDate": "2023-12-25",
"sendBill": true,
"recurringSchedules": true
}
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/proposals/{key}/billing"
payload = {
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoices": [
{
"id": 123,
"remove": True,
"billDate": "2023-12-25",
"dueDate": "2023-12-25",
"billDetails": "<string>",
"refNo": "<string>",
"billNow": 123,
"syncNow": True,
"sendBill": True,
"brandingThemeID": "<string>",
"packageNumber": 123,
"lineItems": [
{
"amount": 0,
"taxAmount": 0,
"taxPercent": 50,
"total": 0,
"narration": "<string>",
"extAccountID": 123,
"extItemID": 123,
"extTaxID": 123,
"orderID": 123,
"serviceID": 123,
"trackingOptionIDs": ["<string>"],
"greatSoftTaskCode": "<string>",
"greatSoftAllocationCode": "<string>"
}
]
}
],
"recurringBillings": [
{
"id": 123,
"remove": True,
"frequency": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"nextRunDate": "2023-12-25",
"dueDays": 123,
"billDetails": "<string>",
"refNo": "<string>",
"brandingThemeID": "<string>",
"sendBill": True,
"billNow": 123,
"packageNumber": 123,
"lineItems": [
{
"amount": 0,
"taxAmount": 0,
"taxPercent": 50,
"total": 0,
"narration": "<string>",
"extAccountID": 123,
"extItemID": 123,
"extTaxID": 123,
"orderID": 123,
"serviceID": 123,
"trackingOptionIDs": ["<string>"],
"greatSoftTaskCode": "<string>",
"greatSoftAllocationCode": "<string>"
}
]
}
],
"billFromServices": {
"billNow": 123,
"packageNumber": 123,
"billDate": "2023-12-25",
"dueDate": "2023-12-25",
"sendBill": True,
"recurringSchedules": True
}
}
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',
invoices: [
{
id: 123,
remove: true,
billDate: '2023-12-25',
dueDate: '2023-12-25',
billDetails: '<string>',
refNo: '<string>',
billNow: 123,
syncNow: true,
sendBill: true,
brandingThemeID: '<string>',
packageNumber: 123,
lineItems: [
{
amount: 0,
taxAmount: 0,
taxPercent: 50,
total: 0,
narration: '<string>',
extAccountID: 123,
extItemID: 123,
extTaxID: 123,
orderID: 123,
serviceID: 123,
trackingOptionIDs: ['<string>'],
greatSoftTaskCode: '<string>',
greatSoftAllocationCode: '<string>'
}
]
}
],
recurringBillings: [
{
id: 123,
remove: true,
frequency: '<string>',
startDate: '2023-12-25',
endDate: '2023-12-25',
nextRunDate: '2023-12-25',
dueDays: 123,
billDetails: '<string>',
refNo: '<string>',
brandingThemeID: '<string>',
sendBill: true,
billNow: 123,
packageNumber: 123,
lineItems: [
{
amount: 0,
taxAmount: 0,
taxPercent: 50,
total: 0,
narration: '<string>',
extAccountID: 123,
extItemID: 123,
extTaxID: 123,
orderID: 123,
serviceID: 123,
trackingOptionIDs: ['<string>'],
greatSoftTaskCode: '<string>',
greatSoftAllocationCode: '<string>'
}
]
}
],
billFromServices: {
billNow: 123,
packageNumber: 123,
billDate: '2023-12-25',
dueDate: '2023-12-25',
sendBill: true,
recurringSchedules: true
}
})
};
fetch('https://anzapi.onboardme.app/api/v1/proposals/{key}/billing', 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}/billing",
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',
'invoices' => [
[
'id' => 123,
'remove' => true,
'billDate' => '2023-12-25',
'dueDate' => '2023-12-25',
'billDetails' => '<string>',
'refNo' => '<string>',
'billNow' => 123,
'syncNow' => true,
'sendBill' => true,
'brandingThemeID' => '<string>',
'packageNumber' => 123,
'lineItems' => [
[
'amount' => 0,
'taxAmount' => 0,
'taxPercent' => 50,
'total' => 0,
'narration' => '<string>',
'extAccountID' => 123,
'extItemID' => 123,
'extTaxID' => 123,
'orderID' => 123,
'serviceID' => 123,
'trackingOptionIDs' => [
'<string>'
],
'greatSoftTaskCode' => '<string>',
'greatSoftAllocationCode' => '<string>'
]
]
]
],
'recurringBillings' => [
[
'id' => 123,
'remove' => true,
'frequency' => '<string>',
'startDate' => '2023-12-25',
'endDate' => '2023-12-25',
'nextRunDate' => '2023-12-25',
'dueDays' => 123,
'billDetails' => '<string>',
'refNo' => '<string>',
'brandingThemeID' => '<string>',
'sendBill' => true,
'billNow' => 123,
'packageNumber' => 123,
'lineItems' => [
[
'amount' => 0,
'taxAmount' => 0,
'taxPercent' => 50,
'total' => 0,
'narration' => '<string>',
'extAccountID' => 123,
'extItemID' => 123,
'extTaxID' => 123,
'orderID' => 123,
'serviceID' => 123,
'trackingOptionIDs' => [
'<string>'
],
'greatSoftTaskCode' => '<string>',
'greatSoftAllocationCode' => '<string>'
]
]
]
],
'billFromServices' => [
'billNow' => 123,
'packageNumber' => 123,
'billDate' => '2023-12-25',
'dueDate' => '2023-12-25',
'sendBill' => true,
'recurringSchedules' => 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}/billing"
payload := strings.NewReader("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"invoices\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"billDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"billDetails\": \"<string>\",\n \"refNo\": \"<string>\",\n \"billNow\": 123,\n \"syncNow\": true,\n \"sendBill\": true,\n \"brandingThemeID\": \"<string>\",\n \"packageNumber\": 123,\n \"lineItems\": [\n {\n \"amount\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 50,\n \"total\": 0,\n \"narration\": \"<string>\",\n \"extAccountID\": 123,\n \"extItemID\": 123,\n \"extTaxID\": 123,\n \"orderID\": 123,\n \"serviceID\": 123,\n \"trackingOptionIDs\": [\n \"<string>\"\n ],\n \"greatSoftTaskCode\": \"<string>\",\n \"greatSoftAllocationCode\": \"<string>\"\n }\n ]\n }\n ],\n \"recurringBillings\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"frequency\": \"<string>\",\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"nextRunDate\": \"2023-12-25\",\n \"dueDays\": 123,\n \"billDetails\": \"<string>\",\n \"refNo\": \"<string>\",\n \"brandingThemeID\": \"<string>\",\n \"sendBill\": true,\n \"billNow\": 123,\n \"packageNumber\": 123,\n \"lineItems\": [\n {\n \"amount\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 50,\n \"total\": 0,\n \"narration\": \"<string>\",\n \"extAccountID\": 123,\n \"extItemID\": 123,\n \"extTaxID\": 123,\n \"orderID\": 123,\n \"serviceID\": 123,\n \"trackingOptionIDs\": [\n \"<string>\"\n ],\n \"greatSoftTaskCode\": \"<string>\",\n \"greatSoftAllocationCode\": \"<string>\"\n }\n ]\n }\n ],\n \"billFromServices\": {\n \"billNow\": 123,\n \"packageNumber\": 123,\n \"billDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"sendBill\": true,\n \"recurringSchedules\": true\n }\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}/billing")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"invoices\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"billDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"billDetails\": \"<string>\",\n \"refNo\": \"<string>\",\n \"billNow\": 123,\n \"syncNow\": true,\n \"sendBill\": true,\n \"brandingThemeID\": \"<string>\",\n \"packageNumber\": 123,\n \"lineItems\": [\n {\n \"amount\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 50,\n \"total\": 0,\n \"narration\": \"<string>\",\n \"extAccountID\": 123,\n \"extItemID\": 123,\n \"extTaxID\": 123,\n \"orderID\": 123,\n \"serviceID\": 123,\n \"trackingOptionIDs\": [\n \"<string>\"\n ],\n \"greatSoftTaskCode\": \"<string>\",\n \"greatSoftAllocationCode\": \"<string>\"\n }\n ]\n }\n ],\n \"recurringBillings\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"frequency\": \"<string>\",\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"nextRunDate\": \"2023-12-25\",\n \"dueDays\": 123,\n \"billDetails\": \"<string>\",\n \"refNo\": \"<string>\",\n \"brandingThemeID\": \"<string>\",\n \"sendBill\": true,\n \"billNow\": 123,\n \"packageNumber\": 123,\n \"lineItems\": [\n {\n \"amount\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 50,\n \"total\": 0,\n \"narration\": \"<string>\",\n \"extAccountID\": 123,\n \"extItemID\": 123,\n \"extTaxID\": 123,\n \"orderID\": 123,\n \"serviceID\": 123,\n \"trackingOptionIDs\": [\n \"<string>\"\n ],\n \"greatSoftTaskCode\": \"<string>\",\n \"greatSoftAllocationCode\": \"<string>\"\n }\n ]\n }\n ],\n \"billFromServices\": {\n \"billNow\": 123,\n \"packageNumber\": 123,\n \"billDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"sendBill\": true,\n \"recurringSchedules\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/proposals/{key}/billing")
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 \"invoices\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"billDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"billDetails\": \"<string>\",\n \"refNo\": \"<string>\",\n \"billNow\": 123,\n \"syncNow\": true,\n \"sendBill\": true,\n \"brandingThemeID\": \"<string>\",\n \"packageNumber\": 123,\n \"lineItems\": [\n {\n \"amount\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 50,\n \"total\": 0,\n \"narration\": \"<string>\",\n \"extAccountID\": 123,\n \"extItemID\": 123,\n \"extTaxID\": 123,\n \"orderID\": 123,\n \"serviceID\": 123,\n \"trackingOptionIDs\": [\n \"<string>\"\n ],\n \"greatSoftTaskCode\": \"<string>\",\n \"greatSoftAllocationCode\": \"<string>\"\n }\n ]\n }\n ],\n \"recurringBillings\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"frequency\": \"<string>\",\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"nextRunDate\": \"2023-12-25\",\n \"dueDays\": 123,\n \"billDetails\": \"<string>\",\n \"refNo\": \"<string>\",\n \"brandingThemeID\": \"<string>\",\n \"sendBill\": true,\n \"billNow\": 123,\n \"packageNumber\": 123,\n \"lineItems\": [\n {\n \"amount\": 0,\n \"taxAmount\": 0,\n \"taxPercent\": 50,\n \"total\": 0,\n \"narration\": \"<string>\",\n \"extAccountID\": 123,\n \"extItemID\": 123,\n \"extTaxID\": 123,\n \"orderID\": 123,\n \"serviceID\": 123,\n \"trackingOptionIDs\": [\n \"<string>\"\n ],\n \"greatSoftTaskCode\": \"<string>\",\n \"greatSoftAllocationCode\": \"<string>\"\n }\n ]\n }\n ],\n \"billFromServices\": {\n \"billNow\": 123,\n \"packageNumber\": 123,\n \"billDate\": \"2023-12-25\",\n \"dueDate\": \"2023-12-25\",\n \"sendBill\": true,\n \"recurringSchedules\": true\n }\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
}
]
}