Skip to main content
GET
/
api
/
v1
/
external
/
companies
/
{companyId}
/
policies
/
bordereau
List Bordereau Rows
curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/bordereau \
  --header 'Authorization: <api-key>'
{
  "items": [
    {
      "policyNumber": "POL-2025-001",
      "primaryInsuredName": "Mercy General Hospital",
      "transactionAction": "NEW_BUSINESS",
      "policyVersion": 1,
      "effectiveDate": "2025-01-01",
      "transactionTimestamp": "2025-01-15T10:30:00.000Z",
      "policyStartDate": "2025-01-01",
      "policyEndDate": "2026-01-01",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "createdBy": "api-key|abc123",
      "policyPremium": 85000,
      "policyPremiumChange": 85000,
      "additionalColumns": {}
    },
    {
      "policyNumber": "POL-2025-001",
      "primaryInsuredName": "Mercy General Hospital",
      "transactionAction": "ENDORSE",
      "policyVersion": 2,
      "effectiveDate": "2025-06-01",
      "transactionTimestamp": "2025-06-01T14:00:00.000Z",
      "policyStartDate": "2025-01-01",
      "policyEndDate": "2026-01-01",
      "createdAt": "2025-06-01T14:00:00.000Z",
      "createdBy": "api-key|abc123",
      "policyPremium": 102000,
      "policyPremiumChange": 17000,
      "additionalColumns": {}
    }
  ],
  "totalCount": 2
}

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

​
periodStart
string<date-time>

Inclusive lower bound on transactionTimestamp. Only transactions at or after this timestamp are included.

​
periodEnd
string<date-time>

Exclusive upper bound on transactionTimestamp. Only transactions before this timestamp are included.

​
actions
string

Comma-separated list of transaction actions to include. Valid values: NEW_BUSINESS, ENDORSE, CANCEL, REINSTATE, RENEW. Omit to include all actions.

Note: Unrecognized action values are not rejected — they silently match zero rows. Double-check spelling if results are unexpectedly empty.

​
additionalColumns
string

JSON-encoded array of additional column definitions. Each element is an object with path (dot-separated path into the segment's policy data) and columnHeader (display name for the column).

Each path MUST begin with one of the policy-root FullTerm containers: fullTermPolicyInfo., fullTermPolicyBillingInfo., or fullTermPolicyRatingResult.. A non-FullTerm or per-segment path (e.g. a bare top-level key like carrier) is rejected with HTTP 400 (InvalidProperties).

​
sortBy
enum<string>

Field to sort results by. Default transactionTimestamp.

Available options:
policyNumber,
primaryInsuredName,
effectiveDate,
transactionTimestamp,
createdAt
​
sortDirection
enum<string>
default:desc

Sort direction (default desc).

Available options:
asc,
desc
​
limit
integer
default:50

Maximum number of rows to return per request. Default 50, maximum 1000.

Required range: 1 <= x <= 1000
​
offset
integer
default:0

Number of rows to skip before returning results. Default 0.

Required range: x >= 0

Response

Paginated list of bordereau rows

Paginated bordereau response containing transaction-level premium rows.

​
items
object[]
required

Bordereau rows for the current page.

​
totalCount
integer
required

Total number of matching rows across all pages.