Skip to content
NexumAPI Docs

PmtAppMethod⁠

Perform various operations for Symitar parameters.

Operations⁠

getPmtAppMethodSelectFields⁠

POST

Execute the persistent ParameterService getPmtAppMethodSelectFields operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "PmtAppMethodType": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllPmtAppMethodFields": true,
    "PmtAppMethodFields": {
      "CreateAddlPrincipalComment": true,
      "CurrentExcessOrder": [
        0
      ],
      "DefinedCode": true,
      "Description": true,
      "DqExcessOrder": [
        0
      ],
      "GracePmtExcessOrder": [
        0
      ],
      "IncludeEscrowUnpdinPmtDue": true,
      "PaymentOrder": [
        0
      ],
      "PrepaidExcessOrder": [
        0
      ],
      "ThresholdPaymentIndicator": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getPmtAppMethodPagedListSelectFields⁠

POST

Execute the persistent ParameterService getPmtAppMethodPagedListSelectFields 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/getPmtAppMethodPagedListSelectFields
POST /nexum/627/persistent/parameter/getPmtAppMethodPagedListSelectFields 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": {
    "IncludeAllPmtAppMethodFields": true,
    "PmtAppMethodFields": {
      "CreateAddlPrincipalComment": true,
      "CurrentExcessOrder": [
        0
      ],
      "DefinedCode": true,
      "Description": true,
      "DqExcessOrder": [
        0
      ],
      "GracePmtExcessOrder": [
        0
      ],
      "IncludeEscrowUnpdinPmtDue": true,
      "PaymentOrder": [
        0
      ],
      "PrepaidExcessOrder": [
        0
      ],
      "ThresholdPaymentIndicator": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchPmtAppMethodPagedSelectFields⁠

POST

Execute the persistent ParameterService searchPmtAppMethodPagedSelectFields 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/searchPmtAppMethodPagedSelectFields
POST /nexum/627/persistent/parameter/searchPmtAppMethodPagedSelectFields 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": {
    "IncludeAllPmtAppMethodFields": true,
    "PmtAppMethodFields": {
      "CreateAddlPrincipalComment": true,
      "CurrentExcessOrder": [
        0
      ],
      "DefinedCode": true,
      "Description": true,
      "DqExcessOrder": [
        0
      ],
      "GracePmtExcessOrder": [
        0
      ],
      "IncludeEscrowUnpdinPmtDue": true,
      "PaymentOrder": [
        0
      ],
      "PrepaidExcessOrder": [
        0
      ],
      "ThresholdPaymentIndicator": true,
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updatePmtAppMethodByID⁠

POST

Execute the persistent ParameterService updatePmtAppMethodByID operation.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "PmtAppMethodType": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PmtAppMethodFields": {
    "CreateAddlPrincipalComment": true,
    "CurrentExcessOrder": [
      {
        "EntryId": 0,
        "CurrentExcessOrder": 0
      }
    ],
    "DefinedCode": 0,
    "Description": "string",
    "DqExcessOrder": [
      {
        "EntryId": 0,
        "DqExcessOrder": 0
      }
    ],
    "GracePmtExcessOrder": [
      {
        "EntryId": 0,
        "GracePmtExcessOrder": 0
      }
    ],
    "IncludeEscrowUnpdinPmtDue": true,
    "PaymentOrder": [
      {
        "EntryId": 0,
        "PaymentOrder": 0
      }
    ],
    "PrepaidExcessOrder": [
      {
        "EntryId": 0,
        "PrepaidExcessOrder": 0
      }
    ],
    "ThresholdPaymentIndicator": 0,
    "Type": 0
  },
  "nxAttributes": {
    "customFields": {}
  }
}