POST api/UBCalculatePenalty

Documentation for 'Post'.

Request Information

Request body formats

application/json, text/json

Sample:
{
  "CalcParams": {
    "BillingBatchNumberRange": "sample string 1",
    "BillingBatchNumber": "sample string 2",
    "CustomerAccountRange": "sample string 3",
    "FromBook": "sample string 4",
    "FromAcc": "sample string 5",
    "FromSeq": "sample string 6",
    "ToBook": "sample string 7",
    "ToAcc": "sample string 8",
    "ToSeq": "sample string 9",
    "BillingPeriodRange": "sample string 10",
    "BillingPeriodCodeFrom": "sample string 11",
    "BillingPeriodCodeTo": "sample string 12",
    "PrintBillingPeriod": true,
    "PenaltyServiceCode": "sample string 14",
    "PenaltyType": "sample string 15",
    "PostingYear": 16,
    "PostingPeriod": 17,
    "TransactionDate": "2024-09-19T04:54:23.9358951-07:00",
    "FlatAmount": 19.0,
    "PenaltyPercentage": 20.0,
    "MinimumAccountBalance": 21.0,
    "PenaltyDueDate": "2024-09-19T04:54:23.9358951-07:00",
    "IncludeTransUpToDate": "2024-09-19T04:54:23.9358951-07:00",
    "CategoryOption": "sample string 24",
    "ServiceCategory": "sample string 25",
    "CalculatePenaltyOnEmployee": true,
    "ShowEmployeeOnly": true,
    "IncludePAPAccount": true,
    "UpdateFlag": true
  }
}

Response Information

Response body formats

application/json, text/json

Sample:
{
  "ApiResult": {
    "Success": true,
    "Warnings": true,
    "Description": "sample string 3",
    "WarningMessages": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ],
    "NotificationErrorMessages": "sample string 4"
  },
  "SuperSummary": {
    "TotalTransactionCount": 1,
    "TotalPenaltyAmount": 2.0,
    "CustomersWithPenaly": 3,
    "CustomersWithZeroPenalty": 4,
    "CustomersProcessed": 5,
    "CustomersWithUnapplied": 6
  }
}