Premium Reporting API

Note

See the Premium Reporting feature topic for details about how to use this API.

Endpoint Index

ActionEndpoint
Create a premium reportPOST /policies/{policyLocator}/premiumReports
Fetch a premium reportGET /premiumReports/{premiumReportLocator}
Fetch all premium reports for a policyGET /policies/{policyLocator}/premiumReports
Update a draft premium reportPATCH /premiumReports/{premiumReportLocator}
Issue a premium reportPATCH /premiumReports/{premiumReportLocator}/issue
Discard a premium reportPATCH /premiumReports/{premiumReportLocator}/discard
Reverse a premium reportPATCH /premiumReports/{premiumReportLocator}/reverse
Replace a premium reportPOST /premiumReports/{premiumReportLocator}/replace

Details

Create a premium report
POST /policies/{policyLocator}/premiumReports
Fetch a premium report
GET /premiumReports/{premiumReportLocator}
Fetch all premium reports for a policy
GET /policies/{policyLocator}/premiumReports
Update a draft premium report
PATCH /premiumReports/{premiumReportLocator}
Issue a premium report
PATCH /premiumReports/{premiumReportLocator}/issue
Discard a premium report
PATCH /premiumReports/{premiumReportLocator}/discard
    Request:
    NamePositionTypeRequired
    premiumReportLocatorpathstringrequired
    Response: void
PremiumReportCreateRequest
required
endTimestamp timestamp
fieldValues map<string,[string]>

optional
invoiceDueTimestamp timestamp
issue boolean
PremiumReportUpdateRequest
optional
endTimestamp timestamp
invoiceDueTimestamp timestamp
fieldValues map<string,[string]>
PremiumReportResponse
required
locator string
displayId string
policyLocator string
state string draft | discarded | issued | reversed
createdTimestamp timestamp
updatedTimestamp timestamp
issuedTimestamp timestamp
startTimestamp timestamp
endTimestamp timestamp
invoiceDueTimestamp timestamp
fieldValues map<string,[string]>
grossCommissions number
grossFees number
grossPremium number
grossTaxes number
commissions [CommissionResponse]
fees [FeeResponse]
fieldErrors FieldErrors
fieldGroupsByLocator map<string,map<string,[string]>>
taxGroups [TaxGroupResponse]
configVersion integer

optional
replacedTimestamp timestamp
reversedTimestamp timestamp
replacedByLocator string
replacementOfLocator string
PremiumReportPremiumResponse
required
premium number
category string
PremiumReportingInvoiceResponse
required
locator string
displayId string
policyholderLocator string
policyLocator string
createdTimestamp timestamp
updatedTimestamp timestamp
dueTimestamp timestamp
startTimestamp timestamp
endTimestamp timestamp
totalDue number
premiumReportLocator string
premiumReportName string
settlementStatus string outstanding | settled
totalDueCurrency string

optional
settlementType string paid | writtenOff | zeroDue | invalidated | carriedForward
PremiumReportingDocumentResponse
required
locator string
urlExpirationTimestamp timestamp
displayName string
fileName string
premiumReportLocator string
type string pdf | html
url string

optional
createdTimestamp timestamp
PremiumReportingPaymentResponse
required
locator string
displayId string
policyholderLocator string
postedTimestamp timestamp
fieldValues map<string,[string]>
amount number
amountCurrency string
invoiceLocator string
mediaByLocator map<string,Media>
tenantLocator string

optional
reversedTimestamp timestamp
PremiumReportingInvoiceStatusAndTimeResponse
required
timestamp timestamp
status string unfulfilled | paid | writtenOff | zeroDue | invalidated | carriedForward

Reversals

Reverse a premium report
PATCH /premiumReports/{premiumReportLocator}/reverse

Replacements

Replace a premium report
POST /premiumReports/{premiumReportLocator}/replace
PremiumReportReplacementRequest
required
fieldValues map<string,[string]>

optional
invoiceDueTimestamp timestamp

Errors

FieldErrors
required
fieldGroupErrors [FieldGroupErrors]
hasErrors boolean

optional
errorMessage string
FieldGroupErrors
required
fieldName string

optional
locator string
index integer
ValidationFieldError
required
code string MISSING | INVALID_FIELD | INVALID_TYPE | INVALID_VALUE
fieldName string

optional
message string