PayCalc

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getPayCalc

post

Pay calc

Authorizations
Body
PayCalcPaymentCalculationTypeintegerRequired
Responses
200

Successful operation.

application/json
post
/getPayCalc
POST /nexum/627/2022.01/parameter/getPayCalc HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PayCalcPaymentCalculationType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PayCalc": {
    "BalanceCutoff": [
      {
        "EntryId": 1,
        "BalanceCutoff": 1
      }
    ],
    "BalanceIncrement": 1,
    "BalanceIncrementRounding": 1,
    "DefinedCode": 1,
    "Description": "text",
    "DueGraceDays": 1,
    "IntRateCutoff": [
      {
        "EntryId": 1,
        "IntRateCutoff": 1
      }
    ],
    "InterestAdjPercent": 1,
    "LgDestnPmtCalcSetCode": 1,
    "LgSourcePmtCalcSetCode": 1,
    "Payment10": 1,
    "Payment14": [
      {
        "EntryId": 1,
        "Payment14": 1
      }
    ],
    "PaymentCalculationFormula": 1,
    "PaymentCalculationSetCode": 1,
    "PaymentFrequencyAdjustment": 1,
    "PaymentMinimum": 1,
    "PaymentPercent15": [
      {
        "EntryId": 1,
        "PaymentPercent15": 1
      }
    ],
    "PaymentPercent2": 1,
    "PayoffMonths": [
      {
        "EntryId": 1,
        "PayoffMonths": 1
      }
    ],
    "RoundPaymentUptoMultiple": 1,
    "PaymentCalculationType": 1
  }
}

getPayCalcSelectFields

post

Pay calc select fields

Authorizations
Body
PayCalcPaymentCalculationTypeintegerOptional
Responses
200

Successful operation.

application/json
post
/getPayCalcSelectFields
POST /nexum/627/2022.01/parameter/getPayCalcSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 749

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PayCalcPaymentCalculationType": 1,
  "SelectableFields": {
    "IncludeAllPayCalcFields": true,
    "PayCalcFields": {
      "BalanceCutoff": [
        1
      ],
      "BalanceIncrement": true,
      "BalanceIncrementRounding": true,
      "DefinedCode": true,
      "Description": true,
      "DueGraceDays": true,
      "IntRateCutoff": [
        1
      ],
      "InterestAdjPercent": true,
      "LgDestnPmtCalcSetCode": true,
      "LgSourcePmtCalcSetCode": true,
      "Payment10": true,
      "Payment14": [
        1
      ],
      "PaymentCalculationFormula": true,
      "PaymentCalculationSetCode": true,
      "PaymentCalculationType": true,
      "PaymentFrequencyAdjustment": true,
      "PaymentMinimum": true,
      "PaymentPercent15": [
        1
      ],
      "PaymentPercent2": true,
      "PayoffMonths": [
        1
      ],
      "RoundPaymentUptoMultiple": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PayCalc": {
    "BalanceCutoff": [
      {
        "EntryId": 1,
        "BalanceCutoff": 1
      }
    ],
    "BalanceIncrement": 1,
    "BalanceIncrementRounding": 1,
    "DefinedCode": 1,
    "Description": "text",
    "DueGraceDays": 1,
    "IntRateCutoff": [
      {
        "EntryId": 1,
        "IntRateCutoff": 1
      }
    ],
    "InterestAdjPercent": 1,
    "LgDestnPmtCalcSetCode": 1,
    "LgSourcePmtCalcSetCode": 1,
    "Payment10": 1,
    "Payment14": [
      {
        "EntryId": 1,
        "Payment14": 1
      }
    ],
    "PaymentCalculationFormula": 1,
    "PaymentCalculationSetCode": 1,
    "PaymentFrequencyAdjustment": 1,
    "PaymentMinimum": 1,
    "PaymentPercent15": [
      {
        "EntryId": 1,
        "PaymentPercent15": 1
      }
    ],
    "PaymentPercent2": 1,
    "PayoffMonths": [
      {
        "EntryId": 1,
        "PayoffMonths": 1
      }
    ],
    "RoundPaymentUptoMultiple": 1,
    "PaymentCalculationType": 1
  }
}

getPayCalcPagedList

post

