---
updatedAt: 2025-06-16T23:24:22.000Z
agentTools:
  projectIndex: https://developers.directscale.com/llms.txt
---

# /api/extension/hooks/Commissions.GetCommissionBonusDetails

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Extension Hooks",
    "version": "extensionHooks"
  },
  "servers": [
    {
      "url": "https://{clientId}.corpadmin.directscalestage.com",
      "variables": {
        "clientId": {
          "default": "clientId"
        }
      }
    }
  ],
  "paths": {
    "/api/extension/hooks/Commissions.GetCommissionBonusDetails": {
      "post": {
        "tags": [
          "CommissionHooksCallback"
        ],
        "operationId": "CommissionHooksCallback_GetCommissionBonusDetails",
        "parameters": [
          {
            "name": "X-DirectScale-CallbackToken",
            "in": "header",
            "description": "One-time use token. This value is sent to the endpoint configured for the hook.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-DirectScale-User",
            "in": "header",
            "description": "Sets the User Context of the request when a username is provided",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DirectScale.Disco.Extension.Hooks.Commissions.GetCommissionBonusDetailsHookRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DirectScale.Disco.Extension.Hooks.Commissions.GetCommissionBonusDetailsHookResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "Extension_Token": []
          }
        ],
        "x-codegen-request-body-name": "request"
      }
    }
  },
  "components": {
    "schemas": {
      "DirectScale.Disco.Extension.Contributor": {
        "type": "object",
        "properties": {
          "ContributingAssociateId": {
            "type": "integer",
            "format": "int32"
          },
          "Name": {
            "type": "string"
          },
          "OrderNumber": {
            "type": "integer",
            "format": "int32"
          },
          "Volume": {
            "type": "number",
            "format": "double"
          },
          "Amount": {
            "type": "number",
            "format": "double"
          },
          "AssociateType": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "DirectScale.Disco.Extension.Hooks.Commissions.GetCommissionBonusDetailsHookRequest": {
        "type": "object",
        "properties": {
          "AssociateId": {
            "type": "integer",
            "format": "int32"
          },
          "PeriodId": {
            "type": "integer",
            "format": "int32"
          },
          "BonusId": {
            "type": "string"
          }
        }
      },
      "DirectScale.Disco.Extension.Hooks.Commissions.GetCommissionBonusDetailsHookResponse": {
        "type": "object",
        "properties": {
          "HistoryDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DirectScale.Disco.Extension.CommissionHistoryDetail"
            }
          }
        }
      },
      "DirectScale.Disco.Extension.CommissionHistoryDetail": {
        "type": "object",
        "properties": {
          "AssociateId": {
            "type": "integer",
            "format": "int32"
          },
          "CommissionPeriodId": {
            "type": "integer",
            "format": "int32"
          },
          "PaymentGroup": {
            "type": "string"
          },
          "Amount": {
            "type": "number",
            "format": "double"
          },
          "Comment": {
            "type": "string"
          },
          "EarnedFromName": {
            "type": "string"
          },
          "EarnedFromId": {
            "type": "integer",
            "format": "int32"
          },
          "SubGroup": {
            "type": "string"
          },
          "Status": {
            "type": "string",
            "enum": [
              "Available",
              "Deferred",
              "Processed",
              "Cancelled",
              "UseAccountStatus",
              "Held"
            ]
          },
          "Contributors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DirectScale.Disco.Extension.Contributor"
            }
          },
          "TotalPaid": {
            "type": "number",
            "format": "double"
          },
          "ExchangeRate": {
            "type": "number",
            "format": "double"
          },
          "CurrencyCode": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "Extension_Token": {
        "type": "apiKey",
        "description": "Bearer Token For Extension",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```