Skip to main content
PATCH
/
api
/
external
/
companies
/
{companyId}
/
events
/
{eventId}
/
financials
/
transactions
/
{transactionId}
Void Event Transaction
curl --request PATCH \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/events/{eventId}/financials/transactions/{transactionId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "void",
  "voidReason": "Duplicate invoice"
}
'
import requests

url = "https://app.aiinsurance.io/api/external/companies/{companyId}/events/{eventId}/financials/transactions/{transactionId}"

payload = {
"status": "void",
"voidReason": "Duplicate invoice"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'void', voidReason: 'Duplicate invoice'})
};

fetch('https://app.aiinsurance.io/api/external/companies/{companyId}/events/{eventId}/financials/transactions/{transactionId}', 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://app.aiinsurance.io/api/external/companies/{companyId}/events/{eventId}/financials/transactions/{transactionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'void',
'voidReason' => 'Duplicate invoice'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://app.aiinsurance.io/api/external/companies/{companyId}/events/{eventId}/financials/transactions/{transactionId}"

payload := strings.NewReader("{\n \"status\": \"void\",\n \"voidReason\": \"Duplicate invoice\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://app.aiinsurance.io/api/external/companies/{companyId}/events/{eventId}/financials/transactions/{transactionId}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"void\",\n \"voidReason\": \"Duplicate invoice\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/events/{eventId}/financials/transactions/{transactionId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"void\",\n \"voidReason\": \"Duplicate invoice\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "eventId": "550e8400-e29b-41d4-a716-446655440001",
  "payeeId": "550e8400-e29b-41d4-a716-446655440050",
  "transactionType": "indemnity_invoice",
  "status": "void",
  "amount": 500000,
  "invoiceNumber": "INV-2025-001",
  "invoiceDate": "2025-01-15",
  "dueDate": "2025-02-15",
  "paidDate": null,
  "description": "Initial claim payment",
  "voidReason": "Duplicate invoice",
  "isDraft": false,
  "isForwardedInvoice": false,
  "lineItems": [],
  "createdAt": "2025-01-15T10:30:00.000Z",
  "createdBy": "google-oauth2|123456789",
  "updatedAt": "2025-02-17T12:00:00.000Z",
  "updatedBy": null
}

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId
string<uuid>
required

Company identifier

eventId
string<uuid>
required

Event identifier

transactionId
string<uuid>
required

Transaction identifier

Body

application/json

Request body for voiding an event transaction

status
enum<string>
required

Must be "void"

Available options:
void
voidReason
string
required

Reason for voiding the transaction

Response

Voided transaction details

A financial transaction with full details including line items

id
string<uuid>

Transaction identifier

eventId
string<uuid>

Associated event identifier

payeeId
string<uuid> | null

Associated payee identifier

transactionType
string

Transaction category identifier (e.g., "indemnity_invoice", "alae_invoice")

status
enum<string>

Status of a financial transaction

Available options:
owed,
paid,
approved,
void
amount
integer

Transaction amount in cents

invoiceNumber
string | null

Invoice number for the transaction

invoiceDate
string<date> | null

Invoice date (YYYY-MM-DD)

dueDate
string<date> | null

Payment due date (YYYY-MM-DD)

paidDate
string<date> | null

Date the transaction was paid (YYYY-MM-DD)

description
string | null

Transaction description

voidReason
string | null

Reason for voiding the transaction (only present if status is void)

isDraft
boolean

Whether the transaction is a draft

isForwardedInvoice
boolean

Whether the transaction is a forwarded invoice

createdAt
string<date-time>

When the transaction was created (ISO 8601)

createdBy
string | null

User ID who created the transaction

updatedAt
string<date-time> | null

When the transaction was last updated (ISO 8601)

updatedBy
string | null

User ID who last updated the transaction

lineItems
object[]

Line items (itemizations) for the transaction