ShareDefault

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getShareDefault

post

Retrieve share default

Authorizations
Body
ShareDefaultShareTypeintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "ShareDefault": {
    "AmortizationSchd": 1,
    "AmortizationSchdType": 1,
    "AuthFeeOption": [
      {
        "EntryId": 1,
        "AuthFeeOption": 1
      }
    ],
    "BumpEffectiveDate": "2025-11-06",
    "BumpExpirationDate": "2025-11-06",
    "BumpRate": 1,
    "CallItemSchd": 1,
    "CallItemSchdType": 1,
    "CappedFeesAmountCap": 1,
    "CappedFeesCountCap": 1,
    "CertificateNumber": "text",
    "Chapter4WithholdingCode": 1,
    "CheckDigits": "text",
    "CloseDate": "2025-11-06",
    "CorporateUserTransferCode": 1,
    "CreditReportingCode": 1,
    "CuTotalsUseCode": 1,
    "Description": "text",
    "DivDisbUpdtActvtyD": 1,
    "DivPostCode": 1,
    "DivRate": 1,
    "DivType": 1,
    "DividendRateMargin": 1,
    "DividendRateMarginSign": 1,
    "DividendRateMax": 1,
    "DividendRateMin": 1,
    "DividendRatePeriodDate": "2025-11-06",
    "DividendRatePeriodFreq": 1,
    "ExtAchXfrDailyLimitIn": 1,
    "ExtAchXfrDailyLimitOut": 1,
    "InsuranceMaximum": 1,
    "InsuranceType": 1,
    "IrsCode": 1,
    "IrsPlan": 1,
    "MaturityDate": "2025-11-06",
    "MaturityPostCode": 1,
    "MemberBranchSupport": 1,
    "MemberUserTransferCode": 1,
    "MinimumBalance": 1,
    "MinimumDeposit": 1,
    "MinimumWithdrawal": 1,
    "NegativeBalanceNoticeNumber": 1,
    "NegativeBalanceNoticeType": 1,
    "Nickname": "text",
    "OdtAuthFeeSrcCodeList": [
      {
        "EntryId": 1,
        "OdtAuthFeeSrcCodeList": "text"
      }
    ],
    "OverdraftTolerance": 1,
    "PenaltyType": 1,
    "PeriodicCap": 1,
    "PeriodicStartRate": 1,
    "PutItemSchd": 1,
    "PutItemSchdType": 1,
    "Reference": "text",
    "RegDCtrStartDay": 1,
    "RenewShareType": 1,
    "RenewTermFreq": 1,
    "RenewTermPeriod": 1,
    "Service": [
      {
        "EntryId": 1,
        "Service": 1
      }
    ],
    "ShareCode": 1,
    "ShareType": 1,
    "StateWithholdingCode": 1,
    "StatementGroup": 1,
    "StatementMailCode": 1,
    "SweepBalanceType": 1,
    "SweepPriority": 1,
    "SweepTargetMaximum": 1,
    "SweepTargetMinimum": 1,
    "TermFrequency": 1,
    "TermPeriod": 1,
    "Type": 1,
    "UserAmount1": 1,
    "UserAmount2": 1,
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserChar4": "text",
    "UserDate1": "2025-11-06",
    "UserDate2": "2025-11-06",
    "WarningCode": [
      {
        "EntryId": 1,
        "WarningCode": 1
      }
    ],
    "WithdrawalFeeType": 1,
    "WithdrawalLimit": 1,
    "WithholdingCode": 1
  }
}

getShareDefaultSelectFields

post

Returns the share defaults with select fields

