1. REST API Reference
  2. APIs for Management Ledger
  3. ML Rule Balancing

ML Rule Balancing

Use this operation to retrieve Rule Balancing Data for a particular POV for a given Management Ledger application.

Table 3-13 ML Rule Balancing

Name Description
Action Type GET
Request URI http://{HostName}/profitability/rest/v1/applications/{applicationName}/povs/ {povGroupMembers}/ruleBalance?queryParameter={"modelViewName":"modelViewName"}

Note:

If the model view name is empty, the default model view is used.
Request Payload  
Response 
{
  "items": [
    {
      "ruleNumber": "",
      "rules": [],
      "balanceTypeRule": true,
      "scale": 2,
      "sequence": 0,
      "name": "NoRule",
      "description": null,
      "runningBalance": 49357098.03,
      "balance": 49357098.03,
      "allocationIn": null,
      "allocationOut": null,
      "adjustmentIn": null,
      "adjustmentOut": null,
      "input": 49357098.03,
      "runningRemainder": 49357098.03,
      "remainder": 49357098.03,
      "netChange": null,
      "offset": null,
      "inputAsString": "49,357,098.03",
      "adjInAsString": "-",
      "adjOutAsString": "-",
      "allocInAsString": "-",
      "allocOutAsString": "-",
      "balanceAsString": "49,357,098.03",
      "runningBalanceAsString": "49,357,098.03",
      "runningRemainderAsString": "49,357,098.03",
      "remainderAsString": "49,357,098.03",
      "netChangeAsString": "-",
      "offsetAsString": "-"
    },    
  ],
  "type": "Profitability",
  "links": [
    {
      "href": "http://myServer.mydomain.com:19000/profitability/rest/v1/applications/Ex3F1/povs/FY14_JUN_Actual_Working/ruleBalance?queryParameter=%7B%22modelViewName%22:%22BU%2010601%22%7D",
      "action": "GET",
      "rel": "self",
      "data": {
        "modelViewName": "BU 10601"
      }
    }
  ],
  "status": 0,
  "details": "",
  "statusMessage": "SUCCESS"
}
Process Type Synchronous

Table 3-14 Request Parameters

Parameter Description Example
applicationName Application Name Ex3F1
povGroupMember POV member group FY23_JUN_Actual_Working
modelViewName Model view name BU 10601

Response Values: None