CheckService

Manage checks.

Symitar eDocs References: Coming soon.

Operations

getCheckSelectFields

post

Retrieves a check with selected fields.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post

/getCheckSelectFields

POST /nexum/627/persistent/check/getCheckSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 749

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckGlobalSequenceDate": "2025-12-25",
  "CheckGlobalSequence": 1,
  "SelectableFields": {
    "IncludeAllCheckFields": true,
    "CheckFields": {
      "AccountCode": true,
      "AccountNumber": true,
      "Amount": true,
      "Branch": true,
      "CheckNumberAssigned": true,
      "EscheatDate": true,
      "FmLastPurgeDate": true,
      "GlobalSequence": true,
      "GlobalSequenceDate": true,
      "Id": true,
      "IdType": true,
      "IssueDate": true,
      "Number": true,
      "Payee": [
        1
      ],
      "PostDate": true,
      "ReconciliationDate": true,
      "RecordChangeDate": true,
      "Reference": true,
      "Reference2": true,
      "Reference3": true,
      "SequenceNumber": true,
      "Source": true,
      "SourceGlCode": true,
      "Status": true,
      "StopPmtDate": true,
      "TracerNumber": true,
      "VoidDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Check": {
    "AccountCode": "text",
    "AccountNumber": "text",
    "Amount": 1,
    "Branch": 1,
    "CheckFmHistoryList": {
      "hasReachedMaximumListSize": true,
      "CheckFmHistory": [
        {
          "AccountNumber": "text",
          "BatchSequence": 1,
          "Branch": 1,
          "ConfirmationNumber": "text",
          "ConfirmationSeq": 1,
          "ConsoleNumber": 1,
          "DataType": 1,
          "FieldName": "text",
          "FieldNumber": 1,
          "FmType": 1,
          "Id": "text",
          "IdType": 1,
          "LastFmDate": "2025-12-25",
          "NewCharacter": "text",
          "NewDate": "2025-12-25",
          "NewMoney": 1,
          "NewNumber": 1,
          "NewRate": 1,
          "OldCharacter": "text",
          "OldDate": "2025-12-25",
          "OldMoney": 1,
          "OldNumber": 1,
          "OldRate": 1,
          "PostDate": "2025-12-25",
          "PostTime": 1,
          "ProcessorUser": 1,
          "RecordName": "text",
          "RecordType": 1,
          "SecurityLevels": 1,
          "SequenceNumber": 1,
          "SubFieldNumber": 1,
          "UserNumber": 1,
          "UserOverride": 1
        }
      ]
    },
    "CheckNumberAssigned": 1,
    "EscheatDate": "2025-12-25",
    "FmLastPurgeDate": "2025-12-25",
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-12-25",
    "Id": "text",
    "IdType": 1,
    "IssueDate": "2025-12-25",
    "Number": "text",
    "Payee": [
      {
        "EntryId": 1,
        "Payee": "text"
      }
    ],
    "PostDate": "2025-12-25",
    "ReconciliationDate": "2025-12-25",
    "RecordChangeDate": "2025-12-25",
    "Reference": "text",
    "Reference2": "text",
    "Reference3": "text",
    "SequenceNumber": 1,
    "Source": 1,
    "SourceGlCode": 1,
    "Status": 1,
    "StopPmtDate": "2025-12-25",
    "TracerNumber": "text",
    "VoidDate": "2025-12-25"
  }
}

getCheckSelectFieldsFilterChildren

post

Retrieves a check with selected fields and filtered children.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post

/getCheckSelectFieldsFilterChildren

POST /nexum/627/persistent/check/getCheckSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1561

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckGlobalSequenceDate": "2025-12-25",
  "CheckGlobalSequence": 1,
  "SelectableFields": {
    "IncludeAllCheckFields": true,
    "CheckFields": {
      "AccountCode": true,
      "AccountNumber": true,
      "Amount": true,
      "Branch": true,
      "CheckNumberAssigned": true,
      "EscheatDate": true,
      "FmLastPurgeDate": true,
      "GlobalSequence": true,
      "GlobalSequenceDate": true,
      "Id": true,
      "IdType": true,
      "IssueDate": true,
      "Number": true,
      "Payee": [
        1
      ],
      "PostDate": true,
      "ReconciliationDate": true,
      "RecordChangeDate": true,
      "Reference": true,
      "Reference2": true,
      "Reference3": true,
      "SequenceNumber": true,
      "Source": true,
      "SourceGlCode": true,
      "Status": true,
      "StopPmtDate": true,
      "TracerNumber": true,
      "VoidDate": true
    },
    "CheckFmHistorySelectableFields": {
      "IncludeAllCheckFmHistoryFields": true,
      "CheckFmHistoryFields": {
        "AccountNumber": true,
        "BatchSequence": true,
        "Branch": true,
        "ConfirmationNumber": true,
        "ConfirmationSeq": true,
        "ConsoleNumber": true,
        "DataType": true,
        "FieldName": true,
        "FieldNumber": true,
        "FmType": true,
        "Id": true,
        "IdType": true,
        "LastFmDate": true,
        "NewCharacter": true,
        "NewDate": true,
        "NewMoney": true,
        "NewNumber": true,
        "NewRate": true,
        "OldCharacter": true,
        "OldDate": true,
        "OldMoney": true,
        "OldNumber": true,
        "OldRate": true,
        "PostDate": true,
        "PostTime": true,
        "ProcessorUser": true,
        "RecordName": true,
        "RecordType": true,
        "SecurityLevels": true,
        "SequenceNumber": true,
        "SubFieldNumber": true,
        "UserNumber": true,
        "UserOverride": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "CheckFmHistoryFilter": {
      "StartPostDate": "2025-12-25",
      "EndPostDate": "2025-12-25",
      "Query": "text"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Check": {
    "AccountCode": "text",
    "AccountNumber": "text",
    "Amount": 1,
    "Branch": 1,
    "CheckFmHistoryList": {
      "hasReachedMaximumListSize": true,
      "CheckFmHistory": [
        {
          "AccountNumber": "text",
          "BatchSequence": 1,
          "Branch": 1,
          "ConfirmationNumber": "text",
          "ConfirmationSeq": 1,
          "ConsoleNumber": 1,
          "DataType": 1,
          "FieldName": "text",
          "FieldNumber": 1,
          "FmType": 1,
          "Id": "text",
          "IdType": 1,
          "LastFmDate": "2025-12-25",
          "NewCharacter": "text",
          "NewDate": "2025-12-25",
          "NewMoney": 1,
          "NewNumber": 1,
          "NewRate": 1,
          "OldCharacter": "text",
          "OldDate": "2025-12-25",
          "OldMoney": 1,
          "OldNumber": 1,
          "OldRate": 1,
          "PostDate": "2025-12-25",
          "PostTime": 1,
          "ProcessorUser": 1,
          "RecordName": "text",
          "RecordType": 1,
          "SecurityLevels": 1,
          "SequenceNumber": 1,
          "SubFieldNumber": 1,
          "UserNumber": 1,
          "UserOverride": 1
        }
      ]
    },
    "CheckNumberAssigned": 1,
    "EscheatDate": "2025-12-25",
    "FmLastPurgeDate": "2025-12-25",
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-12-25",
    "Id": "text",
    "IdType": 1,
    "IssueDate": "2025-12-25",
    "Number": "text",
    "Payee": [
      {
        "EntryId": 1,
        "Payee": "text"
      }
    ],
    "PostDate": "2025-12-25",
    "ReconciliationDate": "2025-12-25",
    "RecordChangeDate": "2025-12-25",
    "Reference": "text",
    "Reference2": "text",
    "Reference3": "text",
    "SequenceNumber": 1,
    "Source": 1,
    "SourceGlCode": 1,
    "Status": 1,
    "StopPmtDate": "2025-12-25",
    "TracerNumber": "text",
    "VoidDate": "2025-12-25"
  }
}

getCheckFmHistoryPagedListSelectFields

post

Retrieves a paged list of check FM history with selected fields.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post

/getCheckFmHistoryPagedListSelectFields

POST /nexum/627/persistent/check/getCheckFmHistoryPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 958

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckGlobalSequenceDate": "2025-12-25",
  "CheckGlobalSequence": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCheckFmHistoryFields": true,
    "CheckFmHistoryFields": {
      "AccountNumber": true,
      "BatchSequence": true,
      "Branch": true,
      "ConfirmationNumber": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "DataType": true,
      "FieldName": true,
      "FieldNumber": true,
      "FmType": true,
      "Id": true,
      "IdType": true,
      "LastFmDate": true,
      "NewCharacter": true,
      "NewDate": true,
      "NewMoney": true,
      "NewNumber": true,
      "NewRate": true,
      "OldCharacter": true,
      "OldDate": true,
      "OldMoney": true,
      "OldNumber": true,
      "OldRate": true,
      "PostDate": true,
      "PostTime": true,
      "ProcessorUser": true,
      "RecordName": true,
      "RecordType": true,
      "SecurityLevels": true,
      "SequenceNumber": true,
      "SubFieldNumber": true,
      "UserNumber": true,
      "UserOverride": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CheckFmHistory": [
    {
      "AccountNumber": "text",
      "BatchSequence": 1,
      "Branch": 1,
      "ConfirmationNumber": "text",
      "ConfirmationSeq": 1,
      "ConsoleNumber": 1,
      "DataType": 1,
      "FieldName": "text",
      "FieldNumber": 1,
      "FmType": 1,
      "Id": "text",
      "IdType": 1,
      "LastFmDate": "2025-12-25",
      "NewCharacter": "text",
      "NewDate": "2025-12-25",
      "NewMoney": 1,
      "NewNumber": 1,
      "NewRate": 1,
      "OldCharacter": "text",
      "OldDate": "2025-12-25",
      "OldMoney": 1,
      "OldNumber": 1,
      "OldRate": 1,
      "PostDate": "2025-12-25",
      "PostTime": 1,
      "ProcessorUser": 1,
      "RecordName": "text",
      "RecordType": 1,
      "SecurityLevels": 1,
      "SequenceNumber": 1,
      "SubFieldNumber": 1,
      "UserNumber": 1,
      "UserOverride": 1
    }
  ],
  "Token": "text"
}

searchCheckFmHistoryPagedSelectFields

post

Searches check FM history with pagination and selected fields.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post

/searchCheckFmHistoryPagedSelectFields

POST /nexum/627/persistent/check/searchCheckFmHistoryPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1046

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckGlobalSequenceDate": "2025-12-25",
  "CheckGlobalSequence": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCheckFmHistoryFields": true,
    "CheckFmHistoryFields": {
      "AccountNumber": true,
      "BatchSequence": true,
      "Branch": true,
      "ConfirmationNumber": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "DataType": true,
      "FieldName": true,
      "FieldNumber": true,
      "FmType": true,
      "Id": true,
      "IdType": true,
      "LastFmDate": true,
      "NewCharacter": true,
      "NewDate": true,
      "NewMoney": true,
      "NewNumber": true,
      "NewRate": true,
      "OldCharacter": true,
      "OldDate": true,
      "OldMoney": true,
      "OldNumber": true,
      "OldRate": true,
      "PostDate": true,
      "PostTime": true,
      "ProcessorUser": true,
      "RecordName": true,
      "RecordType": true,
      "SecurityLevels": true,
      "SequenceNumber": true,
      "SubFieldNumber": true,
      "UserNumber": true,
      "UserOverride": true
    }
  },
  "SearchFilter": {
    "StartPostDate": "2025-12-25",
    "EndPostDate": "2025-12-25",
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CheckFmHistory": [
    {
      "AccountNumber": "text",
      "BatchSequence": 1,
      "Branch": 1,
      "ConfirmationNumber": "text",
      "ConfirmationSeq": 1,
      "ConsoleNumber": 1,
      "DataType": 1,
      "FieldName": "text",
      "FieldNumber": 1,
      "FmType": 1,
      "Id": "text",
      "IdType": 1,
      "LastFmDate": "2025-12-25",
      "NewCharacter": "text",
      "NewDate": "2025-12-25",
      "NewMoney": 1,
      "NewNumber": 1,
      "NewRate": 1,
      "OldCharacter": "text",
      "OldDate": "2025-12-25",
      "OldMoney": 1,
      "OldNumber": 1,
      "OldRate": 1,
      "PostDate": "2025-12-25",
      "PostTime": 1,
      "ProcessorUser": 1,
      "RecordName": "text",
      "RecordType": 1,
      "SecurityLevels": 1,
      "SequenceNumber": 1,
      "SubFieldNumber": 1,
      "UserNumber": 1,
      "UserOverride": 1
    }
  ],
  "Token": "text"
}

