{
"total": 123,
"offset": 123,
"limit": 123,
"data": [
{
"claimsHistory": [
{
"year": 123,
"claimsNumber": 123,
"fleetSize": 123
}
],
"owners": [
{
"userId": "<string>",
"email": "<string>",
"roles": [
{
"productId": "<string>",
"roleId": "<string>"
}
]
}
],
"type": "<string>",
"id": "<string>",
"productId": "<string>",
"createdAt": "<string>",
"lastModifiedAt": "<string>",
"status": "POLICY_CREATED",
"assets": [
"<string>"
],
"periodDuration": {
"amount": 123,
"unit": "YEAR"
},
"invoicingConfig": {
"frequency": "YEARLY",
"reconciliationMethod": "INSTANT",
"timing": "IN_ADVANCE",
"billAtSignature": "EARLY_PAYMENT",
"spread": "DYNAMIC",
"earlyPayment": {
"amount": 123,
"unit": "YEAR"
}
},
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"name": "<string>",
"parent": "<string>",
"brokerageFirm": "<string>",
"incrementalId": 123,
"externalId": "<string>",
"branchType": "BASE",
"author": {
"firstName": "<string>",
"lastName": "<string>",
"userId": "<string>",
"email": "<string>",
"brokerRole": "<string>"
},
"signedAt": "<string>",
"startedAt": "<string>",
"endedAt": "<string>",
"stoppedAt": "<string>",
"suspendedAt": "<string>",
"customer": "<string>",
"acceptedEmailDomains": [
"<string>"
],
"acceptedQuoteOptions": {
"availableConfigs": [
{
"tier": "<string>",
"excess": "<string>",
"perils": [
{
"id": "<string>",
"required": true,
"options": [
"<string>"
]
}
]
}
],
"defaultConfig": {
"tier": "<string>",
"excess": "<string>",
"perils": [
{
"id": "<string>",
"option": "<string>"
}
]
}
},
"additionalQuoteComponents": {
"id": "<string>",
"type": "PREMIUM",
"premium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"chargeType": "ONE_TIME"
},
"quote": {
"id": "<string>",
"entityId": "<string>",
"provider": {
"id": "<string>",
"version": "<string>"
},
"rates": [
{
"id": "<string>",
"rate": 123,
"inputs": [
{
"id": "<string>",
"value": "<string>"
}
]
}
],
"totalPremium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"components": [
{
"id": "<string>",
"type": "PREMIUM",
"premium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"chargeType": "ONE_TIME"
}
],
"basePrice": 123
},
"maximumNumberOfBikes": 123,
"stop": {
"reason": "<string>",
"details": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"brokerageFees": [
{
"brokerageFirmId": "<string>",
"fee": 50
}
]
}
]
}{
"total": 123,
"offset": 123,
"limit": 123,
"data": [
{
"claimsHistory": [
{
"year": 123,
"claimsNumber": 123,
"fleetSize": 123
}
],
"owners": [
{
"userId": "<string>",
"email": "<string>",
"roles": [
{
"productId": "<string>",
"roleId": "<string>"
}
]
}
],
"type": "<string>",
"id": "<string>",
"productId": "<string>",
"createdAt": "<string>",
"lastModifiedAt": "<string>",
"status": "POLICY_CREATED",
"assets": [
"<string>"
],
"periodDuration": {
"amount": 123,
"unit": "YEAR"
},
"invoicingConfig": {
"frequency": "YEARLY",
"reconciliationMethod": "INSTANT",
"timing": "IN_ADVANCE",
"billAtSignature": "EARLY_PAYMENT",
"spread": "DYNAMIC",
"earlyPayment": {
"amount": 123,
"unit": "YEAR"
}
},
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"name": "<string>",
"parent": "<string>",
"brokerageFirm": "<string>",
"incrementalId": 123,
"externalId": "<string>",
"branchType": "BASE",
"author": {
"firstName": "<string>",
"lastName": "<string>",
"userId": "<string>",
"email": "<string>",
"brokerRole": "<string>"
},
"signedAt": "<string>",
"startedAt": "<string>",
"endedAt": "<string>",
"stoppedAt": "<string>",
"suspendedAt": "<string>",
"customer": "<string>",
"acceptedEmailDomains": [
"<string>"
],
"acceptedQuoteOptions": {
"availableConfigs": [
{
"tier": "<string>",
"excess": "<string>",
"perils": [
{
"id": "<string>",
"required": true,
"options": [
"<string>"
]
}
]
}
],
"defaultConfig": {
"tier": "<string>",
"excess": "<string>",
"perils": [
{
"id": "<string>",
"option": "<string>"
}
]
}
},
"additionalQuoteComponents": {
"id": "<string>",
"type": "PREMIUM",
"premium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"chargeType": "ONE_TIME"
},
"quote": {
"id": "<string>",
"entityId": "<string>",
"provider": {
"id": "<string>",
"version": "<string>"
},
"rates": [
{
"id": "<string>",
"rate": 123,
"inputs": [
{
"id": "<string>",
"value": "<string>"
}
]
}
],
"totalPremium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"components": [
{
"id": "<string>",
"type": "PREMIUM",
"premium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"chargeType": "ONE_TIME",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
},
"chargeType": "ONE_TIME"
}
],
"basePrice": 123
},
"maximumNumberOfBikes": 123,
"stop": {
"reason": "<string>",
"details": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"brokerageFees": [
{
"brokerageFirmId": "<string>",
"fee": 50
}
]
}
]
}Optional: the whenAt datetime
Optional: the simulatedAt datetime
Optional: the branchId
The productId
the pagination offset
the pagination page size
retrieve only signed policies
list policies of a specific brokerage firm (requires the permission brokerage-firm:policies:list-all)
Total number of policies
Offset used for pagination
Page size used for pagination
List of policies
Show child attributes
Owners of the entity
Entity type
Unique identifier for the policy
Product ID
Date and time when the policy was created
Date and time when the policy was last modified
Status of the policy
POLICY_CREATED, POLICY_QUOTED, POLICY_CONFIRMED, POLICY_STARTED, POLICY_STOPPED, POLICY_SUSPENDED Array of asset identifiers associated with the policy
Nested DTO for invoicing configuration
Show child attributes
YEARLY, MONTHLY, BIENNIAL, WEEKLY INSTANT IN_ADVANCE, IN_ARREAR EARLY_PAYMENT, FULL, NONE DYNAMIC Optional: Name of the entity
Unique identifier for the parent policy
Unique identifier for the brokerage firm
Incremental policy id
External policy id
Type of branch associated with the policy
BASE, NEW_BUSINESS, MTA, RENEWAL, REPRICING Date and time when the policy was signed
Date and time when the policy started
Date and time when the policy will end
Date and time when the policy stopped
Date and time when the policy was suspended
Optional: Identifier of the customer associated with the policy
Accepted Email Domains
Show child attributes
Show child attributes
Show child attributes
Show child attributes
PREMIUM, PERIL, FEE, TAX, SPECIAL Show child attributes
Show child attributes
ONE_TIME, SPOT, RECURRING Charge type of component
ONE_TIME, SPOT, RECURRING policy quote
Show child attributes
Quote id
Entity the quote is for
Show child attributes
components of the quote
Show child attributes
PREMIUM, PERIL, FEE, TAX, SPECIAL Show child attributes
Charge type of component
ONE_TIME, SPOT, RECURRING max number of bike
Was this page helpful?