Get Invoice
curl --request GET \
--url https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId} \
--header 'Authorization: <api-key>'import requests
url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}"
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}', 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}",
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}"
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}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}")
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{
"invoice": {
"id": "550e8400-e29b-41d4-a716-446655440700",
"invoiceNumber": "INV-389538-455",
"categoryId": "550e8400-e29b-41d4-a716-446655440100",
"status": "partially_paid",
"linkedEvent": {
"id": "550e8400-e29b-41d4-a716-446655440200",
"displayName": "Claim #1042"
},
"linkedPolicy": null,
"linkedPayee": null,
"incurredDate": "2026-06-01",
"dueDate": null,
"memo": "Legal defense",
"fieldData": null,
"lineItems": [
{
"lineItemId": "550e8400-e29b-41d4-a716-446655440300",
"lineItemTypeId": "550e8400-e29b-41d4-a716-446655440110",
"memo": null,
"amountCents": 10000
}
],
"totalAmountCents": 10000,
"amountPaidCents": 4000,
"balanceDueCents": 6000,
"draftAmountPaidCents": null,
"paidDate": null,
"lastPaymentDate": "2026-06-10",
"approved": true,
"approvedAt": "2026-06-10T09:00:00.000Z",
"voidedAt": null,
"deletedAt": null,
"createdAt": "2026-06-01T10:30:00.000Z",
"updatedAt": "2026-06-10T09:00:00.000Z",
"headJournalId": "550e8400-e29b-41d4-a716-446655440900"
},
"payments": [
{
"id": "550e8400-e29b-41d4-a716-446655440800",
"journalId": "550e8400-e29b-41d4-a716-446655440900",
"lineItemId": "550e8400-e29b-41d4-a716-446655440300",
"amountCents": 4000,
"paymentDate": "2026-06-10",
"erodeReserves": true,
"memo": "check #100",
"createdAt": "2026-06-10T09:00:00.000Z"
}
],
"headJournalId": "550e8400-e29b-41d4-a716-446655440900"
}Invoices
Get Invoice
Returns the whole current invoice document: the invoice, its live
payments (newest first), and headJournalId — the concurrency token
every subsequent write to this invoice sends as If-Match.
Unlike the listing, the detail read returns deleted invoices, so a
delete has a confirmable terminal state; 404 is reserved for an unknown
id.
Required permission: invoice.view
GET
/
api
/
v1
/
companies
/
{companyId}
/
financials
/
invoices
/
{invoiceId}
Get Invoice
curl --request GET \
--url https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId} \
--header 'Authorization: <api-key>'import requests
url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}"
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}', 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}",
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}"
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}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}")
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{
"invoice": {
"id": "550e8400-e29b-41d4-a716-446655440700",
"invoiceNumber": "INV-389538-455",
"categoryId": "550e8400-e29b-41d4-a716-446655440100",
"status": "partially_paid",
"linkedEvent": {
"id": "550e8400-e29b-41d4-a716-446655440200",
"displayName": "Claim #1042"
},
"linkedPolicy": null,
"linkedPayee": null,
"incurredDate": "2026-06-01",
"dueDate": null,
"memo": "Legal defense",
"fieldData": null,
"lineItems": [
{
"lineItemId": "550e8400-e29b-41d4-a716-446655440300",
"lineItemTypeId": "550e8400-e29b-41d4-a716-446655440110",
"memo": null,
"amountCents": 10000
}
],
"totalAmountCents": 10000,
"amountPaidCents": 4000,
"balanceDueCents": 6000,
"draftAmountPaidCents": null,
"paidDate": null,
"lastPaymentDate": "2026-06-10",
"approved": true,
"approvedAt": "2026-06-10T09:00:00.000Z",
"voidedAt": null,
"deletedAt": null,
"createdAt": "2026-06-01T10:30:00.000Z",
"updatedAt": "2026-06-10T09:00:00.000Z",
"headJournalId": "550e8400-e29b-41d4-a716-446655440900"
},
"payments": [
{
"id": "550e8400-e29b-41d4-a716-446655440800",
"journalId": "550e8400-e29b-41d4-a716-446655440900",
"lineItemId": "550e8400-e29b-41d4-a716-446655440300",
"amountCents": 4000,
"paymentDate": "2026-06-10",
"erodeReserves": true,
"memo": "check #100",
"createdAt": "2026-06-10T09:00:00.000Z"
}
],
"headJournalId": "550e8400-e29b-41d4-a716-446655440900"
}Authorizations
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
Company identifier
Invoice identifier
Response
The invoice, its live payments, and the concurrency token
THE invoice representation — the same shape everywhere an endpoint returns an invoice (listing rows, the detail read, and every write's refreshed-row response). headJournalId is the invoice's current journal head — the optimistic-concurrency token subsequent writes echo back as If-Match.
Show child attributes
Show child attributes
The invoice's live payments, newest first
Show child attributes
Show child attributes
The invoice's current journal head — the If-Match value for the next write (also carried on the invoice row)