CashLetterService

Manage cash letters.

Symitar eDocs References: Coming soon.

Operations

getCashLetter

post

Retrieves a cash letter.

Authorizations

Body

CashLetterGlobalSequenceDatestring · dateOptional

CashLetterGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/cashletter/getCashLetter HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CashLetterGlobalSequenceDate": "2025-06-23",
  "CashLetterGlobalSequence": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CashLetter": {
    "AccountInformation": "text",
    "AccountNumber": "text",
    "AdjustedTotalAmount": 1,
    "AdjustmentAmount": 1,
    "AdjustmentDate": "2025-06-23",
    "AvailableAmount": [
      {
        "EntryId": 1,
        "AvailableAmount": 1
      }
    ],
    "AvailableDate": [
      {
        "EntryId": 1,
        "AvailableDate": "2025-06-23"
      }
    ],
    "BatchId": "text",
    "Branch": 1,
    "CalculatedAmount": 1,
    "CalculatedDate": "2025-06-23",
    "CashLetterAmount": 1,
    "CashLetterDate": "2025-06-23",
    "CorporateId": "text",
    "CreationDate": "2025-06-23",
    "CreationTime": 1,
    "CreditAmount": 1,
    "DayDeferredAmount": [
      {
        "EntryId": 1,
        "DayDeferredAmount": 1
      }
    ],
    "DebitAmount": 1,
    "DebitCredit": 1,
    "DepositDate": "2025-06-23",
    "FedCode": 1,
    "FedReference": "text",
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-06-23",
    "ImmediateAmount": 1,
    "ItemCount": 1,
    "MemberId": "text",
    "OriginalAmount": 1,
    "OriginalDepositDate": "2025-06-23",
    "OriginatorRT": "text",
    "Payee": "text",
    "PriorAmount": 1,
    "ProcessDate": "2025-06-23",
    "Reference": "text",
    "ResubmitAmount": 1,
    "ReturnReason": "text",
    "ReturnType": "text",
    "ReversalDate": "2025-06-23",
    "ReversalFlag": 1,
    "ShareId": "text",
    "StatementCode": "text",
    "ThirdPartyInformation": "text",
    "Type": 1,
    "UsCentralRT": "text"
  }
}

getCashLetterSelectFields

post

Retrieves a cash letter with selected fields.

Authorizations

Body

CashLetterGlobalSequenceDatestring · dateOptional

CashLetterGlobalSequenceintegerOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/cashletter/getCashLetterSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1188

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CashLetterGlobalSequenceDate": "2025-06-23",
  "CashLetterGlobalSequence": 1,
  "SelectableFields": {
    "IncludeAllCashLetterFields": true,
    "CashLetterFields": {
      "AccountInformation": true,
      "AccountNumber": true,
      "AdjustedTotalAmount": true,
      "AdjustmentAmount": true,
      "AdjustmentDate": true,
      "AvailableAmount": [
        1
      ],
      "AvailableDate": [
        1
      ],
      "BatchId": true,
      "Branch": true,
      "CalculatedAmount": true,
      "CalculatedDate": true,
      "CashLetterAmount": true,
      "CashLetterDate": true,
      "CorporateId": true,
      "CreationDate": true,
      "CreationTime": true,
      "CreditAmount": true,
      "DayDeferredAmount": [
        1
      ],
      "DebitAmount": true,
      "DebitCredit": true,
      "DepositDate": true,
      "FedCode": true,
      "FedReference": true,
      "GlobalSequence": true,
      "GlobalSequenceDate": true,
      "ImmediateAmount": true,
      "ItemCount": true,
      "MemberId": true,
      "OriginalAmount": true,
      "OriginalDepositDate": true,
      "OriginatorRT": true,
      "Payee": true,
      "PriorAmount": true,
      "ProcessDate": true,
      "Reference": true,
      "ResubmitAmount": true,
      "ReturnReason": true,
      "ReturnType": true,
      "ReversalDate": true,
      "ReversalFlag": true,
      "ShareId": true,
      "StatementCode": true,
      "ThirdPartyInformation": true,
      "Type": true,
      "UsCentralRT": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CashLetter": {
    "AccountInformation": "text",
    "AccountNumber": "text",
    "AdjustedTotalAmount": 1,
    "AdjustmentAmount": 1,
    "AdjustmentDate": "2025-06-23",
    "AvailableAmount": [
      {
        "EntryId": 1,
        "AvailableAmount": 1
      }
    ],
    "AvailableDate": [
      {
        "EntryId": 1,
        "AvailableDate": "2025-06-23"
      }
    ],
    "BatchId": "text",
    "Branch": 1,
    "CalculatedAmount": 1,
    "CalculatedDate": "2025-06-23",
    "CashLetterAmount": 1,
    "CashLetterDate": "2025-06-23",
    "CorporateId": "text",
    "CreationDate": "2025-06-23",
    "CreationTime": 1,
    "CreditAmount": 1,
    "DayDeferredAmount": [
      {
        "EntryId": 1,
        "DayDeferredAmount": 1
      }
    ],
    "DebitAmount": 1,
    "DebitCredit": 1,
    "DepositDate": "2025-06-23",
    "FedCode": 1,
    "FedReference": "text",
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-06-23",
    "ImmediateAmount": 1,
    "ItemCount": 1,
    "MemberId": "text",
    "OriginalAmount": 1,
    "OriginalDepositDate": "2025-06-23",
    "OriginatorRT": "text",
    "Payee": "text",
    "PriorAmount": 1,
    "ProcessDate": "2025-06-23",
    "Reference": "text",
    "ResubmitAmount": 1,
    "ReturnReason": "text",
    "ReturnType": "text",
    "ReversalDate": "2025-06-23",
    "ReversalFlag": 1,
    "ShareId": "text",
    "StatementCode": "text",
    "ThirdPartyInformation": "text",
    "Type": 1,
    "UsCentralRT": "text"
  }
}