Premium Reporting API

Note

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

Endpoint Index

Action	Endpoint
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
Reverse a premium report	PATCH /premiumReports/{premiumReportLocator}/reverse
Replace a premium report	POST /premiumReports/{premiumReportLocator}/replace

Details

Create a premium report¶

POST /policies/{policyLocator}/premiumReports

Request:

Name	Position	Type	Required
createRequest	body	PremiumReportCreateRequest	required
policyLocator	path	string	required

Response: PremiumReportResponse

Fetch a premium report¶

GET /premiumReports/{premiumReportLocator}

Request:

Name	Position	Type	Required
premiumReportLocator	path	string	required

Response: PremiumReportResponse

Fetch all premium reports for a policy¶

GET /policies/{policyLocator}/premiumReports

Request:

Name	Position	Type	Required
policyLocator	path	string	required

Response: [PremiumReportResponse]

Update a draft premium report¶

PATCH /premiumReports/{premiumReportLocator}

Request:

Name	Position	Type	Required
premiumReportLocator	path	string	required
updateRequest	body	PremiumReportUpdateRequest	required

Response: PremiumReportResponse

Issue a premium report¶

PATCH /premiumReports/{premiumReportLocator}/issue

Request:

Name	Position	Type	Required
premiumReportLocator	path	string	required

Response: PremiumReportResponse

Discard a premium report¶

PATCH /premiumReports/{premiumReportLocator}/discard

Request:

Name	Position	Type	Required
premiumReportLocator	path	string	required

Response: void

PremiumReportCreateRequest¶

required
endTimestamp timestamp
fieldValues map<string,[string]>
fieldGroups [FieldGroupCreateRequest]

optional
invoiceDueTimestamp timestamp
issue boolean

PremiumReportUpdateRequest¶

optional
endTimestamp timestamp
invoiceDueTimestamp timestamp
fieldValues map<string,[string]>
fieldGroups [FieldGroupCreateRequest]

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
documents [PremiumReportingDocumentResponse]
fieldValues map<string,[string]>
grossCommissions number
grossFees number
grossPremium number
grossTaxes number
commissions [CommissionResponse]
fees [FeeResponse]
fieldErrors FieldErrors
fieldGroupsByLocator map<string,map<string,[string]>>
premiums [PremiumReportPremiumResponse]
taxGroups [TaxGroupResponse]
configVersion integer

optional
replacedTimestamp timestamp
reversedTimestamp timestamp
invoice PremiumReportingInvoiceResponse
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
documents [PremiumReportingDocumentResponse]
totalDue number
invoiceType string newBusiness | endorsement | renewal | cancellation | reinstatement | installment | premiumReporting | catchUp | other
payments [PremiumReportingPaymentResponse]
premiumReportLocator string
premiumReportName string
settlementStatus string outstanding | settled
statuses [PremiumReportingInvoiceStatusAndTimeResponse]
transactionIssued boolean

optional
settlementType string paid | writtenOff | zeroDue | invalidated | carriedForward
totalDueCurrency string

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
invoiceLocator string
mediaByLocator map<string,Media>
tenantLocator string

optional
reversedTimestamp timestamp
amountCurrency string

PremiumReportingInvoiceStatusAndTimeResponse¶

required
timestamp timestamp
status string unfulfilled | paid | writtenOff | zeroDue | invalidated | carriedForward

Reversals

Reverse a premium report¶

PATCH /premiumReports/{premiumReportLocator}/reverse

Request:

Name	Position	Type	Required
premiumReportLocator	path	string	required

Response: PremiumReportResponse

Replacements

Replace a premium report¶

POST /premiumReports/{premiumReportLocator}/replace

Request:

Name	Position	Type	Required
premiumReportLocator	path	string	required
replaceRequest	body	PremiumReportReplacementRequest	required

Response: PremiumReportResponse

PremiumReportReplacementRequest¶

required
fieldValues map<string,[string]>
fieldGroups [FieldGroupCreateRequest]

optional
invoiceDueTimestamp timestamp