Charge commissions

A charge commission is a collection of information about the commission that a producer earns on a charge.

You can query for charge commissions using the following endpoints:

  • GET /billing/v1/producers/{producerId}/producer-codes/{producerCodeId}/policy-commissions/{policyCommissionId}/charge-commissions
  • GET /billing/v1/producers/{producerId}/producer-codes/{producerCodeId}/policy-commissions/{policyCommissionId}/charge-commissions/{chargeCommissionId}

For example, the following retrieves all of a producer's charge commissions on charge bc:63918:

Command

GET /billing/v1/producers/bc:bc:188/producer-codes/bc:195/policy-commissions/bc:217/charge-commissions

Response

{
    "count": 1,
    "data": [
        {
            "attributes": {
                "charge": {
                    "displayName": "Premium",
                    "id": "bc:S7kMuJxaiUVdNhvzhgKzq",
                    "type": "Charge",
                    "uri": "/billing/v1/charges/bc:63918"
                },
                "currency": {
                    "code": "usd",
                    "name": "USD"
                },
                "id": "bc:63919",
                "payableCriteria": {
                    "code": "binding",
                    "name": "On Binding"
                }
            },
            ...

Returning calculated values

Cloud API does not return commission amounts for charge commissions. This includes all monetary amount fields on a charge commission: commissionEarnedRetained, commissionExpenseBalance, positiveCmsnAdjustmentBalance, and negativeCmsnAdjustmentBalance. These fields are not returned by default for performance reasons.

You can use query parameters to return these fields. For example, you can use ?fields=*all to return all these calculated fields along with the fields that are returned by default. For more information, see The fields query parameter. The query parameter works both when retrieving a collection of charge commissions and retrieving a single charge commission.

For example, the following call retrieves a single charge commission with the calculated commission amount fields.

Command

GET /billing/v1/producers/bc:bc:188/producer-codes/bc:195/policy-commissions/bc:217/charge-commissions/bc:63919

Response

{
    "count": 1,
    "data": [
        {
            "attributes": {
                "charge": {
                    "displayName": "Premium",
                    "id": "bc:Si4BAIY-HNNKm7PBIcKA4",
                    "type": "Charge",
                    "uri": "/billing/v1/charges/bc:Si4BAIY-HNNKm7PBIcKA4"
                },
                "commissionExpenseBalance": {
                    "amount": "100.00",
                    "currency": "usd"
                },
                "commissionReserveBalance": {
                    "amount": "99.98",
                    "currency": "usd"
                },
                "currency": {
                    "code": "usd",
                    "name": "USD"
                },
                "id": "bc:63919",
                "negativeCmsnAdjustmentBalance": {
                    "amount": "0.02",
                    "currency": "usd"
                },
                "payableCriteria": {
                    "code": "binding",
                    "name": "On Binding"
                },
                "positiveCmsnAdjustmentBalance": {
                    "amount": "0.00",
                    "currency": "usd"
                }
            },
            ...
        }
    }
}