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}/premiumReportsRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| createRequest | body | PremiumReportCreateRequest | required |
| policyLocator | path | string | required |
Response:
PremiumReportResponseFetch a premium report¶
GET /premiumReports/{premiumReportLocator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| premiumReportLocator | path | string | required |
Response:
PremiumReportResponseFetch all premium reports for a policy¶
GET /policies/{policyLocator}/premiumReportsRequest:
| 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:
PremiumReportResponseIssue a premium report¶
PATCH /premiumReports/{premiumReportLocator}/issueRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| premiumReportLocator | path | string | required |
Response:
PremiumReportResponseDiscard a premium report¶
PATCH /premiumReports/{premiumReportLocator}/discardRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| premiumReportLocator | path | string | required |
Response:
voidPremiumReportCreateRequest¶
requiredendTimestamp timestampfieldValues map<string,[string]>fieldGroups [FieldGroupCreateRequest]optionalinvoiceDueTimestamp timestampissue boolean
PremiumReportUpdateRequest¶
optionalendTimestamp timestampinvoiceDueTimestamp timestampfieldValues map<string,[string]>fieldGroups [FieldGroupCreateRequest]
PremiumReportResponse¶
requiredlocator stringdisplayId stringpolicyLocator stringstate string draft | discarded | issued | reversedcreatedTimestamp timestampupdatedTimestamp timestampissuedTimestamp timestampstartTimestamp timestampendTimestamp timestampinvoiceDueTimestamp timestampdocuments [PremiumReportingDocumentResponse]fieldValues map<string,[string]>grossCommissions numbergrossFees numbergrossPremium numbergrossTaxes numbercommissions [CommissionResponse]fees [FeeResponse]fieldErrors FieldErrorsfieldGroupsByLocator map<string,map<string,[string]>>premiums [PremiumReportPremiumResponse]taxGroups [TaxGroupResponse]configVersion integeroptionalreplacedTimestamp timestampreversedTimestamp timestampinvoice PremiumReportingInvoiceResponsereplacedByLocator stringreplacementOfLocator string
PremiumReportPremiumResponse¶
requiredpremium numbercategory string
PremiumReportingInvoiceResponse¶
requiredlocator stringdisplayId stringpolicyholderLocator stringpolicyLocator stringcreatedTimestamp timestampupdatedTimestamp timestampdueTimestamp timestampstartTimestamp timestampendTimestamp timestampdocuments [PremiumReportingDocumentResponse]totalDue numberpayments [PremiumReportingPaymentResponse]premiumReportLocator stringpremiumReportName stringsettlementStatus string outstanding | settledstatuses [PremiumReportingInvoiceStatusAndTimeResponse]totalDueCurrency stringoptionalsettlementType string paid | writtenOff | zeroDue | invalidated | carriedForward
PremiumReportingDocumentResponse¶
requiredlocator stringurlExpirationTimestamp timestampdisplayName stringfileName stringpremiumReportLocator stringtype string pdf | htmlurl stringoptionalcreatedTimestamp timestamp
PremiumReportingPaymentResponse¶
requiredlocator stringdisplayId stringpolicyholderLocator stringpostedTimestamp timestampfieldValues map<string,[string]>amount numberamountCurrency stringinvoiceLocator stringmediaByLocator map<string,Media>tenantLocator stringoptionalreversedTimestamp timestamp
PremiumReportingInvoiceStatusAndTimeResponse¶
requiredtimestamp timestampstatus string unfulfilled | paid | writtenOff | zeroDue | invalidated | carriedForward
Reversals
Reverse a premium report¶
PATCH /premiumReports/{premiumReportLocator}/reverseRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| premiumReportLocator | path | string | required |
Response:
PremiumReportResponseReplacements
Replace a premium report¶
POST /premiumReports/{premiumReportLocator}/replaceRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| premiumReportLocator | path | string | required |
| replaceRequest | body | PremiumReportReplacementRequest | required |
Response:
PremiumReportResponsePremiumReportReplacementRequest¶
requiredfieldValues map<string,[string]>fieldGroups [FieldGroupCreateRequest]optionalinvoiceDueTimestamp timestamp