AppMage

BillerRpc

BillerRpc exposes a small billing-related RPC surface for discovering available biller classes. It currently contains one public method that returns a list intended for UI form selection controls.

Endpoints

POST /api/rpc (Method: BillerRpc.getAvailableBillers)

  • Description: Retrieves a list of all available biller classes for use in forms.

  • Request Body:

    {
      "method": "BillerRpc.getAvailableBillers",
      "params": {}
    }
  • Parameters:

    Name Type Required Description
    None No This method accepts an empty parameter object.
  • Response:

    {
      "success": true,
      "data": [
        {
          "value": "string",
          "label": "string"
        }
      ]
    }

    The method delegates to BillerService.getAvailableBillers() and returns whatever that service provides. The source confirms the result is formatted for selection controls as { value, label } items, but the exact contents, ordering, and error behavior depend on BillerService, which was not available for inspection.

  • Example (cURL):

    curl -X POST "${APP_BASE_URL}/api/rpc" \
      -H "Content-Type: application/json" \
      -d '{
        "method": "BillerRpc.getAvailableBillers",
        "params": {}
      }'