Skip to content
NexumAPI Docs

PayCalc⁠

Perform various operations for Symitar parameters.

Operations⁠

getPayCalcSelectFields⁠

POST

Execute the persistent ParameterService getPayCalcSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
PayCalcPaymentCalculationTypeintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getPayCalcSelectFields
POST /nexum/627/persistent/parameter/getPayCalcSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "PayCalcPaymentCalculationType": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllPayCalcFields": true,
    "PayCalcFields": {
      "BalanceCutoff": [
        0
      ],
      "BalanceIncrement": true,
      "BalanceIncrementRounding": true,
      "DefinedCode": true,
      "Description": true,
      "DueGraceDays": true,
      "IntRateCutoff": [
        0
      ],
      "InterestAdjPercent": true,
      "LgDestnPmtCalcSetCode": true,
      "LgSourcePmtCalcSetCode": true,
      "Payment10": true,
      "Payment14": [
        0
      ],
      "PaymentCalculationFormula": true,
      "PaymentCalculationSetCode": true,
      "PaymentCalculationType": true,
      "PaymentFrequencyAdjustment": true,
      "PaymentMinimum": true,
      "PaymentPercent15": [
        0
      ],
      "PaymentPercent2": true,
      "PayoffMonths": [
        0
      ]
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getPayCalcPagedListSelectFields⁠

POST

Execute the persistent ParameterService getPayCalcPagedListSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getPayCalcPagedListSelectFields
POST /nexum/627/persistent/parameter/getPayCalcPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllPayCalcFields": true,
    "PayCalcFields": {
      "BalanceCutoff": [
        0
      ],
      "BalanceIncrement": true,
      "BalanceIncrementRounding": true,
      "DefinedCode": true,
      "Description": true,
      "DueGraceDays": true,
      "IntRateCutoff": [
        0
      ],
      "InterestAdjPercent": true,
      "LgDestnPmtCalcSetCode": true,
      "LgSourcePmtCalcSetCode": true,
      "Payment10": true,
      "Payment14": [
        0
      ],
      "PaymentCalculationFormula": true,
      "PaymentCalculationSetCode": true,
      "PaymentCalculationType": true,
      "PaymentFrequencyAdjustment": true,
      "PaymentMinimum": true,
      "PaymentPercent15": [
        0
      ],
      "PaymentPercent2": true,
      "PayoffMonths": [
        0
      ]
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchPayCalcPagedSelectFields⁠

POST

Execute the persistent ParameterService searchPayCalcPagedSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/searchPayCalcPagedSelectFields
POST /nexum/627/persistent/parameter/searchPayCalcPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllPayCalcFields": true,
    "PayCalcFields": {
      "BalanceCutoff": [
        0
      ],
      "BalanceIncrement": true,
      "BalanceIncrementRounding": true,
      "DefinedCode": true,
      "Description": true,
      "DueGraceDays": true,
      "IntRateCutoff": [
        0
      ],
      "InterestAdjPercent": true,
      "LgDestnPmtCalcSetCode": true,
      "LgSourcePmtCalcSetCode": true,
      "Payment10": true,
      "Payment14": [
        0
      ],
      "PaymentCalculationFormula": true,
      "PaymentCalculationSetCode": true,
      "PaymentCalculationType": true,
      "PaymentFrequencyAdjustment": true,
      "PaymentMinimum": true,
      "PaymentPercent15": [
        0
      ],
      "PaymentPercent2": true,
      "PayoffMonths": [
        0
      ]
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updatePayCalcByID⁠

POST

Execute the persistent ParameterService updatePayCalcByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
PayCalcPaymentCalculationTypeintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/updatePayCalcByID
POST /nexum/627/persistent/parameter/updatePayCalcByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "PayCalcPaymentCalculationType": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PayCalcFields": {
    "BalanceCutoff": [
      {
        "EntryId": 0,
        "BalanceCutoff": 0
      }
    ],
    "BalanceIncrement": 0,
    "BalanceIncrementRounding": 0,
    "DefinedCode": 0,
    "Description": "string",
    "DueGraceDays": 0,
    "IntRateCutoff": [
      {
        "EntryId": 0,
        "IntRateCutoff": 0
      }
    ],
    "InterestAdjPercent": 0,
    "LgDestnPmtCalcSetCode": 0,
    "LgSourcePmtCalcSetCode": 0,
    "Payment10": 0,
    "Payment14": [
      {
        "EntryId": 0,
        "Payment14": 0
      }
    ],
    "PaymentCalculationFormula": 0,
    "PaymentCalculationSetCode": 0,
    "PaymentCalculationType": 0,
    "PaymentFrequencyAdjustment": 0,
    "PaymentMinimum": 0,
    "PaymentPercent15": [
      {
        "EntryId": 0,
        "PaymentPercent15": 0
      }
    ],
    "PaymentPercent2": 0,
    "PayoffMonths": [
      {
        "EntryId": 0,
        "PayoffMonths": 0
      }
    ]
  },
  "nxAttributes": {
    "customFields": {}
  }
}