Load a bill

curl --request GET \
  --url https://anzapi.onboardme.app/api/v1/bills/{billingId} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://anzapi.onboardme.app/api/v1/bills/{billingId}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://anzapi.onboardme.app/api/v1/bills/{billingId}', 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/bills/{billingId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://anzapi.onboardme.app/api/v1/bills/{billingId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://anzapi.onboardme.app/api/v1/bills/{billingId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "billingID": 123,
  "engagementID": 123,
  "engagementName": "<string>",
  "engagementStatusID": 123,
  "isEngagementFinalised": true,
  "entityID": 123,
  "isOnboardingEntity": true,
  "entityName": "<string>",
  "billDate": "2023-12-25",
  "dueDate": "2023-12-25",
  "billNumber": "<string>",
  "billAmount": 123,
  "billTax": 123,
  "billTotal": 123,
  "billDetails": "<string>",
  "currencyID": 123,
  "paymentTotal": 123,
  "refNo": "<string>",
  "billNow": 123,
  "syncNow": true,
  "sendBill": true,
  "billPercent": 123,
  "packageNumber": 123,
  "invoiceStatus": "<string>",
  "externalID": "<string>",
  "externalNumber": "<string>",
  "externalURL": "<string>",
  "syncAttemptCount": 123,
  "syncFailedReason": "<string>",
  "brandingThemeID": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "updatedOn": "2023-11-07T05:31:56Z",
  "cancelledOn": "2023-11-07T05:31:56Z",
  "lineItems": [
    {
      "billingDetailID": 123,
      "billAmount": 123,
      "billTax": 123,
      "billTotal": 123,
      "narration": "<string>",
      "extItemID": 123,
      "extAccountID": 123,
      "extTaxID": 123,
      "fieldOne": "<string>",
      "fieldTwo": "<string>",
      "orderID": 123,
      "serviceID": 123
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

GET

api

bills

{billingId}

Load a bill

curl --request GET \
  --url https://anzapi.onboardme.app/api/v1/bills/{billingId} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://anzapi.onboardme.app/api/v1/bills/{billingId}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://anzapi.onboardme.app/api/v1/bills/{billingId}', 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/bills/{billingId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://anzapi.onboardme.app/api/v1/bills/{billingId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://anzapi.onboardme.app/api/v1/bills/{billingId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "billingID": 123,
  "engagementID": 123,
  "engagementName": "<string>",
  "engagementStatusID": 123,
  "isEngagementFinalised": true,
  "entityID": 123,
  "isOnboardingEntity": true,
  "entityName": "<string>",
  "billDate": "2023-12-25",
  "dueDate": "2023-12-25",
  "billNumber": "<string>",
  "billAmount": 123,
  "billTax": 123,
  "billTotal": 123,
  "billDetails": "<string>",
  "currencyID": 123,
  "paymentTotal": 123,
  "refNo": "<string>",
  "billNow": 123,
  "syncNow": true,
  "sendBill": true,
  "billPercent": 123,
  "packageNumber": 123,
  "invoiceStatus": "<string>",
  "externalID": "<string>",
  "externalNumber": "<string>",
  "externalURL": "<string>",
  "syncAttemptCount": 123,
  "syncFailedReason": "<string>",
  "brandingThemeID": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "updatedOn": "2023-11-07T05:31:56Z",
  "cancelledOn": "2023-11-07T05:31:56Z",
  "lineItems": [
    {
      "billingDetailID": 123,
      "billAmount": 123,
      "billTax": 123,
      "billTotal": 123,
      "narration": "<string>",
      "extItemID": 123,
      "extAccountID": 123,
      "extTaxID": 123,
      "fieldOne": "<string>",
      "fieldTwo": "<string>",
      "orderID": 123,
      "serviceID": 123
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

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

billingId

integer<int32>

required

Bill id.

Response

billingID

integer<int32>

engagementID

integer<int32>

engagementName

string | null

engagementStatusID

integer<int32> | null

isEngagementFinalised

boolean

entityID

integer<int32>

isOnboardingEntity

boolean

entityName

string | null

billDate

string<date>

dueDate

string<date>

billNumber

string | null

billAmount

number<double>

billTax

number<double>

billTotal

number<double>

billDetails

string | null

currencyID

integer<int32>

paymentTotal

number<double>

refNo

string | null

billNow

integer<int32>

syncNow

boolean

sendBill

boolean

billPercent

integer<int32>

packageNumber

integer<int32> | null

invoiceStatus

string | null

externalID

string | null

externalNumber

string | null

externalURL

string | null

syncAttemptCount

integer<int32>

syncFailedReason

string | null

brandingThemeID

string | null

createdOn

string<date-time>

updatedOn

string<date-time>

cancelledOn

string<date-time> | null

lineItems

object[] | null

Show child attributes

API documentation

Endpoints

Building blocks

Load a bill

Authorizations

Path Parameters

Response