Reporting API
See the Reporting topic for information about the contents of each report.
Endpoint Index
| Action | Endpoint |
|---|---|
| Fetch report status | GET /report/{reportLocator}/status |
| Run the On-Risk report | POST /report/onRisk |
| Run the All Policies report | POST /report/allPolicies |
| Run the Financial Transactions report | POST /report/financialTransaction |
| Run the Paid Financial Transactions report | POST /report/paidFinancialTransaction |
| Run the Unearned Premium Accounts Receivable report | POST /report/unearnedPremium/accountsReceivable |
| Run the Payable Commissions report | POST /report/payableCommissions |
| Run the Reserves report | POST /report/claim/reserves |
| Run the Claims report | POST /report/claim |
| Run the Claims Payables report | POST /report/claim/payables |
Details
Fetch report status¶
GET /report/{reportLocator}/statusRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| reportLocator | path | string | required |
Response:
ReportStatusResponseReportStatusResponse¶
requiredlocator stringcreatedTimestamp timestampupdatedTimestamp timestampstatus string started | complete | failedoptionalerror stringresultUrl string
Note
If no records are found for a report then the resultUrl field on ReportStatusResponse will be null even after the status is complete.
PolicyReportRequest¶
optionalreportEndTimestamp timestampreportStartTimestamp timestampreportTimestamp timestampexposureFields [string]perilFields [string]policyFields [string]productNames [string]
Note: If productNames is empty, then the corresponding report will also be empty.
Run the On-Risk report¶
POST /report/onRiskRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| request | body | PolicyReportRequest | required |
Response:
RunReportResponseNote: The optional reportTimestamp is required for the On Risk report.
Run the All Policies report¶
POST /report/allPoliciesRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| request | body | PolicyReportRequest | required |
Response:
RunReportResponseNote: The optional reportStartTimestamp and reportEndTimestamp are required for the All Policies report.
Run the Financial Transactions report¶
POST /report/financialTransactionRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| request | body | FinancialTransactionReportRequest | required |
Response:
RunReportResponseRun the Paid Financial Transactions report¶
POST /report/paidFinancialTransactionRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| request | body | FinancialTransactionReportRequest | required |
Response:
RunReportResponseFinancialTransactionReportRequest¶
requiredstartTimestamp timestampendTimestamp timestamp
Run the Unearned Premium Accounts Receivable report¶
POST /report/unearnedPremium/accountsReceivableRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| request | body | UnearnedPremiumReportRequest | required |
Response:
RunReportResponseUnearnedPremiumReportRequest¶
requiredreportTimestamp timestamp
Run the Payable Commissions report¶
POST /report/payableCommissionsRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| request | body | PayableCommissionsReportRequest | required |
Response:
RunReportResponsePayableCommissionsReportRequest¶
requiredstartTimestamp timestampendTimestamp timestamp
Run the Reserves report¶
POST /report/claim/reservesRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| request | body | ReservesReportRequest | required |
Response:
RunReportResponseReservesReportRequest¶
requiredreportTimestamp timestamp
Run the Claims report¶
POST /report/claimRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| request | body | ClaimsReportRequest | required |
Response:
RunReportResponseClaimsReportRequest¶
requiredreportTimestamp timestamp
Run the Claims Payables report¶
POST /report/claim/payablesRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| request | body | ClaimsPayablesReportRequest | required |
Response:
RunReportResponseClaimsPayablesReportRequest¶
requiredstartTimestamp timestampendTimestamp timestamp
RunReportResponse¶
requiredlocator string