Get Entity Balances

curl --request GET \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances \
  --header 'Authorization: <api-key>'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances', 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://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances",
  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: <api-key>"
  ],
]);

$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://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "categories": [
    {
      "categoryId": "550e8400-e29b-41d4-a716-446655440100",
      "name": "Indemnity",
      "kind": "reserved",
      "expectedDirection": "payable",
      "deprecatedAt": null,
      "reservesCents": -6000,
      "owedCents": 6000,
      "paidCents": -4000,
      "expectedTotalCents": -10000,
      "accounts": [
        {
          "accountId": "550e8400-e29b-41d4-a716-446655440101",
          "key": "indemnity-unpaid-losses-1",
          "displayName": "Indemnity Unpaid Losses",
          "role": "unpaid",
          "direction": "payable",
          "lineItemTypeId": null,
          "amountCents": -6000
        },
        {
          "accountId": "550e8400-e29b-41d4-a716-446655440102",
          "key": "indemnity-payable-1",
          "displayName": "Indemnity Payable",
          "role": "payable",
          "direction": "payable",
          "lineItemTypeId": "550e8400-e29b-41d4-a716-446655440110",
          "amountCents": 6000
        },
        {
          "accountId": "550e8400-e29b-41d4-a716-446655440103",
          "key": "indemnity-legal-1",
          "displayName": "Legal",
          "role": "line_item",
          "direction": "payable",
          "lineItemTypeId": "550e8400-e29b-41d4-a716-446655440110",
          "amountCents": -4000
        }
      ]
    }
  ],
  "cash": null
}

Balances

Get Entity Balances

Returns one entity’s financial balances in the same category-grouped shape as the global read — per-category rollups plus per-account detail, raw signed integer cents with each account’s role and provenance direction embedded (the carrying side derives from role × direction). Also the read for an event scope’s current expected total before setting reserves.

Zero and absent are the same state: zero-amount accounts are dropped, a category with nothing nonzero is dropped, and an entity with no balances at all — unknown ids included — reads as empty balances rather than a 404 (this is a pure balance read; it does not check entity existence).

Required permission: company.payment:read

GET

api

companies

{companyId}

financials

entities

{entityType}

{entityId}

balances

Get Entity Balances

curl --request GET \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances \
  --header 'Authorization: <api-key>'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances', 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://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances",
  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: <api-key>"
  ],
]);

$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://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/entities/{entityType}/{entityId}/balances")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "categories": [
    {
      "categoryId": "550e8400-e29b-41d4-a716-446655440100",
      "name": "Indemnity",
      "kind": "reserved",
      "expectedDirection": "payable",
      "deprecatedAt": null,
      "reservesCents": -6000,
      "owedCents": 6000,
      "paidCents": -4000,
      "expectedTotalCents": -10000,
      "accounts": [
        {
          "accountId": "550e8400-e29b-41d4-a716-446655440101",
          "key": "indemnity-unpaid-losses-1",
          "displayName": "Indemnity Unpaid Losses",
          "role": "unpaid",
          "direction": "payable",
          "lineItemTypeId": null,
          "amountCents": -6000
        },
        {
          "accountId": "550e8400-e29b-41d4-a716-446655440102",
          "key": "indemnity-payable-1",
          "displayName": "Indemnity Payable",
          "role": "payable",
          "direction": "payable",
          "lineItemTypeId": "550e8400-e29b-41d4-a716-446655440110",
          "amountCents": 6000
        },
        {
          "accountId": "550e8400-e29b-41d4-a716-446655440103",
          "key": "indemnity-legal-1",
          "displayName": "Legal",
          "role": "line_item",
          "direction": "payable",
          "lineItemTypeId": "550e8400-e29b-41d4-a716-446655440110",
          "amountCents": -4000
        }
      ]
    }
  ],
  "cash": null
}

Authorizations

Authorization

string

header

required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId

string<uuid>

required

Company identifier

entityType

enum<string>

required

The entity dimension to read balances for. Any other value is a 400

Available options:

event,

policy,

payee

entityId

string<uuid>

required

The entity's id

Response

The entity's nonzero balances (empty categories and null cash when the entity has none)

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

Get Entity Balances

Authorizations

Path Parameters

Response