Authorizations
Body
ShareDefaultShareTypeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ShareDefaultShareType": 1,
  "SelectableFields": {
    "IncludeAllShareDefaultFields": true,
    "ShareDefaultFields": {
      "AmortizationSchd": true,
      "AmortizationSchdType": true,
      "AuthFeeOption": [
        1
      ],
      "BumpEffectiveDate": true,
      "BumpExpirationDate": true,
      "BumpRate": true,
      "CallItemSchd": true,
      "CallItemSchdType": true,
      "CappedFeesAmountCap": true,
      "CappedFeesCountCap": true,
      "CertificateNumber": true,
      "Chapter4WithholdingCode": true,
      "CheckDigits": true,
      "CloseDate": true,
      "CorporateUserTransferCode": true,
      "CreditReportingCode": true,
      "CuTotalsUseCode": true,
      "Description": true,
      "DivDisbUpdtActvtyD": true,
      "DivPostCode": true,
      "DivRate": true,
      "DivType": true,
      "DividendRateMargin": true,
      "DividendRateMarginSign": true,
      "DividendRateMax": true,
      "DividendRateMin": true,
      "DividendRatePeriodDate": true,
      "DividendRatePeriodFreq": true,
      "ExtAchXfrDailyLimitIn": true,
      "ExtAchXfrDailyLimitOut": true,
      "InsuranceMaximum": true,
      "InsuranceType": true,
      "IrsCode": true,
      "IrsPlan": true,
      "MaturityDate": true,
      "MaturityPostCode": true,
      "MemberBranchSupport": true,
      "MemberUserTransferCode": true,
      "MinimumBalance": true,
      "MinimumDeposit": true,
      "MinimumWithdrawal": true,
      "NegativeBalanceNoticeNumber": true,
      "NegativeBalanceNoticeType": true,
      "Nickname": true,
      "OdtAuthFeeSrcCodeList": [
        1
      ],
      "OverdraftTolerance": true,
      "PenaltyType": true,
      "PeriodicCap": true,
      "PeriodicStartRate": true,
      "PutItemSchd": true,
      "PutItemSchdType": true,
      "Reference": true,
      "RegDCtrStartDay": true,
      "RenewShareType": true,
      "RenewTermFreq": true,
      "RenewTermPeriod": true,
      "Service": [
        1
      ],
      "ShareCode": true,
      "ShareType": true,
      "StateWithholdingCode": true,
      "StatementGroup": true,
      "StatementMailCode": true,
      "SweepBalanceType": true,
      "SweepPriority": true,
      "SweepTargetMaximum": true,
      "SweepTargetMinimum": true,
      "TermFrequency": true,
      "TermPeriod": true,
      "Type": true,
      "UserAmount1": true,
      "UserAmount2": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserDate1": true,
      "UserDate2": true,
      "WarningCode": [
        1
      ],
      "WithdrawalFeeType": true,
      "WithdrawalLimit": true,
      "WithholdingCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ShareDefault": {
    "AmortizationSchd": 1,
    "AmortizationSchdType": 1,
    "AuthFeeOption": [
      {
        "EntryId": 1,
        "AuthFeeOption": 1
      }
    ],
    "BumpEffectiveDate": "2025-11-06",
    "BumpExpirationDate": "2025-11-06",
    "BumpRate": 1,
    "CallItemSchd": 1,
    "CallItemSchdType": 1,
    "CappedFeesAmountCap": 1,
    "CappedFeesCountCap": 1,
    "CertificateNumber": "text",
    "Chapter4WithholdingCode": 1,
    "CheckDigits": "text",
    "CloseDate": "2025-11-06",
    "CorporateUserTransferCode": 1,
    "CreditReportingCode": 1,
    "CuTotalsUseCode": 1,
    "Description": "text",
    "DivDisbUpdtActvtyD": 1,
    "DivPostCode": 1,
    "DivRate": 1,
    "DivType": 1,
    "DividendRateMargin": 1,
    "DividendRateMarginSign": 1,
    "DividendRateMax": 1,
    "DividendRateMin": 1,
    "DividendRatePeriodDate": "2025-11-06",
    "DividendRatePeriodFreq": 1,
    "ExtAchXfrDailyLimitIn": 1,
    "ExtAchXfrDailyLimitOut": 1,
    "InsuranceMaximum": 1,
    "InsuranceType": 1,
    "IrsCode": 1,
    "IrsPlan": 1,
    "MaturityDate": "2025-11-06",
    "MaturityPostCode": 1,
    "MemberBranchSupport": 1,
    "MemberUserTransferCode": 1,
    "MinimumBalance": 1,
    "MinimumDeposit": 1,
    "MinimumWithdrawal": 1,
    "NegativeBalanceNoticeNumber": 1,
    "NegativeBalanceNoticeType": 1,
    "Nickname": "text",
    "OdtAuthFeeSrcCodeList": [
      {
        "EntryId": 1,
        "OdtAuthFeeSrcCodeList": "text"
      }
    ],
    "OverdraftTolerance": 1,
    "PenaltyType": 1,
    "PeriodicCap": 1,
    "PeriodicStartRate": 1,
    "PutItemSchd": 1,
    "PutItemSchdType": 1,
    "Reference": "text",
    "RegDCtrStartDay": 1,
    "RenewShareType": 1,
    "RenewTermFreq": 1,
    "RenewTermPeriod": 1,
    "Service": [
      {
        "EntryId": 1,
        "Service": 1
      }
    ],
    "ShareCode": 1,
    "ShareType": 1,
    "StateWithholdingCode": 1,
    "StatementGroup": 1,
    "StatementMailCode": 1,
    "SweepBalanceType": 1,
    "SweepPriority": 1,
    "SweepTargetMaximum": 1,
    "SweepTargetMinimum": 1,
    "TermFrequency": 1,
    "TermPeriod": 1,
    "Type": 1,
    "UserAmount1": 1,
    "UserAmount2": 1,
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserChar4": "text",
    "UserDate1": "2025-11-06",
    "UserDate2": "2025-11-06",
    "WarningCode": [
      {
        "EntryId": 1,
        "WarningCode": 1
      }
    ],
    "WithdrawalFeeType": 1,
    "WithdrawalLimit": 1,
    "WithholdingCode": 1
  }
}

getShareDefaultPagedList

post

Returns paged list of share defaults

Authorizations
Body
Responses
200

Successful operation.

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

{
  "ShareDefault": [
    {
      "AmortizationSchd": 1,
      "AmortizationSchdType": 1,
      "AuthFeeOption": [
        {
          "EntryId": 1,
          "AuthFeeOption": 1
        }
      ],
      "BumpEffectiveDate": "2025-11-06",
      "BumpExpirationDate": "2025-11-06",
      "BumpRate": 1,
      "CallItemSchd": 1,
      "CallItemSchdType": 1,
      "CappedFeesAmountCap": 1,
      "CappedFeesCountCap": 1,
      "CertificateNumber": "text",
      "Chapter4WithholdingCode": 1,
      "CheckDigits": "text",
      "CloseDate": "2025-11-06",
      "CorporateUserTransferCode": 1,
      "CreditReportingCode": 1,
      "CuTotalsUseCode": 1,
      "Description": "text",
      "DivDisbUpdtActvtyD": 1,
      "DivPostCode": 1,
      "DivRate": 1,
      "DivType": 1,
      "DividendRateMargin": 1,
      "DividendRateMarginSign": 1,
      "DividendRateMax": 1,
      "DividendRateMin": 1,
      "DividendRatePeriodDate": "2025-11-06",
      "DividendRatePeriodFreq": 1,
      "ExtAchXfrDailyLimitIn": 1,
      "ExtAchXfrDailyLimitOut": 1,
      "InsuranceMaximum": 1,
      "InsuranceType": 1,
      "IrsCode": 1,
      "IrsPlan": 1,
      "MaturityDate": "2025-11-06",
      "MaturityPostCode": 1,
      "MemberBranchSupport": 1,
      "MemberUserTransferCode": 1,
      "MinimumBalance": 1,
      "MinimumDeposit": 1,
      "MinimumWithdrawal": 1,
      "NegativeBalanceNoticeNumber": 1,
      "NegativeBalanceNoticeType": 1,
      "Nickname": "text",
      "OdtAuthFeeSrcCodeList": [
        {
          "EntryId": 1,
          "OdtAuthFeeSrcCodeList": "text"
        }
      ],
      "OverdraftTolerance": 1,
      "PenaltyType": 1,
      "PeriodicCap": 1,
      "PeriodicStartRate": 1,
      "PutItemSchd": 1,
      "PutItemSchdType": 1,
      "Reference": "text",
      "RegDCtrStartDay": 1,
      "RenewShareType": 1,
      "RenewTermFreq": 1,
      "RenewTermPeriod": 1,
      "Service": [
        {
          "EntryId": 1,
          "Service": 1
        }
      ],
      "ShareCode": 1,
      "ShareType": 1,
      "StateWithholdingCode": 1,
      "StatementGroup": 1,
      "StatementMailCode": 1,
      "SweepBalanceType": 1,
      "SweepPriority": 1,
      "SweepTargetMaximum": 1,
      "SweepTargetMinimum": 1,
      "TermFrequency": 1,
      "TermPeriod": 1,
      "Type": 1,
      "UserAmount1": 1,
      "UserAmount2": 1,
      "UserChar1": "text",
      "UserChar2": "text",
      "UserChar3": "text",
      "UserChar4": "text",
      "UserDate1": "2025-11-06",
      "UserDate2": "2025-11-06",
      "WarningCode": [
        {
          "EntryId": 1,
          "WarningCode": 1
        }
      ],
      "WithdrawalFeeType": 1,
      "WithdrawalLimit": 1,
      "WithholdingCode": 1
    }
  ],
  "Token": "text"
}

getShareDefaultListSelectFields

post

Returns the list of share defaults with select fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllShareDefaultFields": true,
    "ShareDefaultFields": {
      "AmortizationSchd": true,
      "AmortizationSchdType": true,
      "AuthFeeOption": [
        1
      ],
      "BumpEffectiveDate": true,
      "BumpExpirationDate": true,
      "BumpRate": true,
      "CallItemSchd": true,
      "CallItemSchdType": true,
      "CappedFeesAmountCap": true,
      "CappedFeesCountCap": true,
      "CertificateNumber": true,
      "Chapter4WithholdingCode": true,
      "CheckDigits": true,
      "CloseDate": true,
      "CorporateUserTransferCode": true,
      "CreditReportingCode": true,
      "CuTotalsUseCode": true,
      "Description": true,
      "DivDisbUpdtActvtyD": true,
      "DivPostCode": true,
      "DivRate": true,
      "DivType": true,
      "DividendRateMargin": true,
      "DividendRateMarginSign": true,
      "DividendRateMax": true,
      "DividendRateMin": true,
      "DividendRatePeriodDate": true,
      "DividendRatePeriodFreq": true,
      "ExtAchXfrDailyLimitIn": true,
      "ExtAchXfrDailyLimitOut": true,
      "InsuranceMaximum": true,
      "InsuranceType": true,
      "IrsCode": true,
      "IrsPlan": true,
      "MaturityDate": true,
      "MaturityPostCode": true,
      "MemberBranchSupport": true,
      "MemberUserTransferCode": true,
      "MinimumBalance": true,
      "MinimumDeposit": true,
      "MinimumWithdrawal": true,
      "NegativeBalanceNoticeNumber": true,
      "NegativeBalanceNoticeType": true,
      "Nickname": true,
      "OdtAuthFeeSrcCodeList": [
        1
      ],
      "OverdraftTolerance": true,
      "PenaltyType": true,
      "PeriodicCap": true,
      "PeriodicStartRate": true,
      "PutItemSchd": true,
      "PutItemSchdType": true,
      "Reference": true,
      "RegDCtrStartDay": true,
      "RenewShareType": true,
      "RenewTermFreq": true,
      "RenewTermPeriod": true,
      "Service": [
        1
      ],
      "ShareCode": true,
      "ShareType": true,
      "StateWithholdingCode": true,
      "StatementGroup": true,
      "StatementMailCode": true,
      "SweepBalanceType": true,
      "SweepPriority": true,
      "SweepTargetMaximum": true,
      "SweepTargetMinimum": true,
      "TermFrequency": true,
      "TermPeriod": true,
      "Type": true,
      "UserAmount1": true,
      "UserAmount2": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserDate1": true,
      "UserDate2": true,
      "WarningCode": [
        1
      ],
      "WithdrawalFeeType": true,
      "WithdrawalLimit": true,
      "WithholdingCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ShareDefaultList": {
    "hasReachedMaximumListSize": true,
    "ShareDefault": [
      {
        "AmortizationSchd": 1,
        "AmortizationSchdType": 1,
        "AuthFeeOption": [
          {
            "EntryId": 1,
            "AuthFeeOption": 1
          }
        ],
        "BumpEffectiveDate": "2025-11-06",
        "BumpExpirationDate": "2025-11-06",
        "BumpRate": 1,
        "CallItemSchd": 1,
        "CallItemSchdType": 1,
        "CappedFeesAmountCap": 1,
        "CappedFeesCountCap": 1,
        "CertificateNumber": "text",
        "Chapter4WithholdingCode": 1,
        "CheckDigits": "text",
        "CloseDate": "2025-11-06",
        "CorporateUserTransferCode": 1,
        "CreditReportingCode": 1,
        "CuTotalsUseCode": 1,
        "Description": "text",
        "DivDisbUpdtActvtyD": 1,
        "DivPostCode": 1,
        "DivRate": 1,
        "DivType": 1,
        "DividendRateMargin": 1,
        "DividendRateMarginSign": 1,
        "DividendRateMax": 1,
        "DividendRateMin": 1,
        "DividendRatePeriodDate": "2025-11-06",
        "DividendRatePeriodFreq": 1,
        "ExtAchXfrDailyLimitIn": 1,
        "ExtAchXfrDailyLimitOut": 1,
        "InsuranceMaximum": 1,
        "InsuranceType": 1,
        "IrsCode": 1,
        "IrsPlan": 1,
        "MaturityDate": "2025-11-06",
        "MaturityPostCode": 1,
        "MemberBranchSupport": 1,
        "MemberUserTransferCode": 1,
        "MinimumBalance": 1,
        "MinimumDeposit": 1,
        "MinimumWithdrawal": 1,
        "NegativeBalanceNoticeNumber": 1,
        "NegativeBalanceNoticeType": 1,
        "Nickname": "text",
        "OdtAuthFeeSrcCodeList": [
          {
            "EntryId": 1,
            "OdtAuthFeeSrcCodeList": "text"
          }
        ],
        "OverdraftTolerance": 1,
        "PenaltyType": 1,
        "PeriodicCap": 1,
        "PeriodicStartRate": 1,
        "PutItemSchd": 1,
        "PutItemSchdType": 1,
        "Reference": "text",
        "RegDCtrStartDay": 1,
        "RenewShareType": 1,
        "RenewTermFreq": 1,
        "RenewTermPeriod": 1,
        "Service": [
          {
            "EntryId": 1,
            "Service": 1
          }
        ],
        "ShareCode": 1,
        "ShareType": 1,
        "StateWithholdingCode": 1,
        "StatementGroup": 1,
        "StatementMailCode": 1,
        "SweepBalanceType": 1,
        "SweepPriority": 1,
        "SweepTargetMaximum": 1,
        "SweepTargetMinimum": 1,
        "TermFrequency": 1,
        "TermPeriod": 1,
        "Type": 1,
        "UserAmount1": 1,
        "UserAmount2": 1,
        "UserChar1": "text",
        "UserChar2": "text",
        "UserChar3": "text",
        "UserChar4": "text",
        "UserDate1": "2025-11-06",
        "UserDate2": "2025-11-06",
        "WarningCode": [
          {
            "EntryId": 1,
            "WarningCode": 1
          }
        ],
        "WithdrawalFeeType": 1,
        "WithdrawalLimit": 1,
        "WithholdingCode": 1
      }
    ]
  }
}

searchShareDefaultSelectFields

post

Retrieve a list of select fields for default shares

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllShareDefaultFields": true,
    "ShareDefaultFields": {
      "AmortizationSchd": true,
      "AmortizationSchdType": true,
      "AuthFeeOption": [
        1
      ],
      "BumpEffectiveDate": true,
      "BumpExpirationDate": true,
      "BumpRate": true,
      "CallItemSchd": true,
      "CallItemSchdType": true,
      "CappedFeesAmountCap": true,
      "CappedFeesCountCap": true,
      "CertificateNumber": true,
      "Chapter4WithholdingCode": true,
      "CheckDigits": true,
      "CloseDate": true,
      "CorporateUserTransferCode": true,
      "CreditReportingCode": true,
      "CuTotalsUseCode": true,
      "Description": true,
      "DivDisbUpdtActvtyD": true,
      "DivPostCode": true,
      "DivRate": true,
      "DivType": true,
      "DividendRateMargin": true,
      "DividendRateMarginSign": true,
      "DividendRateMax": true,
      "DividendRateMin": true,
      "DividendRatePeriodDate": true,
      "DividendRatePeriodFreq": true,
      "ExtAchXfrDailyLimitIn": true,
      "ExtAchXfrDailyLimitOut": true,
      "InsuranceMaximum": true,
      "InsuranceType": true,
      "IrsCode": true,
      "IrsPlan": true,
      "MaturityDate": true,
      "MaturityPostCode": true,
      "MemberBranchSupport": true,
      "MemberUserTransferCode": true,
      "MinimumBalance": true,
      "MinimumDeposit": true,
      "MinimumWithdrawal": true,
      "NegativeBalanceNoticeNumber": true,
      "NegativeBalanceNoticeType": true,
      "Nickname": true,
      "OdtAuthFeeSrcCodeList": [
        1
      ],
      "OverdraftTolerance": true,
      "PenaltyType": true,
      "PeriodicCap": true,
      "PeriodicStartRate": true,
      "PutItemSchd": true,
      "PutItemSchdType": true,
      "Reference": true,
      "RegDCtrStartDay": true,
      "RenewShareType": true,
      "RenewTermFreq": true,
      "RenewTermPeriod": true,
      "Service": [
        1
      ],
      "ShareCode": true,
      "ShareType": true,
      "StateWithholdingCode": true,
      "StatementGroup": true,
      "StatementMailCode": true,
      "SweepBalanceType": true,
      "SweepPriority": true,
      "SweepTargetMaximum": true,
      "SweepTargetMinimum": true,
      "TermFrequency": true,
      "TermPeriod": true,
      "Type": true,
      "UserAmount1": true,
      "UserAmount2": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserDate1": true,
      "UserDate2": true,
      "WarningCode": [
        1
      ],
      "WithdrawalFeeType": true,
      "WithdrawalLimit": true,
      "WithholdingCode": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ShareDefaultList": {
    "hasReachedMaximumListSize": true,
    "ShareDefault": [
      {
        "AmortizationSchd": 1,
        "AmortizationSchdType": 1,
        "AuthFeeOption": [
          {
            "EntryId": 1,
            "AuthFeeOption": 1
          }
        ],
        "BumpEffectiveDate": "2025-11-06",
        "BumpExpirationDate": "2025-11-06",
        "BumpRate": 1,
        "CallItemSchd": 1,
        "CallItemSchdType": 1,
        "CappedFeesAmountCap": 1,
        "CappedFeesCountCap": 1,
        "CertificateNumber": "text",
        "Chapter4WithholdingCode": 1,
        "CheckDigits": "text",
        "CloseDate": "2025-11-06",
        "CorporateUserTransferCode": 1,
        "CreditReportingCode": 1,
        "CuTotalsUseCode": 1,
        "Description": "text",
        "DivDisbUpdtActvtyD": 1,
        "DivPostCode": 1,
        "DivRate": 1,
        "DivType": 1,
        "DividendRateMargin": 1,
        "DividendRateMarginSign": 1,
        "DividendRateMax": 1,
        "DividendRateMin": 1,
        "DividendRatePeriodDate": "2025-11-06",
        "DividendRatePeriodFreq": 1,
        "ExtAchXfrDailyLimitIn": 1,
        "ExtAchXfrDailyLimitOut": 1,
        "InsuranceMaximum": 1,
        "InsuranceType": 1,
        "IrsCode": 1,
        "IrsPlan": 1,
        "MaturityDate": "2025-11-06",
        "MaturityPostCode": 1,
        "MemberBranchSupport": 1,
        "MemberUserTransferCode": 1,
        "MinimumBalance": 1,
        "MinimumDeposit": 1,
        "MinimumWithdrawal": 1,
        "NegativeBalanceNoticeNumber": 1,
        "NegativeBalanceNoticeType": 1,
        "Nickname": "text",
        "OdtAuthFeeSrcCodeList": [
          {
            "EntryId": 1,
            "OdtAuthFeeSrcCodeList": "text"
          }
        ],
        "OverdraftTolerance": 1,
        "PenaltyType": 1,
        "PeriodicCap": 1,
        "PeriodicStartRate": 1,
        "PutItemSchd": 1,
        "PutItemSchdType": 1,
        "Reference": "text",
        "RegDCtrStartDay": 1,
        "RenewShareType": 1,
        "RenewTermFreq": 1,
        "RenewTermPeriod": 1,
        "Service": [
          {
            "EntryId": 1,
            "Service": 1
          }
        ],
        "ShareCode": 1,
        "ShareType": 1,
        "StateWithholdingCode": 1,
        "StatementGroup": 1,
        "StatementMailCode": 1,
        "SweepBalanceType": 1,
        "SweepPriority": 1,
        "SweepTargetMaximum": 1,
        "SweepTargetMinimum": 1,
        "TermFrequency": 1,
        "TermPeriod": 1,
        "Type": 1,
        "UserAmount1": 1,
        "UserAmount2": 1,
        "UserChar1": "text",
        "UserChar2": "text",
        "UserChar3": "text",
        "UserChar4": "text",
        "UserDate1": "2025-11-06",
        "UserDate2": "2025-11-06",
        "WarningCode": [
          {
            "EntryId": 1,
            "WarningCode": 1
          }
        ],
        "WithdrawalFeeType": 1,
        "WithdrawalLimit": 1,
        "WithholdingCode": 1
      }
    ]
  }
}

