PlanDefault

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getPlanDefault

post

Plan default

Authorizations
Body
PlanDefaultReservePlanTypeintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "PlanDefault": {
    "ChargeOffDays": 1,
    "ChargeOffPmts": 1,
    "ChargebackCoOption": 1,
    "ChargebackPoOption": 1,
    "CloseDate": "2025-11-07",
    "Description": "text",
    "EarlyPayoffDays": 1,
    "EarlyPayoffPmts": 1,
    "MbrFeeAmount": 1,
    "MemberFee": 1,
    "ReservePlanType": 1,
    "Type": 1,
    "UpFrontReserveAmt": 1,
    "UpFrontReservePercent": 1,
    "UserAmount1": 1,
    "UserAmount2": 1,
    "UserAmount3": 1,
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserCode1": 1,
    "UserDate1": "2025-11-07",
    "UserNumber1": 1,
    "UserNumber2": 1,
    "UserRate1": 1
  }
}

getPlanDefaultSelectFields

post

Plan default select fields

Authorizations
Body
PlanDefaultReservePlanTypeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PlanDefaultReservePlanType": 1,
  "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,
      "UserCode1": true,
      "UserDate1": true,
      "UserNumber1": true,
      "UserNumber2": true,
      "UserRate1": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PlanDefault": {
    "ChargeOffDays": 1,
    "ChargeOffPmts": 1,
    "ChargebackCoOption": 1,
    "ChargebackPoOption": 1,
    "CloseDate": "2025-11-07",
    "Description": "text",
    "EarlyPayoffDays": 1,
    "EarlyPayoffPmts": 1,
    "MbrFeeAmount": 1,
    "MemberFee": 1,
    "ReservePlanType": 1,
    "Type": 1,
    "UpFrontReserveAmt": 1,
    "UpFrontReservePercent": 1,
    "UserAmount1": 1,
    "UserAmount2": 1,
    "UserAmount3": 1,
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserCode1": 1,
    "UserDate1": "2025-11-07",
    "UserNumber1": 1,
    "UserNumber2": 1,
    "UserRate1": 1
  }
}

getPlanDefaultPagedList

post

Plan default paged list

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getPlanDefaultPagedList
POST /nexum/627/2022.01/parameter/getPlanDefaultPagedList 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.

{
  "PlanDefault": [
    {
      "ChargeOffDays": 1,
      "ChargeOffPmts": 1,
      "ChargebackCoOption": 1,
      "ChargebackPoOption": 1,
      "CloseDate": "2025-11-07",
      "Description": "text",
      "EarlyPayoffDays": 1,
      "EarlyPayoffPmts": 1,
      "MbrFeeAmount": 1,
      "MemberFee": 1,
      "ReservePlanType": 1,
      "Type": 1,
      "UpFrontReserveAmt": 1,
      "UpFrontReservePercent": 1,
      "UserAmount1": 1,
      "UserAmount2": 1,
      "UserAmount3": 1,
      "UserChar1": "text",
      "UserChar2": "text",
      "UserChar3": "text",
      "UserCode1": 1,
      "UserDate1": "2025-11-07",
      "UserNumber1": 1,
      "UserNumber2": 1,
      "UserRate1": 1
    }
  ],
  "Token": "text"
}

getPlanDefaultListSelectFields

post

Plan default list select fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "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,
      "UserCode1": true,
      "UserDate1": true,
      "UserNumber1": true,
      "UserNumber2": true,
      "UserRate1": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PlanDefaultList": {
    "hasReachedMaximumListSize": true,
    "PlanDefault": [
      {
        "ChargeOffDays": 1,
        "ChargeOffPmts": 1,
        "ChargebackCoOption": 1,
        "ChargebackPoOption": 1,
        "CloseDate": "2025-11-07",
        "Description": "text",
        "EarlyPayoffDays": 1,
        "EarlyPayoffPmts": 1,
        "MbrFeeAmount": 1,
        "MemberFee": 1,
        "ReservePlanType": 1,
        "Type": 1,
        "UpFrontReserveAmt": 1,
        "UpFrontReservePercent": 1,
        "UserAmount1": 1,
        "UserAmount2": 1,
        "UserAmount3": 1,
        "UserChar1": "text",
        "UserChar2": "text",
        "UserChar3": "text",
        "UserCode1": 1,
        "UserDate1": "2025-11-07",
        "UserNumber1": 1,
        "UserNumber2": 1,
        "UserRate1": 1
      }
    ]
  }
}

searchPlanDefaultSelectFields

post

