Get Invoice Bill Review

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

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/bill-review"

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/invoices/{invoiceId}/bill-review', 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/invoices/{invoiceId}/bill-review",
  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/invoices/{invoiceId}/bill-review"

	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/invoices/{invoiceId}/bill-review")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/bill-review")

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

{
  "billReview": {
    "runId": "994bfc11-8ff3-485a-89ff-7839c9bb6101",
    "status": "succeeded",
    "trigger": "manual",
    "passed": false,
    "invoiceHeadJournalId": "1b2c3d4e-5f60-4712-8823-94a5b6c7d8e9",
    "error": null,
    "createdAt": "2026-06-14T12:00:00.000Z",
    "finishedAt": "2026-06-14T12:00:14.000Z",
    "findings": [
      {
        "id": "0f204eac-17e5-42bc-93b1-0dd2aea57baa",
        "subject": "lineItem:550e8400-e29b-41d4-a716-446655440300",
        "severity": "error",
        "message": "Legal work is billed at $450/hr; this line item bills it at $600/hr.",
        "ruleId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "dismissedAt": null
      }
    ]
  }
}

Bill Review

Get Invoice Bill Review

Returns the invoice’s LATEST bill review — the run, its verdict, and every finding it raised.

A bill review checks one invoice against the company’s own bill review rules and reports what it thinks is wrong with it. Runs are immutable records of what was judged: this endpoint always answers with the most recent one, and starting a new review adds a run rather than editing this one.

Poll this endpoint. status is queued or running while the review is under way and succeeded or failed once it is terminal. passed is the verdict and is null until then — and stays null forever on a failed run, which is why error is the field to read there rather than inferring a verdict from an empty findings list.

Staleness is yours to check. invoiceHeadJournalId is the invoice version this run judged, pinned when the review was started. Compare it with the invoice’s current headJournalId (Get Invoice): if they differ, the document has been edited since it was reviewed and the findings describe an earlier version of it.

Dismissals. dismissedAt is set on a finding an operator has cleared in the app. Dismissal is a stamp, never a delete, so a dismissed finding is still returned — filter on the field if your integration only wants outstanding ones. There is no API to dismiss.

billReview is null when the invoice exists but has never been reviewed. An id that does not resolve for this company is a 404.

Required permission: company.payment:read

GET

api

companies

{companyId}

financials

invoices

{invoiceId}

bill-review

Get Invoice Bill Review

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

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/bill-review"

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/invoices/{invoiceId}/bill-review', 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/invoices/{invoiceId}/bill-review",
  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/invoices/{invoiceId}/bill-review"

	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/invoices/{invoiceId}/bill-review")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/bill-review")

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

{
  "billReview": {
    "runId": "994bfc11-8ff3-485a-89ff-7839c9bb6101",
    "status": "succeeded",
    "trigger": "manual",
    "passed": false,
    "invoiceHeadJournalId": "1b2c3d4e-5f60-4712-8823-94a5b6c7d8e9",
    "error": null,
    "createdAt": "2026-06-14T12:00:00.000Z",
    "finishedAt": "2026-06-14T12:00:14.000Z",
    "findings": [
      {
        "id": "0f204eac-17e5-42bc-93b1-0dd2aea57baa",
        "subject": "lineItem:550e8400-e29b-41d4-a716-446655440300",
        "severity": "error",
        "message": "Legal work is billed at $450/hr; this line item bills it at $600/hr.",
        "ruleId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "dismissedAt": 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

invoiceId

string<uuid>

required

Invoice identifier

Response

The invoice's latest bill review, or null if it has never been reviewed

billReview

object | null

An invoice's latest bill review — the run, its verdict, and the findings it raised. null when the invoice has never been reviewed.

Show child attributes

⌘I

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

Get Invoice Bill Review

Authorizations

Path Parameters

Response