StmtMailName

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getStmtMailName

post

Retrieve getStmtMailName data.

Authorizations
Body
StmtMailNameStatementMailCodeintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "StmtMailName": {
    "StatementMailCode": 1,
    "StatementMailCodeName": "text"
  }
}

getStmtMailNameSelectFields

post

Retrieve getStmtMailNameSelectFields data.

Authorizations
Body
StmtMailNameStatementMailCodeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "StmtMailNameStatementMailCode": 1,
  "SelectableFields": {
    "IncludeAllStmtMailNameFields": true,
    "StmtMailNameFields": {
      "StatementMailCode": true,
      "StatementMailCodeName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StmtMailName": {
    "StatementMailCode": 1,
    "StatementMailCodeName": "text"
  }
}

getStmtMailNamePagedList

post

Retrieve getStmtMailNamePagedList data.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "StmtMailName": [
    {
      "StatementMailCode": 1,
      "StatementMailCodeName": "text"
    }
  ],
  "Token": "text"
}

getStmtMailNameListSelectFields

post

Retrieve getStmtMailNameListSelectFields data.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllStmtMailNameFields": true,
    "StmtMailNameFields": {
      "StatementMailCode": true,
      "StatementMailCodeName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StmtMailNameList": {
    "hasReachedMaximumListSize": true,
    "StmtMailName": [
      {
        "StatementMailCode": 1,
        "StatementMailCodeName": "text"
      }
    ]
  }
}

searchStmtMailNameSelectFields

post

Retrieve a list of select fields for statement mail names

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllStmtMailNameFields": true,
    "StmtMailNameFields": {
      "StatementMailCode": true,
      "StatementMailCodeName": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StmtMailNameList": {
    "hasReachedMaximumListSize": true,
    "StmtMailName": [
      {
        "StatementMailCode": 1,
        "StatementMailCodeName": "text"
      }
    ]
  }
}

getStmtMailNamePagedListSelectFields

post

Retrieve getStmtMailNamePagedListSelectFields data.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllStmtMailNameFields": true,
    "StmtMailNameFields": {
      "StatementMailCode": true,
      "StatementMailCodeName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StmtMailName": [
    {
      "StatementMailCode": 1,
      "StatementMailCodeName": "text"
    }
  ],
  "Token": "text"
}

searchStmtMailNamePagedSelectFields

post

Retrieve a paged list of select fields for statement mail names

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllStmtMailNameFields": true,
    "StmtMailNameFields": {
      "StatementMailCode": true,
      "StatementMailCodeName": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StmtMailName": [
    {
      "StatementMailCode": 1,
      "StatementMailCodeName": "text"
    }
  ],
  "Token": "text"
}

updateStmtMailNameByID

post

Update statement mail names by ID

Authorizations
Body
StmtMailNameStatementMailCodeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "StmtMailNameStatementMailCode": 1,
  "StmtMailNameUpdatableFields": {
    "StatementMailCodeName": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?