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}/status

Request:

Name	Position	Type	Required
reportLocator	path	string	required

Response: ReportStatusResponse

ReportStatusResponse¶

required
locator string
createdTimestamp timestamp
updatedTimestamp timestamp
status string started | complete | failed

optional
error string
resultUrl 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¶

optional
reportEndTimestamp timestamp
reportStartTimestamp timestamp
reportTimestamp timestamp
exposureFields [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/onRisk

Request:

Name	Position	Type	Required
request	body	PolicyReportRequest	required

Response: RunReportResponse

Note: The optional reportTimestamp is required for the On Risk report.

Run the All Policies report¶

POST /report/allPolicies

Request:

Name	Position	Type	Required
request	body	PolicyReportRequest	required

Response: RunReportResponse

Note: The optional reportStartTimestamp and reportEndTimestamp are required for the All Policies report.

Run the Financial Transactions report¶

POST /report/financialTransaction

Request:

Name	Position	Type	Required
request	body	FinancialTransactionReportRequest	required

Response: RunReportResponse

Run the Paid Financial Transactions report¶

POST /report/paidFinancialTransaction

Request:

Name	Position	Type	Required
request	body	FinancialTransactionReportRequest	required

Response: RunReportResponse

FinancialTransactionReportRequest¶

required
startTimestamp timestamp
endTimestamp timestamp

Run the Unearned Premium Accounts Receivable report¶

POST /report/unearnedPremium/accountsReceivable

Request:

Name	Position	Type	Required
request	body	UnearnedPremiumReportRequest	required

Response: RunReportResponse

UnearnedPremiumReportRequest¶

required
reportTimestamp timestamp

Run the Payable Commissions report¶

POST /report/payableCommissions

Request:

Name	Position	Type	Required
request	body	PayableCommissionsReportRequest	required

Response: RunReportResponse

PayableCommissionsReportRequest¶

required
startTimestamp timestamp
endTimestamp timestamp

Run the Reserves report¶

POST /report/claim/reserves

Request:

Name	Position	Type	Required
request	body	ReservesReportRequest	required

Response: RunReportResponse

ReservesReportRequest¶

required
reportTimestamp timestamp

Run the Claims report¶

POST /report/claim

Request:

Name	Position	Type	Required
request	body	ClaimsReportRequest	required

Response: RunReportResponse

ClaimsReportRequest¶

required
reportTimestamp timestamp

Run the Claims Payables report¶

POST /report/claim/payables

Request:

Name	Position	Type	Required
request	body	ClaimsPayablesReportRequest	required

Response: RunReportResponse

ClaimsPayablesReportRequest¶

required
startTimestamp timestamp
endTimestamp timestamp

RunReportResponse¶

required
locator string