Skip to content
NexumAPI Docs

CashLetterService⁠

Manage cash letters.

Operations⁠

getCashLetter⁠

POST

Retrieves a cash letter.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CashLetterGlobalSequenceDatestring · dateoptional
CashLetterGlobalSequenceintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/cashletter/getCashLetter
POST /nexum/627/2022.01/cashletter/getCashLetter HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CashLetterGlobalSequenceDate": "string",
  "CashLetterGlobalSequence": 0,
  "nxAttributes": {
    "customFields": {}
  }
}

getCashLetterSelectFields⁠

POST

Retrieves a cash letter with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CashLetterGlobalSequenceDatestring · dateoptional
CashLetterGlobalSequenceintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/cashletter/getCashLetterSelectFields
POST /nexum/627/2022.01/cashletter/getCashLetterSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CashLetterGlobalSequenceDate": "string",
  "CashLetterGlobalSequence": 0,
  "SelectableFields": {
    "IncludeAllCashLetterFields": true,
    "CashLetterFields": {
      "AccountInformation": true,
      "AccountNumber": true,
      "AdjustedTotalAmount": true,
      "AdjustmentAmount": true,
      "AdjustmentDate": true,
      "AvailableAmount": [
        0
      ],
      "AvailableDate": [
        0
      ],
      "BatchId": true,
      "Branch": true,
      "CalculatedAmount": true,
      "CalculatedDate": true,
      "CashLetterAmount": true,
      "CashLetterDate": true,
      "CorporateId": true,
      "CreationDate": true,
      "CreationTime": true,
      "CreditAmount": true,
      "DayDeferredAmount": [
        0
      ],
      "DebitAmount": true,
      "DebitCredit": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}