updateCheckByID

post

Updates a check by ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post

/updateCheckByID

POST /nexum/627/persistent/check/updateCheckByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 787

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckGlobalSequenceDate": "2025-12-25",
  "CheckGlobalSequence": 1,
  "CheckFields": {
    "AccountCode": "text",
    "AccountNumber": "text",
    "Amount": 1,
    "Branch": 1,
    "CheckNumberAssigned": 1,
    "EscheatDate": "2025-12-25",
    "FmLastPurgeDate": "2025-12-25",
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-12-25",
    "Id": "text",
    "IdType": 1,
    "IssueDate": "2025-12-25",
    "Number": "text",
    "Payee": [
      {
        "EntryId": 1,
        "Payee": "text"
      }
    ],
    "PostDate": "2025-12-25",
    "ReconciliationDate": "2025-12-25",
    "RecordChangeDate": "2025-12-25",
    "Reference": "text",
    "Reference2": "text",
    "Reference3": "text",
    "SequenceNumber": 1,
    "Source": 1,
    "SourceGlCode": 1,
    "Status": 1,
    "StopPmtDate": "2025-12-25",
    "TracerNumber": "text",
    "VoidDate": "2025-12-25"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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

createCheck

post

Creates a new check.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post

/createCheck

POST /nexum/627/persistent/check/createCheck HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 724

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckFields": {
    "AccountCode": "text",
    "AccountNumber": "text",
    "Amount": 1,
    "Branch": 1,
    "CheckNumberAssigned": 1,
    "EscheatDate": "2025-12-25",
    "FmLastPurgeDate": "2025-12-25",
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-12-25",
    "Id": "text",
    "IdType": 1,
    "IssueDate": "2025-12-25",
    "Number": "text",
    "Payee": [
      {
        "EntryId": 1,
        "Payee": "text"
      }
    ],
    "PostDate": "2025-12-25",
    "ReconciliationDate": "2025-12-25",
    "RecordChangeDate": "2025-12-25",
    "Reference": "text",
    "Reference2": "text",
    "Reference3": "text",
    "SequenceNumber": 1,
    "Source": 1,
    "SourceGlCode": 1,
    "Status": 1,
    "StopPmtDate": "2025-12-25",
    "TracerNumber": "text",
    "VoidDate": "2025-12-25"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CheckCompositeKey": {
    "CheckGlobalSequenceDate": "2025-12-25",
    "CheckGlobalSequence": 1
  }
}

deleteCheck

post

Deletes a check.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CheckGlobalSequenceDatestring · dateOptional

CheckGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post

/deleteCheck

POST /nexum/627/persistent/check/deleteCheck HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckGlobalSequenceDate": "2025-12-25",
  "CheckGlobalSequence": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "nxAttributes": {}
}

PreviousCashLetterService NextCheckVerificationService

Last updated 1 year ago

Was this helpful?