Retrieve a list of select fields for default plans

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "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,
      "UserCode1": true,
      "UserDate1": true,
      "UserNumber1": true,
      "UserNumber2": true,
      "UserRate1": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PlanDefaultList": {
    "hasReachedMaximumListSize": true,
    "PlanDefault": [
      {
        "ChargeOffDays": 1,
        "ChargeOffPmts": 1,
        "ChargebackCoOption": 1,
        "ChargebackPoOption": 1,
        "CloseDate": "2025-11-07",
        "Description": "text",
        "EarlyPayoffDays": 1,
        "EarlyPayoffPmts": 1,
        "MbrFeeAmount": 1,
        "MemberFee": 1,
        "ReservePlanType": 1,
        "Type": 1,
        "UpFrontReserveAmt": 1,
        "UpFrontReservePercent": 1,
        "UserAmount1": 1,
        "UserAmount2": 1,
        "UserAmount3": 1,
        "UserChar1": "text",
        "UserChar2": "text",
        "UserChar3": "text",
        "UserCode1": 1,
        "UserDate1": "2025-11-07",
        "UserNumber1": 1,
        "UserNumber2": 1,
        "UserRate1": 1
      }
    ]
  }
}

getPlanDefaultPagedListSelectFields

post

Plan default paged list select fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "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,
      "UserCode1": true,
      "UserDate1": true,
      "UserNumber1": true,
      "UserNumber2": true,
      "UserRate1": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PlanDefault": [
    {
      "ChargeOffDays": 1,
      "ChargeOffPmts": 1,
      "ChargebackCoOption": 1,
      "ChargebackPoOption": 1,
      "CloseDate": "2025-11-07",
      "Description": "text",
      "EarlyPayoffDays": 1,
      "EarlyPayoffPmts": 1,
      "MbrFeeAmount": 1,
      "MemberFee": 1,
      "ReservePlanType": 1,
      "Type": 1,
      "UpFrontReserveAmt": 1,
      "UpFrontReservePercent": 1,
      "UserAmount1": 1,
      "UserAmount2": 1,
      "UserAmount3": 1,
      "UserChar1": "text",
      "UserChar2": "text",
      "UserChar3": "text",
      "UserCode1": 1,
      "UserDate1": "2025-11-07",
      "UserNumber1": 1,
      "UserNumber2": 1,
      "UserRate1": 1
    }
  ],
  "Token": "text"
}

searchPlanDefaultPagedSelectFields

post

Retrieve a paged list of select fields for default plans

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "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,
      "UserCode1": true,
      "UserDate1": true,
      "UserNumber1": true,
      "UserNumber2": true,
      "UserRate1": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PlanDefault": [
    {
      "ChargeOffDays": 1,
      "ChargeOffPmts": 1,
      "ChargebackCoOption": 1,
      "ChargebackPoOption": 1,
      "CloseDate": "2025-11-07",
      "Description": "text",
      "EarlyPayoffDays": 1,
      "EarlyPayoffPmts": 1,
      "MbrFeeAmount": 1,
      "MemberFee": 1,
      "ReservePlanType": 1,
      "Type": 1,
      "UpFrontReserveAmt": 1,
      "UpFrontReservePercent": 1,
      "UserAmount1": 1,
      "UserAmount2": 1,
      "UserAmount3": 1,
      "UserChar1": "text",
      "UserChar2": "text",
      "UserChar3": "text",
      "UserCode1": 1,
      "UserDate1": "2025-11-07",
      "UserNumber1": 1,
      "UserNumber2": 1,
      "UserRate1": 1
    }
  ],
  "Token": "text"
}

updatePlanDefaultByID

post

Update default plans by ID

Authorizations
Body
PlanDefaultReservePlanTypeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PlanDefaultReservePlanType": 1,
  "PlanDefaultUpdatableFields": {
    "ChargeOffDays": 1,
    "ChargeOffPmts": 1,
    "ChargebackCoOption": 1,
    "ChargebackPoOption": 1,
    "CloseDate": "2025-11-07",
    "Description": "text",
    "EarlyPayoffDays": 1,
    "EarlyPayoffPmts": 1,
    "MbrFeeAmount": 1,
    "MemberFee": 1,
    "UpFrontReserveAmt": 1,
    "UpFrontReservePercent": 1,
    "UserAmount1": 1,
    "UserAmount2": 1,
    "UserAmount3": 1,
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserCode1": 1,
    "UserDate1": "2025-11-07",
    "UserNumber1": 1,
    "UserNumber2": 1,
    "UserRate1": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?