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"
}
'
{
  "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 key in the Authorization header: Authorization: ApiKey YOUR-API-KEY

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