Skip to content

PlanDefault⁠

Perform various operations for Symitar parameters.

Operations⁠

getPlanDefaultSelectFields⁠

POST

Execute the persistent ParameterService getPlanDefaultSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "PlanDefaultReservePlanType": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllPlanDefaultFields": true,
    "PlanDefaultFields": {
      "ChargeOffDays": true,
      "ChargeOffPmts": true,
      "ChargebackCoOption": true,
      "ChargebackPoOption": true,
      "CloseDate": true,
      "Description": true,
      "EarlyPayoffDays": true,
      "EarlyPayoffPmts": true,
      "MbrFeeAmount": true,
      "MemberFee": true,
      "ReservePlanType": true,
      "Type": true,
      "UpFrontReserveAmt": true,
      "UpFrontReservePercent": true,
      "UserAmount1": true,
      "UserAmount2": true,
      "UserAmount3": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getPlanDefaultPagedListSelectFields⁠

POST

Execute the persistent ParameterService getPlanDefaultPagedListSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Path Parameters
symstringrequired
Sym number
Tokenstringoptional
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/getPlanDefaultPagedListSelectFields
POST /nexum/627/persistent/parameter/getPlanDefaultPagedListSelectFields 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": {
    "IncludeAllPlanDefaultFields": true,
    "PlanDefaultFields": {
      "ChargeOffDays": true,
      "ChargeOffPmts": true,
      "ChargebackCoOption": true,
      "ChargebackPoOption": true,
      "CloseDate": true,
      "Description": true,
      "EarlyPayoffDays": true,
      "EarlyPayoffPmts": true,
      "MbrFeeAmount": true,
      "MemberFee": true,
      "ReservePlanType": true,
      "Type": true,
      "UpFrontReserveAmt": true,
      "UpFrontReservePercent": true,
      "UserAmount1": true,
      "UserAmount2": true,
      "UserAmount3": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchPlanDefaultPagedSelectFields⁠

POST

Execute the persistent ParameterService searchPlanDefaultPagedSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Path Parameters
symstringrequired
Sym number
Tokenstringoptional
MessageIdstringoptional
POST/nexum/{sym}/persistent/parameter/searchPlanDefaultPagedSelectFields
POST /nexum/627/persistent/parameter/searchPlanDefaultPagedSelectFields 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": {
    "IncludeAllPlanDefaultFields": true,
    "PlanDefaultFields": {
      "ChargeOffDays": true,
      "ChargeOffPmts": true,
      "ChargebackCoOption": true,
      "ChargebackPoOption": true,
      "CloseDate": true,
      "Description": true,
      "EarlyPayoffDays": true,
      "EarlyPayoffPmts": true,
      "MbrFeeAmount": true,
      "MemberFee": true,
      "ReservePlanType": true,
      "Type": true,
      "UpFrontReserveAmt": true,
      "UpFrontReservePercent": true,
      "UserAmount1": true,
      "UserAmount2": true,
      "UserAmount3": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updatePlanDefaultByID⁠

POST

Execute the persistent ParameterService updatePlanDefaultByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "PlanDefaultReservePlanType": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PlanDefaultFields": {
    "ChargeOffDays": 0,
    "ChargeOffPmts": 0,
    "ChargebackCoOption": 0,
    "ChargebackPoOption": 0,
    "CloseDate": "string",
    "Description": "string",
    "EarlyPayoffDays": 0,
    "EarlyPayoffPmts": 0,
    "MbrFeeAmount": 0,
    "MemberFee": 0,
    "ReservePlanType": 0,
    "Type": 0,
    "UpFrontReserveAmt": 0,
    "UpFrontReservePercent": 0,
    "UserAmount1": 0,
    "UserAmount2": 0,
    "UserAmount3": 0,
    "UserChar1": "string",
    "UserChar2": "string",
    "UserChar3": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}