Total balance

This API method retrieves the total balances, divided by agents, based on the specified query parameters.

Parameters:

  • isoId (integer): A unique identifier for the Independent Sales Organization (ISO) or the entity managing the agents.
  • agentId (integer): A unique identifier for the specific agent whose balance details are being requested.
    Functionality:

Returns the total balances broken down by agent. When both isoId and agentId are provided, the results are filtered to show the balance associated with the specified agent under the given ISO.
Response:

  • The response includes the total balances for each agent under the specified ISO, or for a specific agent if agentId is provided.
    Total Balance: The sum of all balances divided by agent.
    Agent Details: Information about each agent, such as their name, ID, and total balance.

Key Features:

  • Granular Balance Breakdown: Offers detailed balance information per agent, making it easier to monitor agent-specific financial performance.
  • Flexible Querying: Supports querying based on both ISO and agent identifiers for targeted balance retrieval.
    Summary:
The GET /api/Widget/Balances API is designed to retrieve and display total balances divided by agents. By specifying parameters such as isoId and agentId, users can filter results to show the relevant balances, aiding in financial tracking and management of agent-level performance.
Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!