{
  "total": 123,
  "offset": 123,
  "limit": 123,
  "data": [
    {
      "id": "<string>",
      "type": "BRANCH",
      "createdAt": "<string>",
      "lastModifiedAt": "<string>",
      "name": "<string>",
      "status": "POLICY_CREATED",
      "renewalStatus": "RENEWAL_ACCEPTED",
      "branchType": "BASE",
      "branchSubType": "CREATE_ADDITIONAL_COMPONENTS",
      "branchStatus": "BRANCH_OPEN",
      "closeReason": "BROKER_REQUEST",
      "mergedAt": "<string>"
    }
  ]
}

policy

List branches on the policy

Returns a list of open branches on the policy at the simulated date. The branches are sorted by creation date, with the oldest branch appearing first. If no simulated date is passed, this endpoint returns all branches still open after the application of every event pertaining to them, as branches that are merged or dropped will not appear. For example, if a branch is created on 01/01/2023 and merged/dropped on 05/01/2023, the branch will appear in the result if listing branches at dates 01/01/2023-05/01/2023; before 01/01/2023, the branch will not appear as it was not created; after 05/01/2023, the branch will not appear as it was merged or dropped.

GET

policies

{policyId}

branches

{
  "total": 123,
  "offset": 123,
  "limit": 123,
  "data": [
    {
      "id": "<string>",
      "type": "BRANCH",
      "createdAt": "<string>",
      "lastModifiedAt": "<string>",
      "name": "<string>",
      "status": "POLICY_CREATED",
      "renewalStatus": "RENEWAL_ACCEPTED",
      "branchType": "BASE",
      "branchSubType": "CREATE_ADDITIONAL_COMPONENTS",
      "branchStatus": "BRANCH_OPEN",
      "closeReason": "BROKER_REQUEST",
      "mergedAt": "<string>"
    }
  ]
}

Path Parameters

policyId

string

required

the policy id

Query Parameters

whenAt

string

Optional: the whenAt datetime

simulatedAt

string

Optional: the simulatedAt datetime

branchType

enum<string>

the branch type

Available options:

BASE,

NEW_BUSINESS,

MTA,

RENEWAL,

REPRICING

branchStatus

enum<string>

the branch status

Available options:

BRANCH_OPEN,

BRANCH_MERGED,

BRANCH_CLOSED

Response

total

number

required

Total number of policies

offset

number

required

Offset used for pagination

limit

number

required

Page size used for pagination

data

object[]

required

List of policies

Show child attributes

data.id

string

required

Unique identifier for the branch

data.type

enum<string>

required

Type of object

Available options:

BRANCH

data.createdAt

string

required

Creation date of the branch

data.lastModifiedAt

string

required

Last modification date of the branch

data.name

string

Optional: Name of the entity

data.status

enum<string>

Optional: Policy status

Available options:

POLICY_CREATED,

POLICY_QUOTED,

POLICY_CONFIRMED,

POLICY_STARTED,

POLICY_STOPPED,

POLICY_SUSPENDED

data.renewalStatus

enum<string>

Optional: Branch renewal status

Available options:

RENEWAL_ACCEPTED,

RENEWAL_REFUSED

data.branchType

enum<string>

Optional: Branch type

Available options:

BASE,

NEW_BUSINESS,

MTA,

RENEWAL,

REPRICING

data.branchSubType

enum<string>

Optional: Branch sub type

Available options:

CREATE_ADDITIONAL_COMPONENTS,

DRIVEQUANT

data.branchStatus

enum<string>

Optional: Branch status

Available options:

BRANCH_OPEN,

BRANCH_MERGED,

BRANCH_CLOSED

data.closeReason

enum<string>

Optional: Branch close reason

Available options:

BROKER_REQUEST,

CUSTOMER_REQUEST,

FORKED,

ASSET_START_PASSED,

CONCURRENT_BRANCH_MERGED,

QUOTE_INVALIDATED,

PARTITION_DROPPED,

RENEWAL_REFUSED,

CRM_ABOVE_LIMIT,

TELEMATICS_SCORE_MISSING

data.mergedAt

string

Merge date of the branch

Get invoices Get Policy

⌘I

API Reference

Path Parameters

Query Parameters

Response