Pay calc paged list

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getPayCalcPagedList
POST /nexum/627/2022.01/parameter/getPayCalcPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PayCalc": [
    {
      "BalanceCutoff": [
        {
          "EntryId": 1,
          "BalanceCutoff": 1
        }
      ],
      "BalanceIncrement": 1,
      "BalanceIncrementRounding": 1,
      "DefinedCode": 1,
      "Description": "text",
      "DueGraceDays": 1,
      "IntRateCutoff": [
        {
          "EntryId": 1,
          "IntRateCutoff": 1
        }
      ],
      "InterestAdjPercent": 1,
      "LgDestnPmtCalcSetCode": 1,
      "LgSourcePmtCalcSetCode": 1,
      "Payment10": 1,
      "Payment14": [
        {
          "EntryId": 1,
          "Payment14": 1
        }
      ],
      "PaymentCalculationFormula": 1,
      "PaymentCalculationSetCode": 1,
      "PaymentFrequencyAdjustment": 1,
      "PaymentMinimum": 1,
      "PaymentPercent15": [
        {
          "EntryId": 1,
          "PaymentPercent15": 1
        }
      ],
      "PaymentPercent2": 1,
      "PayoffMonths": [
        {
          "EntryId": 1,
          "PayoffMonths": 1
        }
      ],
      "RoundPaymentUptoMultiple": 1,
      "PaymentCalculationType": 1
    }
  ],
  "Token": "text"
}

getPayCalcListSelectFields

post

Pay calc list select fields

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getPayCalcListSelectFields
POST /nexum/627/2022.01/parameter/getPayCalcListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 715

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllPayCalcFields": true,
    "PayCalcFields": {
      "BalanceCutoff": [
        1
      ],
      "BalanceIncrement": true,
      "BalanceIncrementRounding": true,
      "DefinedCode": true,
      "Description": true,
      "DueGraceDays": true,
      "IntRateCutoff": [
        1
      ],
      "InterestAdjPercent": true,
      "LgDestnPmtCalcSetCode": true,
      "LgSourcePmtCalcSetCode": true,
      "Payment10": true,
      "Payment14": [
        1
      ],
      "PaymentCalculationFormula": true,
      "PaymentCalculationSetCode": true,
      "PaymentCalculationType": true,
      "PaymentFrequencyAdjustment": true,
      "PaymentMinimum": true,
      "PaymentPercent15": [
        1
      ],
      "PaymentPercent2": true,
      "PayoffMonths": [
        1
      ],
      "RoundPaymentUptoMultiple": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PayCalcList": {
    "hasReachedMaximumListSize": true,
    "PayCalc": [
      {
        "BalanceCutoff": [
          {
            "EntryId": 1,
            "BalanceCutoff": 1
          }
        ],
        "BalanceIncrement": 1,
        "BalanceIncrementRounding": 1,
        "DefinedCode": 1,
        "Description": "text",
        "DueGraceDays": 1,
        "IntRateCutoff": [
          {
            "EntryId": 1,
            "IntRateCutoff": 1
          }
        ],
        "InterestAdjPercent": 1,
        "LgDestnPmtCalcSetCode": 1,
        "LgSourcePmtCalcSetCode": 1,
        "Payment10": 1,
        "Payment14": [
          {
            "EntryId": 1,
            "Payment14": 1
          }
        ],
        "PaymentCalculationFormula": 1,
        "PaymentCalculationSetCode": 1,
        "PaymentFrequencyAdjustment": 1,
        "PaymentMinimum": 1,
        "PaymentPercent15": [
          {
            "EntryId": 1,
            "PaymentPercent15": 1
          }
        ],
        "PaymentPercent2": 1,
        "PayoffMonths": [
          {
            "EntryId": 1,
            "PayoffMonths": 1
          }
        ],
        "RoundPaymentUptoMultiple": 1,
        "PaymentCalculationType": 1
      }
    ]
  }
}

searchPayCalcSelectFields

post

