PayCalc

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getPayCalc

post

Retrieve PayCalc parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PayCalcPaymentCalculationTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getPayCalc

HTTPcURLJavaScriptPython

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: 191

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PayCalcPaymentCalculationType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "PayCalc": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getPayCalc"
}

getPayCalcSelectFields

post

Retrieve PayCalc parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PayCalcPaymentCalculationTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getPayCalcSelectFields

HTTPcURLJavaScriptPython

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: 304

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PayCalcPaymentCalculationType": 1,
  "SelectableFields": {
    "PayCalcFields": {
      "PaymentCalculationType": true,
      "Description": true,
      "PaymentMinimum": true
    }
  }
}

200

Successful operation.

{
  "PayCalc": {
    "Description": "Payment Calculation Type 0001",
    "PaymentCalculationType": null,
    "PaymentMinimum": "25.00"
  },
  "MessageId": "getPayCalcSelectFields"
}

getPayCalcPagedList

post

Retrieve PayCalc parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getPayCalcPagedList

HTTPcURLJavaScriptPython

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: 260

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "PayCalc": [],
  "Token": null,
  "MessageId": "getPayCalcPagedList"
}

getPayCalcListSelectFields

post

Retrieve PayCalc parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getPayCalcListSelectFields

HTTPcURLJavaScriptPython

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: 212

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllPayCalcFields": true
  }
}

200

Successful operation.

{
  "PayCalcList": [],
  "MessageId": "getPayCalcListSelectFields"
}

searchPayCalcSelectFields

post

Search PayCalc parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/searchPayCalcSelectFields

HTTPcURLJavaScriptPython

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: 250

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SelectableFields": {
    "IncludeAllPayCalcFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "PayCalcList": [],
  "MessageId": "searchPayCalcSelectFields"
}

getPayCalcPagedListSelectFields

post

Retrieve PayCalc parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getPayCalcPagedListSelectFields

HTTPcURLJavaScriptPython

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: 291

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllPayCalcFields": true
  }
}

200

Successful operation.

{
  "PayCalc": [],
  "Token": null,
  "MessageId": "getPayCalcPagedListSelectFields"
}

searchPayCalcPagedSelectFields

post

Search PayCalc parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchPayCalcPagedSelectFields

HTTPcURLJavaScriptPython

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: 302

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "IncludeAllPayCalcFields": true
  }
}

200

Successful operation.

{
  "PayCalc": [],
  "Token": null,
  "MessageId": "searchPayCalcPagedSelectFields"
}

updatePayCalcByID

post

Update PayCalc parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PayCalcPaymentCalculationTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updatePayCalcByID

HTTPcURLJavaScriptPython

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: 257

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PayCalcPaymentCalculationType": 1,
  "PayCalcUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updatePayCalcByID"
}