Skip to main content
POST
/
view-specific
/
{brokerageFirmId}
/
derogations
{
  "data": [
    {
      "derogation": {
        "id": "<string>",
        "status": "PENDING",
        "policyId": "<string>",
        "branchId": "<string>",
        "createdAt": "<string>"
      },
      "customer": {
        "type": "<string>",
        "id": "<string>",
        "createdAt": "<string>",
        "lastModifiedAt": "<string>",
        "status": "CUSTOMER_CREATED",
        "policies": [
          "<string>"
        ],
        "invoices": [
          "<string>"
        ],
        "paymentMode": "DIRECT_DEBIT",
        "customFields": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "name": "<string>",
        "preferredPaymentMethodId": "<string>"
      },
      "policy": {
        "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
          }
        ]
      },
      "hasOpenedClientAccount": true,
      "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>"
        }
      },
      "branch": {
        "branchId": "<string>",
        "createdAt": "<string>",
        "branchType": "BASE",
        "renewalStatus": "RENEWAL_ACCEPTED",
        "branchSubType": "CREATE_ADDITIONAL_COMPONENTS",
        "availability": "BRANCH_OPEN",
        "closeReason": "BROKER_REQUEST",
        "mergedAt": "<string>"
      }
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

Path Parameters

brokerageFirmId
string
required

Query Parameters

count
number
default:10

the number of items to return

page
number
default:1

the page to retrieve

Body

application/json
statuses
enum<string>[]
Available options:
PENDING,
DECLINED,
APPROVED
brokerageFirmName
string

Brokerage firm name

queryString
string

Full text search

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