List Transaction Categories

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

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/config/categories"

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/config/categories', 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/config/categories",
  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/config/categories"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/config/categories")

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": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440100",
      "name": "Indemnity",
      "kind": "reserved",
      "expectedDirection": "payable",
      "deprecatedAt": null,
      "lineItemTypes": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440110",
          "name": "Legal",
          "direction": "payable",
          "deprecatedAt": null
        }
      ]
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440120",
      "name": "Administration",
      "kind": "operating",
      "expectedDirection": "payable",
      "deprecatedAt": null,
      "lineItemTypes": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440130",
          "name": "Fees",
          "direction": "payable",
          "deprecatedAt": null
        }
      ]
    }
  ]
}

Configuration

List Transaction Categories

Read-only discovery of the company’s configured transaction categories and their line item types (nested), with kind and direction so clients know which fields apply — the ids invoice and reserve writes cite.

Live rows by default; includeDeprecated=true widens both levels to deprecated rows (marked by deprecatedAt) so old references resolve. Categories and line item types are configured in the app’s settings — this surface has no configuration writes.

Required permission: company.payment:read

GET

api

companies

{companyId}

financials

config

categories

List Transaction Categories

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

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/config/categories"

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/config/categories', 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/config/categories",
  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/config/categories"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/config/categories")

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": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440100",
      "name": "Indemnity",
      "kind": "reserved",
      "expectedDirection": "payable",
      "deprecatedAt": null,
      "lineItemTypes": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440110",
          "name": "Legal",
          "direction": "payable",
          "deprecatedAt": null
        }
      ]
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440120",
      "name": "Administration",
      "kind": "operating",
      "expectedDirection": "payable",
      "deprecatedAt": null,
      "lineItemTypes": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440130",
          "name": "Fees",
          "direction": "payable",
          "deprecatedAt": 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

Query Parameters

includeDeprecated

boolean

true includes deprecated categories and line item types; default live rows only

Response

The configured categories with nested line item types

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

List Transaction Categories

Authorizations

Path Parameters

Query Parameters

Response