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.
By default the CSV includes the 12 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).
To take full control of the column set — selecting, omitting, and
reordering the fixed columns, with field columns interleaved anywhere —
pass columns: an ordered array that completely describes the output.
Default limit is 50,000 rows (maximum 50,000).
Required permission: company.policy:read
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
Query Parameters
Inclusive lower bound on transactionTimestamp. Only transactions at or after
this timestamp are included.
Exclusive upper bound on transactionTimestamp. Only transactions before
this timestamp are included.
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.
JSON-encoded ordered array of column specs (see BordereauColumnSpec)
that COMPLETELY describes the output columns: fixed columns become
selectable, omittable, and reorderable, and field columns
({"kind":"field"} entries — a dot-path into the policy's field data
plus a display header, resolved per row as of the transaction's
effective date) interleave anywhere. Omit for the default column set
(the fixed 12).
JSON-encoded array of policy filters (see FieldModelV1ListFilter).
Restricts the export to transactions of the policies whose CURRENT
segment matches every filter — the filter selects the policies, then all
of each matching policy's transactions in the period are included. Omit
to include every policy. Same field-filter model as the
Policy List filters
parameter (field types text, number, boolean, date, currency,
optionSet, address, join, and the list-cardinality types).
Field to sort results by. Default transactionTimestamp.
policyNumber, primaryInsuredName, effectiveDate, transactionTimestamp, createdAt Sort direction (default desc).
asc, desc Maximum number of rows to include. Default and maximum 50,000.
1 <= x <= 50000Number of rows to skip before starting the export. Default 0.
x >= 0Response
CSV file download
The response is of type string.
