Export Bordereau to Google Sheets
Exports the bordereau report to a Google Sheets spreadsheet. Writes the same transaction-level premium data as the List Bordereau Rows endpoint into a Google Sheets tab.
Provide either spreadsheetId (to write into an existing spreadsheet) or
folderId (to create a new spreadsheet in that Google Drive folder). When using
folderId, the spreadsheet name defaults to
"{companyShortName}-bordereau-export {UTC timestamp}" unless overridden via
spreadsheetName.
The caller must supply a googleOAuthToken with write access to the target
spreadsheet or folder.
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
Body
Google OAuth2 access token with write access to the target spreadsheet or folder.
ID of an existing Google Sheets spreadsheet to write into.
Mutually exclusive with folderId — provide one or the other.
Google Drive folder ID in which to create a new spreadsheet.
Mutually exclusive with spreadsheetId — provide one or the other.
Custom name for the created spreadsheet. Only used when folderId is
provided. Defaults to "{companyShortName}-bordereau-export {UTC timestamp}".
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.
Transaction actions to include. Omit to include all actions.
NEW_BUSINESS, ENDORSE, CANCEL, REINSTATE, RENEW Ordered column specs that COMPLETELY describe 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. A path that does not exist in the policy
data yields an empty cell. Omit for the default column set
(the fixed 12).
One column of a fully caller-ordered bordereau — the single column-selection
mechanism on every bordereau endpoint. On the rendered surfaces (CSV
download, Google Sheets export) an ordered columns array is the COMPLETE
column set: the fixed columns become selectable, omittable, and reorderable,
and configured field columns (resolved per row as of the transaction's
effective date) interleave anywhere. On the typed-JSON list endpoint only
field entries are accepted (they select into each row's fieldColumns
map); a fixed entry there is rejected with HTTP 400, since the JSON rows
always carry every fixed property.
Two kinds:
fixed— one of the 12 built-in transaction-metadata columns, addressed by key; the column header comes from the built-in registry (e.g.policyNumber→ "Policy Number").field— a dot-separated path into the policy's field data plus the displayheaderfor the column. A path absent from the policy data yields an empty cell.
- Option 1
- Option 2
Policy filters restricting 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.
Structured per-field filter against FMV1 field data or system columns. Each filter names a fieldReferenceId, a fieldType tag, an operator, and a value (plus valueTo for between and systemColumn for systemUser / systemDate). The set of operators and the value shape depend on fieldType. Pass one or more filters in the filters query parameter — multiple filters are combined with AND semantics.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
Field to sort results by. Default transactionTimestamp.
policyNumber, primaryInsuredName, effectiveDate, transactionTimestamp, createdAt Sort direction (default desc).
asc, desc Maximum number of rows to export. Default and maximum 50,000.
1 <= x <= 50000Number of rows to skip before starting the export. Default 0.
x >= 0Response
Bordereau exported to Google Sheets