getShareDefaultPagedListSelectFields

post

Returns paged list of share defaults with select fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllShareDefaultFields": true,
    "ShareDefaultFields": {
      "AmortizationSchd": true,
      "AmortizationSchdType": true,
      "AuthFeeOption": [
        1
      ],
      "BumpEffectiveDate": true,
      "BumpExpirationDate": true,
      "BumpRate": true,
      "CallItemSchd": true,
      "CallItemSchdType": true,
      "CappedFeesAmountCap": true,
      "CappedFeesCountCap": true,
      "CertificateNumber": true,
      "Chapter4WithholdingCode": true,
      "CheckDigits": true,
      "CloseDate": true,
      "CorporateUserTransferCode": true,
      "CreditReportingCode": true,
      "CuTotalsUseCode": true,
      "Description": true,
      "DivDisbUpdtActvtyD": true,
      "DivPostCode": true,
      "DivRate": true,
      "DivType": true,
      "DividendRateMargin": true,
      "DividendRateMarginSign": true,
      "DividendRateMax": true,
      "DividendRateMin": true,
      "DividendRatePeriodDate": true,
      "DividendRatePeriodFreq": true,
      "ExtAchXfrDailyLimitIn": true,
      "ExtAchXfrDailyLimitOut": true,
      "InsuranceMaximum": true,
      "InsuranceType": true,
      "IrsCode": true,
      "IrsPlan": true,
      "MaturityDate": true,
      "MaturityPostCode": true,
      "MemberBranchSupport": true,
      "MemberUserTransferCode": true,
      "MinimumBalance": true,
      "MinimumDeposit": true,
      "MinimumWithdrawal": true,
      "NegativeBalanceNoticeNumber": true,
      "NegativeBalanceNoticeType": true,
      "Nickname": true,
      "OdtAuthFeeSrcCodeList": [
        1
      ],
      "OverdraftTolerance": true,
      "PenaltyType": true,
      "PeriodicCap": true,
      "PeriodicStartRate": true,
      "PutItemSchd": true,
      "PutItemSchdType": true,
      "Reference": true,
      "RegDCtrStartDay": true,
      "RenewShareType": true,
      "RenewTermFreq": true,
      "RenewTermPeriod": true,
      "Service": [
        1
      ],
      "ShareCode": true,
      "ShareType": true,
      "StateWithholdingCode": true,
      "StatementGroup": true,
      "StatementMailCode": true,
      "SweepBalanceType": true,
      "SweepPriority": true,
      "SweepTargetMaximum": true,
      "SweepTargetMinimum": true,
      "TermFrequency": true,
      "TermPeriod": true,
      "Type": true,
      "UserAmount1": true,
      "UserAmount2": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserDate1": true,
      "UserDate2": true,
      "WarningCode": [
        1
      ],
      "WithdrawalFeeType": true,
      "WithdrawalLimit": true,
      "WithholdingCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ShareDefault": [
    {
      "AmortizationSchd": 1,
      "AmortizationSchdType": 1,
      "AuthFeeOption": [
        {
          "EntryId": 1,
          "AuthFeeOption": 1
        }
      ],
      "BumpEffectiveDate": "2025-11-06",
      "BumpExpirationDate": "2025-11-06",
      "BumpRate": 1,
      "CallItemSchd": 1,
      "CallItemSchdType": 1,
      "CappedFeesAmountCap": 1,
      "CappedFeesCountCap": 1,
      "CertificateNumber": "text",
      "Chapter4WithholdingCode": 1,
      "CheckDigits": "text",
      "CloseDate": "2025-11-06",
      "CorporateUserTransferCode": 1,
      "CreditReportingCode": 1,
      "CuTotalsUseCode": 1,
      "Description": "text",
      "DivDisbUpdtActvtyD": 1,
      "DivPostCode": 1,
      "DivRate": 1,
      "DivType": 1,
      "DividendRateMargin": 1,
      "DividendRateMarginSign": 1,
      "DividendRateMax": 1,
      "DividendRateMin": 1,
      "DividendRatePeriodDate": "2025-11-06",
      "DividendRatePeriodFreq": 1,
      "ExtAchXfrDailyLimitIn": 1,
      "ExtAchXfrDailyLimitOut": 1,
      "InsuranceMaximum": 1,
      "InsuranceType": 1,
      "IrsCode": 1,
      "IrsPlan": 1,
      "MaturityDate": "2025-11-06",
      "MaturityPostCode": 1,
      "MemberBranchSupport": 1,
      "MemberUserTransferCode": 1,
      "MinimumBalance": 1,
      "MinimumDeposit": 1,
      "MinimumWithdrawal": 1,
      "NegativeBalanceNoticeNumber": 1,
      "NegativeBalanceNoticeType": 1,
      "Nickname": "text",
      "OdtAuthFeeSrcCodeList": [
        {
          "EntryId": 1,
          "OdtAuthFeeSrcCodeList": "text"
        }
      ],
      "OverdraftTolerance": 1,
      "PenaltyType": 1,
      "PeriodicCap": 1,
      "PeriodicStartRate": 1,
      "PutItemSchd": 1,
      "PutItemSchdType": 1,
      "Reference": "text",
      "RegDCtrStartDay": 1,
      "RenewShareType": 1,
      "RenewTermFreq": 1,
      "RenewTermPeriod": 1,
      "Service": [
        {
          "EntryId": 1,
          "Service": 1
        }
      ],
      "ShareCode": 1,
      "ShareType": 1,
      "StateWithholdingCode": 1,
      "StatementGroup": 1,
      "StatementMailCode": 1,
      "SweepBalanceType": 1,
      "SweepPriority": 1,
      "SweepTargetMaximum": 1,
      "SweepTargetMinimum": 1,
      "TermFrequency": 1,
      "TermPeriod": 1,
      "Type": 1,
      "UserAmount1": 1,
      "UserAmount2": 1,
      "UserChar1": "text",
      "UserChar2": "text",
      "UserChar3": "text",
      "UserChar4": "text",
      "UserDate1": "2025-11-06",
      "UserDate2": "2025-11-06",
      "WarningCode": [
        {
          "EntryId": 1,
          "WarningCode": 1
        }
      ],
      "WithdrawalFeeType": 1,
      "WithdrawalLimit": 1,
      "WithholdingCode": 1
    }
  ],
  "Token": "text"
}