Retrieve a list of select fields for payment calculations

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/searchPayCalcSelectFields
POST /nexum/627/2022.01/parameter/searchPayCalcSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 747

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllPayCalcFields": true,
    "PayCalcFields": {
      "BalanceCutoff": [
        1
      ],
      "BalanceIncrement": true,
      "BalanceIncrementRounding": true,
      "DefinedCode": true,
      "Description": true,
      "DueGraceDays": true,
      "IntRateCutoff": [
        1
      ],
      "InterestAdjPercent": true,
      "LgDestnPmtCalcSetCode": true,
      "LgSourcePmtCalcSetCode": true,
      "Payment10": true,
      "Payment14": [
        1
      ],
      "PaymentCalculationFormula": true,
      "PaymentCalculationSetCode": true,
      "PaymentCalculationType": true,
      "PaymentFrequencyAdjustment": true,
      "PaymentMinimum": true,
      "PaymentPercent15": [
        1
      ],
      "PaymentPercent2": true,
      "PayoffMonths": [
        1
      ],
      "RoundPaymentUptoMultiple": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PayCalcList": {
    "hasReachedMaximumListSize": true,
    "PayCalc": [
      {
        "BalanceCutoff": [
          {
            "EntryId": 1,
            "BalanceCutoff": 1
          }
        ],
        "BalanceIncrement": 1,
        "BalanceIncrementRounding": 1,
        "DefinedCode": 1,
        "Description": "text",
        "DueGraceDays": 1,
        "IntRateCutoff": [
          {
            "EntryId": 1,
            "IntRateCutoff": 1
          }
        ],
        "InterestAdjPercent": 1,
        "LgDestnPmtCalcSetCode": 1,
        "LgSourcePmtCalcSetCode": 1,
        "Payment10": 1,
        "Payment14": [
          {
            "EntryId": 1,
            "Payment14": 1
          }
        ],
        "PaymentCalculationFormula": 1,
        "PaymentCalculationSetCode": 1,
        "PaymentFrequencyAdjustment": 1,
        "PaymentMinimum": 1,
        "PaymentPercent15": [
          {
            "EntryId": 1,
            "PaymentPercent15": 1
          }
        ],
        "PaymentPercent2": 1,
        "PayoffMonths": [
          {
            "EntryId": 1,
            "PayoffMonths": 1
          }
        ],
        "RoundPaymentUptoMultiple": 1,
        "PaymentCalculationType": 1
      }
    ]
  }
}

getPayCalcPagedListSelectFields

post

Pay calc paged list select fields

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getPayCalcPagedListSelectFields
POST /nexum/627/2022.01/parameter/getPayCalcPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 809

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllPayCalcFields": true,
    "PayCalcFields": {
      "BalanceCutoff": [
        1
      ],
      "BalanceIncrement": true,
      "BalanceIncrementRounding": true,
      "DefinedCode": true,
      "Description": true,
      "DueGraceDays": true,
      "IntRateCutoff": [
        1
      ],
      "InterestAdjPercent": true,
      "LgDestnPmtCalcSetCode": true,
      "LgSourcePmtCalcSetCode": true,
      "Payment10": true,
      "Payment14": [
        1
      ],
      "PaymentCalculationFormula": true,
      "PaymentCalculationSetCode": true,
      "PaymentCalculationType": true,
      "PaymentFrequencyAdjustment": true,
      "PaymentMinimum": true,
      "PaymentPercent15": [
        1
      ],
      "PaymentPercent2": true,
      "PayoffMonths": [
        1
      ],
      "RoundPaymentUptoMultiple": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PayCalc": [
    {
      "BalanceCutoff": [
        {
          "EntryId": 1,
          "BalanceCutoff": 1
        }
      ],
      "BalanceIncrement": 1,
      "BalanceIncrementRounding": 1,
      "DefinedCode": 1,
      "Description": "text",
      "DueGraceDays": 1,
      "IntRateCutoff": [
        {
          "EntryId": 1,
          "IntRateCutoff": 1
        }
      ],
      "InterestAdjPercent": 1,
      "LgDestnPmtCalcSetCode": 1,
      "LgSourcePmtCalcSetCode": 1,
      "Payment10": 1,
      "Payment14": [
        {
          "EntryId": 1,
          "Payment14": 1
        }
      ],
      "PaymentCalculationFormula": 1,
      "PaymentCalculationSetCode": 1,
      "PaymentFrequencyAdjustment": 1,
      "PaymentMinimum": 1,
      "PaymentPercent15": [
        {
          "EntryId": 1,
          "PaymentPercent15": 1
        }
      ],
      "PaymentPercent2": 1,
      "PayoffMonths": [
        {
          "EntryId": 1,
          "PayoffMonths": 1
        }
      ],
      "RoundPaymentUptoMultiple": 1,
      "PaymentCalculationType": 1
    }
  ],
  "Token": "text"
}

