Policy commission archive summaries

When a policy period is archived, you can retrieve a summary of the commission earned and paid on the policy period using the policy commission archive summary endpoints.

Use the following endpoints to retrieve policy commission archive summaries:

• GET /billing/v1/accounts/{accountId}/policies/{policyId}/policy-periods/{policyPeriodId}/archive-summaries/{policyPeriodArchiveSummaryId}/policy-commission-archive-summaries
• GET billing/v1/accounts/{accountId}/policies/{policyId}/policy-periods/{policyPeriodId}/archive-summaries/{policyPeriodArchiveSummaryId}/policy-commission-archive-summaries/{policyCommissionArchiveSummaryId}

Each policy commission archive summary represents the commission data for one producer code on an archived policy period. These summaries include the following fields:

• chargeCmsnEarnedRetained: The amount of commission earned and retained by the producer for the policy period.
• chargeCmsnWrittenOff: The amount of commission that was written off for the policy period.
• policyCmsnExpense: The total commission expense for the policy period.
• producerCode: The producer code associated with the commission, including display name and unique identifier.
• role: The role of the producer, such as "Primary."
• defaultForPolicy: Whether this producer code was the default one for the role on the archived policy period.

For example, the following GET request retrieves details of a policy commission archive summary for an archived policy period:

GET /billing/v1/accounts/bc:SuwHdMAI7NatnLsMMI6sG/policies/bc:S_GWocOgrmFblUyHViOz2/policy-periods/bc:SN9lAZiJcx05PVaNnf4pn/archive-summaries/bc:SMNj2oxw7tOGyh6n4qpeI/policy-commission-archive-summaries/bc:S9bxNzHhwrgVZP1CyMQqN

{
    "data": {
        "attributes": {
            "chargeCmsnEarnedRetained": {
                "amount": "110.00",
                "currency": "usd"
            },
            "chargeCmsnWrittenOff": {
                "amount": "0.00",
                "currency": "usd"
            },
            "defaultForPolicy": true,
            "id": "bc:S9bxNzHhwrgVZP1CyMQqN",
            "policyCmsnExpense": {
                "amount": "110.00",
                "currency": "usd"
            },
            "producerCode": {
                "displayName": "Geode-150-Room (Snail-151-Library)",
                "id": "bc:SKb4-VirbLZe6r0QmYXPv",
                "type": "ProducerCode",
                "uri": "/billing/v1/producers/bc:S4h-ypeKRJTZVT5Idmjl6/producer-codes/bc:SKb4-VirbLZe6r0QmYXPv"
            },
            "role": {
                "code": "primary",
                "name": "Primary"
            }
        },
        "checksum": "0",
        "links": {
            "self": {
                "href": "/billing/v1/accounts/bc:SuwHdMAI7NatnLsMMI6sG/policies/bc:S_GWocOgrmFblUyHViOz2/policy-periods/bc:SN9lAZiJcx05PVaNnf4pn/archive-summaries/bc:SMNj2oxw7tOGyh6n4qpeI/policy-commission-archive-summaries/bc:S9bxNzHhwrgVZP1CyMQqN",
                "methods": [
                    "get"
                ]
            }
        }
    }
}