Download Bordereau CSV

Downloads the bordereau report as a CSV file. Returns the same transaction-level premium data as the List Bordereau Rows endpoint, serialized as RFC 4180 CSV with a Content-Disposition: attachment header.

The CSV includes fixed columns (Policy Number, Insured Name, Transaction Action, Policy Version, Effective Date, Transaction Timestamp, Policy Start Date, Policy End Date, Created At, Created By, Policy Premium, Policy Premium Change) plus any additional columns specified via the additionalColumns parameter.

Default limit is 50,000 rows (maximum 50,000).

Required permission: company.policy:read

GET /api/v1/external/companies/{companyId}/policies/bordereau/download

Download Bordereau CSV

cURL

curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/bordereau/download \
  --header 'Authorization: <api-key>'

200

csvOutput

"Policy Number,Insured Name,Transaction Action,Policy Version,Effective Date,Transaction Timestamp,Policy Start Date,Policy End Date,Created At,Created By,Policy Premium,Policy Premium Change\nPOL-2025-001,Mercy General Hospital,NEW_BUSINESS,1,2025-01-01,2025-01-15T10:30:00.000Z,2025-01-01,2026-01-01,2025-01-15T10:30:00.000Z,api-key|abc123,85000,85000\nPOL-2025-001,Mercy General Hospital,ENDORSE,2,2025-06-01,2025-06-01T14:00:00.000Z,2025-01-01,2026-01-01,2025-06-01T14:00:00.000Z,api-key|abc123,102000,17000\n"

Authorizations

Authorization · string · header · required

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

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). These columns are appended after the fixed columns.

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: 50000

Maximum number of rows to include. Default and maximum 50,000.

Required range: 1 <= x <= 50000

offset · integer · default: 0

Number of rows to skip before starting the export. Default 0.

Required range: x >= 0

Response

200

text/csv

CSV file download

The response is of type string.