searchShareDefaultPagedSelectFields

post

Retrieve a paged list of select fields for default shares

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllShareDefaultFields": true,
    "ShareDefaultFields": {
      "AmortizationSchd": true,
      "AmortizationSchdType": true,
      "AuthFeeOption": [
        1
      ],
      "BumpEffectiveDate": true,
      "BumpExpirationDate": true,
      "BumpRate": true,
      "CallItemSchd": true,
      "CallItemSchdType": true,
      "CappedFeesAmountCap": true,
      "CappedFeesCountCap": true,
      "CertificateNumber": true,
      "Chapter4WithholdingCode": true,
      "CheckDigits": true,
      "CloseDate": true,
      "CorporateUserTransferCode": true,
      "CreditReportingCode": true,
      "CuTotalsUseCode": true,
      "Description": true,
      "DivDisbUpdtActvtyD": true,
      "DivPostCode": true,
      "DivRate": true,
      "DivType": true,
      "DividendRateMargin": true,
      "DividendRateMarginSign": true,
      "DividendRateMax": true,
      "DividendRateMin": true,
      "DividendRatePeriodDate": true,
      "DividendRatePeriodFreq": true,
      "ExtAchXfrDailyLimitIn": true,
      "ExtAchXfrDailyLimitOut": true,
      "InsuranceMaximum": true,
      "InsuranceType": true,
      "IrsCode": true,
      "IrsPlan": true,
      "MaturityDate": true,
      "MaturityPostCode": true,
      "MemberBranchSupport": true,
      "MemberUserTransferCode": true,
      "MinimumBalance": true,
      "MinimumDeposit": true,
      "MinimumWithdrawal": true,
      "NegativeBalanceNoticeNumber": true,
      "NegativeBalanceNoticeType": true,
      "Nickname": true,
      "OdtAuthFeeSrcCodeList": [
        1
      ],
      "OverdraftTolerance": true,
      "PenaltyType": true,
      "PeriodicCap": true,
      "PeriodicStartRate": true,
      "PutItemSchd": true,
      "PutItemSchdType": true,
      "Reference": true,
      "RegDCtrStartDay": true,
      "RenewShareType": true,
      "RenewTermFreq": true,
      "RenewTermPeriod": true,
      "Service": [
        1
      ],
      "ShareCode": true,
      "ShareType": true,
      "StateWithholdingCode": true,
      "StatementGroup": true,
      "StatementMailCode": true,
      "SweepBalanceType": true,
      "SweepPriority": true,
      "SweepTargetMaximum": true,
      "SweepTargetMinimum": true,
      "TermFrequency": true,
      "TermPeriod": true,
      "Type": true,
      "UserAmount1": true,
      "UserAmount2": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserDate1": true,
      "UserDate2": true,
      "WarningCode": [
        1
      ],
      "WithdrawalFeeType": true,
      "WithdrawalLimit": true,
      "WithholdingCode": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ShareDefault": [
    {
      "AmortizationSchd": 1,
      "AmortizationSchdType": 1,
      "AuthFeeOption": [
        {
          "EntryId": 1,
          "AuthFeeOption": 1
        }
      ],
      "BumpEffectiveDate": "2025-11-06",
      "BumpExpirationDate": "2025-11-06",
      "BumpRate": 1,
      "CallItemSchd": 1,
      "CallItemSchdType": 1,
      "CappedFeesAmountCap": 1,
      "CappedFeesCountCap": 1,
      "CertificateNumber": "text",
      "Chapter4WithholdingCode": 1,
      "CheckDigits": "text",
      "CloseDate": "2025-11-06",
      "CorporateUserTransferCode": 1,
      "CreditReportingCode": 1,
      "CuTotalsUseCode": 1,
      "Description": "text",
      "DivDisbUpdtActvtyD": 1,
      "DivPostCode": 1,
      "DivRate": 1,
      "DivType": 1,
      "DividendRateMargin": 1,
      "DividendRateMarginSign": 1,
      "DividendRateMax": 1,
      "DividendRateMin": 1,
      "DividendRatePeriodDate": "2025-11-06",
      "DividendRatePeriodFreq": 1,
      "ExtAchXfrDailyLimitIn": 1,
      "ExtAchXfrDailyLimitOut": 1,
      "InsuranceMaximum": 1,
      "InsuranceType": 1,
      "IrsCode": 1,
      "IrsPlan": 1,
      "MaturityDate": "2025-11-06",
      "MaturityPostCode": 1,
      "MemberBranchSupport": 1,
      "MemberUserTransferCode": 1,
      "MinimumBalance": 1,
      "MinimumDeposit": 1,
      "MinimumWithdrawal": 1,
      "NegativeBalanceNoticeNumber": 1,
      "NegativeBalanceNoticeType": 1,
      "Nickname": "text",
      "OdtAuthFeeSrcCodeList": [
        {
          "EntryId": 1,
          "OdtAuthFeeSrcCodeList": "text"
        }
      ],
      "OverdraftTolerance": 1,
      "PenaltyType": 1,
      "PeriodicCap": 1,
      "PeriodicStartRate": 1,
      "PutItemSchd": 1,
      "PutItemSchdType": 1,
      "Reference": "text",
      "RegDCtrStartDay": 1,
      "RenewShareType": 1,
      "RenewTermFreq": 1,
      "RenewTermPeriod": 1,
      "Service": [
        {
          "EntryId": 1,
          "Service": 1
        }
      ],
      "ShareCode": 1,
      "ShareType": 1,
      "StateWithholdingCode": 1,
      "StatementGroup": 1,
      "StatementMailCode": 1,
      "SweepBalanceType": 1,
      "SweepPriority": 1,
      "SweepTargetMaximum": 1,
      "SweepTargetMinimum": 1,
      "TermFrequency": 1,
      "TermPeriod": 1,
      "Type": 1,
      "UserAmount1": 1,
      "UserAmount2": 1,
      "UserChar1": "text",
      "UserChar2": "text",
      "UserChar3": "text",
      "UserChar4": "text",
      "UserDate1": "2025-11-06",
      "UserDate2": "2025-11-06",
      "WarningCode": [
        {
          "EntryId": 1,
          "WarningCode": 1
        }
      ],
      "WithdrawalFeeType": 1,
      "WithdrawalLimit": 1,
      "WithholdingCode": 1
    }
  ],
  "Token": "text"
}

