Skip to main content
GET
/
view-specific
/
{brokerageFirmId}
/
accounting-summary
Accounting summary for a brokerage firm
curl --request GET \
  --url https://api.example.com/view-specific/{brokerageFirmId}/accounting-summary
{
  "data": [
    {
      "customer": {
        "type": "<string>",
        "id": "<string>",
        "createdAt": "<string>",
        "lastModifiedAt": "<string>",
        "status": "CUSTOMER_CREATED",
        "policies": [
          "<string>"
        ],
        "invoices": [
          "<string>"
        ],
        "role": "<string>",
        "paymentMode": "DIRECT_DEBIT",
        "customFields": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "name": "<string>",
        "preferredPaymentMethodId": "<string>"
      },
      "policy": {
        "claimsHistory": [
          {
            "year": 123,
            "claimsNumber": 123,
            "fleetSize": 123
          }
        ],
        "type": "<string>",
        "id": "<string>",
        "productId": "<string>",
        "createdAt": "<string>",
        "lastModifiedAt": "<string>",
        "status": "POLICY_CREATED",
        "assets": [
          "<string>"
        ],
        "customers": [
          "<string>"
        ],
        "periodDuration": {
          "amount": 123,
          "unit": "YEAR"
        },
        "invoicingConfig": {
          "frequency": "YEARLY",
          "timing": "IN_ADVANCE",
          "billAtSignature": "EARLY_PAYMENT",
          "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>",
        "reactivatedAt": "<string>",
        "acceptedEmailDomains": [
          "<string>"
        ],
        "acceptedQuoteOptions": {
          "availableConfigs": [
            {
              "tier": "<string>",
              "excess": "<string>",
              "perils": [
                {
                  "id": "<string>",
                  "required": true,
                  "options": [
                    "<string>"
                  ],
                  "showWhen": {
                    "fieldKey": "<string>",
                    "fieldValue": "<string>",
                    "condition": "<string>",
                    "value": "<string>"
                  }
                }
              ]
            }
          ],
          "defaultConfig": {
            "tier": "<string>",
            "excess": "<string>",
            "perils": [
              {
                "id": "<string>",
                "option": "<string>",
                "available": true,
                "unavailabilityMessage": "<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
        },
        "proratedQuote": {
          "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,
        "selectedTier": {},
        "stop": {
          "reason": "<string>",
          "details": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "createdAt": "<string>"
        },
        "brokerageFees": [
          {
            "brokerageFirmId": "<string>",
            "fee": 50
          }
        ]
      },
      "numberOfUnpaidInvoices": 123,
      "unpaidDurationInDay": 123,
      "oldestUnpaidInvoiceIssuedAt": "<string>",
      "lastFormalNoticeSentAt": "<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

unpaidInvoiceIssuedBefore
string
unpaidInvoiceIssuedAfter
string
productIds
string[]

Product ids

queryString
string

Full text search

order
object

the sort options

statuses
enum<string>[]

Statuses to filter by

Available options:
POLICY_CREATED,
POLICY_QUOTED,
POLICY_CONFIRMED,
POLICY_STARTED,
POLICY_STOPPED,
POLICY_SUSPENDED
terminationReasons
string[]

Termination reasons to filter by

hasFormalNotice
boolean

Filter by whether a formal notice has been sent

unpaidDurationDays
number

Filter policies by unpaid duration in days (greater than or equal)

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