searchPayCalcPagedSelectFields

post

Retrieve a paged list of select fields for payment calculations

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchPayCalcPagedSelectFields
POST /nexum/627/2022.01/parameter/searchPayCalcPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 824

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllPayCalcFields": true,
    "PayCalcFields": {
      "BalanceCutoff": [
        1
      ],
      "BalanceIncrement": true,
      "BalanceIncrementRounding": true,
      "DefinedCode": true,
      "Description": true,
      "DueGraceDays": true,
      "IntRateCutoff": [
        1
      ],
      "InterestAdjPercent": true,
      "LgDestnPmtCalcSetCode": true,
      "LgSourcePmtCalcSetCode": true,
      "Payment10": true,
      "Payment14": [
        1
      ],
      "PaymentCalculationFormula": true,
      "PaymentCalculationSetCode": true,
      "PaymentCalculationType": true,
      "PaymentFrequencyAdjustment": true,
      "PaymentMinimum": true,
      "PaymentPercent15": [
        1
      ],
      "PaymentPercent2": true,
      "PayoffMonths": [
        1
      ],
      "RoundPaymentUptoMultiple": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PayCalc": [
    {
      "BalanceCutoff": [
        {
          "EntryId": 1,
          "BalanceCutoff": 1
        }
      ],
      "BalanceIncrement": 1,
      "BalanceIncrementRounding": 1,
      "DefinedCode": 1,
      "Description": "text",
      "DueGraceDays": 1,
      "IntRateCutoff": [
        {
          "EntryId": 1,
          "IntRateCutoff": 1
        }
      ],
      "InterestAdjPercent": 1,
      "LgDestnPmtCalcSetCode": 1,
      "LgSourcePmtCalcSetCode": 1,
      "Payment10": 1,
      "Payment14": [
        {
          "EntryId": 1,
          "Payment14": 1
        }
      ],
      "PaymentCalculationFormula": 1,
      "PaymentCalculationSetCode": 1,
      "PaymentFrequencyAdjustment": 1,
      "PaymentMinimum": 1,
      "PaymentPercent15": [
        {
          "EntryId": 1,
          "PaymentPercent15": 1
        }
      ],
      "PaymentPercent2": 1,
      "PayoffMonths": [
        {
          "EntryId": 1,
          "PayoffMonths": 1
        }
      ],
      "RoundPaymentUptoMultiple": 1,
      "PaymentCalculationType": 1
    }
  ],
  "Token": "text"
}

updatePayCalcByID

post

Update payment calculations by ID

Authorizations
Body
PayCalcPaymentCalculationTypeintegerOptional
Responses
200

Successful operation.

application/json
post
/updatePayCalcByID
POST /nexum/627/2022.01/parameter/updatePayCalcByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 784

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PayCalcPaymentCalculationType": 1,
  "PayCalcUpdatableFields": {
    "BalanceCutoff": [
      {
        "EntryId": 1,
        "BalanceCutoff": 1
      }
    ],
    "BalanceIncrement": 1,
    "BalanceIncrementRounding": 1,
    "DefinedCode": 1,
    "Description": "text",
    "DueGraceDays": 1,
    "IntRateCutoff": [
      {
        "EntryId": 1,
        "IntRateCutoff": 1
      }
    ],
    "InterestAdjPercent": 1,
    "LgDestnPmtCalcSetCode": 1,
    "LgSourcePmtCalcSetCode": 1,
    "Payment10": 1,
    "Payment14": [
      {
        "EntryId": 1,
        "Payment14": 1
      }
    ],
    "PaymentCalculationFormula": 1,
    "PaymentCalculationSetCode": 1,
    "PaymentFrequencyAdjustment": 1,
    "PaymentMinimum": 1,
    "PaymentPercent15": [
      {
        "EntryId": 1,
        "PaymentPercent15": 1
      }
    ],
    "PaymentPercent2": 1,
    "PayoffMonths": [
      {
        "EntryId": 1,
        "PayoffMonths": 1
      }
    ],
    "RoundPaymentUptoMultiple": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}
PreviousParticipantFieldNameNextPeriodicMtg

Last updated

Was this helpful?