updateShareDefaultByID

post

Update default shares by ID

Authorizations
Body
ShareDefaultShareTypeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ShareDefaultShareType": 1,
  "ShareDefaultUpdatableFields": {
    "AmortizationSchd": 1,
    "AmortizationSchdType": 1,
    "AuthFeeOption": [
      {
        "EntryId": 1,
        "AuthFeeOption": 1
      }
    ],
    "BumpEffectiveDate": "2025-11-06",
    "BumpExpirationDate": "2025-11-06",
    "BumpRate": 1,
    "CallItemSchd": 1,
    "CallItemSchdType": 1,
    "CappedFeesAmountCap": 1,
    "CappedFeesCountCap": 1,
    "CertificateNumber": "text",
    "Chapter4WithholdingCode": 1,
    "CheckDigits": "text",
    "CloseDate": "2025-11-06",
    "CorporateUserTransferCode": 1,
    "CreditReportingCode": 1,
    "CuTotalsUseCode": 1,
    "Description": "text",
    "DivDisbUpdtActvtyD": 1,
    "DivPostCode": 1,
    "DivRate": 1,
    "DivType": 1,
    "DividendRateMargin": 1,
    "DividendRateMarginSign": 1,
    "DividendRateMax": 1,
    "DividendRateMin": 1,
    "DividendRatePeriodDate": "2025-11-06",
    "DividendRatePeriodFreq": 1,
    "ExtAchXfrDailyLimitIn": 1,
    "ExtAchXfrDailyLimitOut": 1,
    "InsuranceMaximum": 1,
    "InsuranceType": 1,
    "IrsCode": 1,
    "IrsPlan": 1,
    "MaturityDate": "2025-11-06",
    "MaturityPostCode": 1,
    "MemberBranchSupport": 1,
    "MemberUserTransferCode": 1,
    "MinimumBalance": 1,
    "MinimumDeposit": 1,
    "MinimumWithdrawal": 1,
    "NegativeBalanceNoticeNumber": 1,
    "NegativeBalanceNoticeType": 1,
    "Nickname": "text",
    "OdtAuthFeeSrcCodeList": [
      {
        "EntryId": 1,
        "OdtAuthFeeSrcCodeList": "text"
      }
    ],
    "OverdraftTolerance": 1,
    "PenaltyType": 1,
    "PeriodicCap": 1,
    "PeriodicStartRate": 1,
    "PutItemSchd": 1,
    "PutItemSchdType": 1,
    "Reference": "text",
    "RegDCtrStartDay": 1,
    "RenewShareType": 1,
    "RenewTermFreq": 1,
    "RenewTermPeriod": 1,
    "Service": [
      {
        "EntryId": 1,
        "Service": 1
      }
    ],
    "ShareCode": 1,
    "StateWithholdingCode": 1,
    "StatementGroup": 1,
    "StatementMailCode": 1,
    "SweepBalanceType": 1,
    "SweepPriority": 1,
    "SweepTargetMaximum": 1,
    "SweepTargetMinimum": 1,
    "TermFrequency": 1,
    "TermPeriod": 1,
    "UserAmount1": 1,
    "UserAmount2": 1,
    "UserChar1": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserChar4": "text",
    "UserDate1": "2025-11-06",
    "UserDate2": "2025-11-06",
    "WarningCode": [
      {
        "EntryId": 1,
        "WarningCode": 1
      }
    ],
    "WithdrawalFeeType": 1,
    "WithdrawalLimit": 1,
    "WithholdingCode": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?