Skip to main content
POST
/
view-specific
/
{brokerageFirmId}
/
policies
{
  "data": [
    {
      "customerId": "<string>",
      "policyId": "<string>",
      "branches": [
        {
          "policy": {
            "id": "<string>",
            "productId": "<string>",
            "createdAt": "<string>",
            "lastModifiedAt": "<string>",
            "status": "POLICY_CREATED",
            "hasOpenedClientAccount": true,
            "customFields": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ],
            "externalId": "<string>",
            "author": {
              "firstName": "<string>",
              "lastName": "<string>",
              "userId": "<string>",
              "email": "<string>",
              "brokerRole": "<string>"
            },
            "startedAt": "<string>",
            "stoppedAt": "<string>",
            "totalPremium": {
              "amountPreFeesAndTaxes": 123,
              "totalFees": 123,
              "amountWithFeesPreTaxes": 123,
              "totalTaxes": 123,
              "amountWithFeesAndTaxes": 123
            }
          },
          "branch": {
            "branchId": "<string>",
            "createdAt": "<string>",
            "branchType": "BASE",
            "renewalStatus": "RENEWAL_ACCEPTED",
            "branchSubType": "CREATE_ADDITIONAL_COMPONENTS",
            "availability": "BRANCH_OPEN",
            "closeReason": "BROKER_REQUEST",
            "mergedAt": "<string>"
          },
          "customer": {
            "type": "<string>",
            "id": "<string>",
            "createdAt": "<string>",
            "lastModifiedAt": "<string>",
            "status": "CUSTOMER_CREATED",
            "paymentMode": "DIRECT_DEBIT",
            "customFields": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ],
            "name": "<string>"
          },
          "assets": [
            {
              "id": "<string>",
              "lastModifiedAt": "<string>",
              "createdAt": "<string>",
              "status": "ASSET_CREATED",
              "customFields": [
                {
                  "key": "<string>",
                  "value": "<string>"
                }
              ],
              "startedAt": "<string>",
              "stoppedAt": "<string>",
              "totalPremium": {
                "amountPreFeesAndTaxes": 123,
                "totalFees": 123,
                "amountWithFeesPreTaxes": 123,
                "totalTaxes": 123,
                "amountWithFeesAndTaxes": 123
              }
            }
          ],
          "brokerageFirm": {
            "id": "<string>",
            "companyInfo": {
              "siret": "<string>",
              "siren": "<string>",
              "nafCode": "<string>",
              "nafLabel": "<string>",
              "name": "<string>",
              "creationDate": "<string>",
              "location": {
                "city": "<string>",
                "country": "<string>",
                "address": "<string>",
                "postCode": "<string>"
              },
              "legalStatus": {
                "1": "<string>",
                "2": "<string>",
                "3": "<string>"
              },
              "headcount": "<string>"
            }
          },
          "derogations": [
            {
              "id": "<string>",
              "status": "PENDING",
              "policyId": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

Path Parameters

brokerageFirmId
string
required

Body

application/json
viewType
enum<string>
required

View type

Available options:
newBusiness,
derogation,
live
pageInfo
object

the page info

order
object

the sort options

statuses
string[]

Statuses to filter by

customStatuses
string[]

Custom statuses to filter by

businessIntroducers
string[]

Business introducers to filter by

startedAt
object

Started at range

stoppedAt
object

Stopped at range

hasAcknowledgedAlerts
boolean

Optional: if filled, returns policies with at least one alert which acknowledgement matches this attribute

expandCustomers
boolean
expandAssets
boolean
expandBrokerageFirm
boolean
expandDerogations
boolean
queryString
string

Full text search

brokerageFirmName
string

Brokerage firm name

derogationStatuses
enum<string>[]

Filter by derogation status

Available options:
PENDING,
DECLINED,
APPROVED
productIds
string[]

List of product ids

Response

200 - application/json
data
object[]
required

the list of items in the page

pageInfo
object
required

the page info

totalCount
number
required

the total number of items

currentPage
number
required

the current page

totalPages
number
required

the total number of pages