Skip to content

ExceptionItemService⁠

Manage exception item records.

Operations⁠

getExcpItem⁠

POST

Retrieves exception item.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

ExcpItemGlobalSequenceDatestring · dateoptional
ExcpItemGlobalSequenceintegeroptional
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/exceptionitem/getExcpItem
POST /nexum/627/2022.01/exceptionitem/getExcpItem HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "string",
  "ExcpItemGlobalSequence": 0,
  "nxAttributes": {
    "customFields": {}
  }
}

getExcpItemSelectFields⁠

POST

Retrieves exception item with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

ExcpItemGlobalSequenceDatestring · dateoptional
ExcpItemGlobalSequenceintegeroptional
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/exceptionitem/getExcpItemSelectFields
POST /nexum/627/2022.01/exceptionitem/getExcpItemSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "string",
  "ExcpItemGlobalSequence": 0,
  "SelectableFields": {
    "IncludeAllExcpItemFields": true,
    "ExcpItemFields": {
      "AchExcpReason": true,
      "AdjustmentCode": true,
      "Amount": [
        0
      ],
      "BatchAchOrigNum": true,
      "BatchId": true,
      "Branch": true,
      "Ch1": [
        0
      ],
      "Ch10": [
        0
      ],
      "Ch15": [
        0
      ],
      "Ch16": true,
      "Ch2": [
        0
      ],
      "Ch20": [
        0
      ],
      "Ch22": true,
      "Ch3": [
        0
      ],
      "Ch30": true,
      "Ch35": [
        0
      ],
      "Ch40": true,
      "Ch6": [
        0
      ],
      "Ch8": [
        0
      ],
      "Code": [
        0
      ]
    },
    "ExcpAddInfoSelectableFields": {
      "IncludeAllExcpAddInfoFields": true,
      "ExcpAddInfoFields": {
        "AdditionInfo": [
          0
        ],
        "Locator": true,
        "Number": true
      }
    },
    "ExcpAddendaSelectableFields": {
      "IncludeAllExcpAddendaFields": true,
      "ExcpAddendaFields": {
        "AddendaInfo": [
          0
        ],
        "AddendaSeqNum": true,
        "AddendaStd": [
          0
        ],
        "AddendaType": true,
        "CbrAddendaInfo": true,
        "ChangeCode": true,
        "CityState": true,
        "CorTraceSeq": true,
        "CorrectedData": true,
        "CorrectedDataIat": true,
        "CountryPostalCode": true,
        "DateOfBirth": true,
        "DateOfDeath": true,
        "DetailSeqNum": true,
        "DfiBranchCntryCode": true,
        "DfiIdNumQualifier": true,
        "DfiIdent": true,
        "DfiName": true,
        "DishonorAddendaInfo": true,
        "DishonorReason": true
      }
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getExcpItemSelectFieldsFilterChildren⁠

POST

Retrieves exception item with selected fields and filtered children.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

ExcpItemGlobalSequenceDatestring · dateoptional
ExcpItemGlobalSequenceintegeroptional
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/exceptionitem/getExcpItemSelectFieldsFilterChildren
POST /nexum/627/2022.01/exceptionitem/getExcpItemSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "string",
  "ExcpItemGlobalSequence": 0,
  "SelectableFields": {
    "IncludeAllExcpItemFields": true,
    "ExcpItemFields": {
      "AchExcpReason": true,
      "AdjustmentCode": true,
      "Amount": [
        0
      ],
      "BatchAchOrigNum": true,
      "BatchId": true,
      "Branch": true,
      "Ch1": [
        0
      ],
      "Ch10": [
        0
      ],
      "Ch15": [
        0
      ],
      "Ch16": true,
      "Ch2": [
        0
      ],
      "Ch20": [
        0
      ],
      "Ch22": true,
      "Ch3": [
        0
      ],
      "Ch30": true,
      "Ch35": [
        0
      ],
      "Ch40": true,
      "Ch6": [
        0
      ],
      "Ch8": [
        0
      ],
      "Code": [
        0
      ]
    },
    "ExcpAddInfoSelectableFields": {
      "IncludeAllExcpAddInfoFields": true,
      "ExcpAddInfoFields": {
        "AdditionInfo": [
          0
        ],
        "Locator": true,
        "Number": true
      }
    },
    "ExcpAddendaSelectableFields": {
      "IncludeAllExcpAddendaFields": true,
      "ExcpAddendaFields": {
        "AddendaInfo": [
          0
        ],
        "AddendaSeqNum": true,
        "AddendaStd": [
          0
        ],
        "AddendaType": true,
        "CbrAddendaInfo": true,
        "ChangeCode": true,
        "CityState": true,
        "CorTraceSeq": true,
        "CorrectedData": true,
        "CorrectedDataIat": true,
        "CountryPostalCode": true,
        "DateOfBirth": true,
        "DateOfDeath": true,
        "DetailSeqNum": true,
        "DfiBranchCntryCode": true,
        "DfiIdNumQualifier": true,
        "DfiIdent": true,
        "DfiName": true,
        "DishonorAddendaInfo": true,
        "DishonorReason": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "ExcpAddInfoFilter": {
      "Query": "string"
    },
    "ExcpAddendaFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getExcpAddInfo⁠

POST

Retrieves exception item additional information.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

ExcpItemGlobalSequenceDatestring · dateoptional
ExcpItemGlobalSequenceintegeroptional
ExcpAddInfoLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/exceptionitem/getExcpAddInfo
POST /nexum/627/2022.01/exceptionitem/getExcpAddInfo HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "string",
  "ExcpItemGlobalSequence": 0,
  "ExcpAddInfoLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}

getExcpAddInfoSelectFields⁠

POST

Retrieves exception item additional information with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

ExcpItemGlobalSequenceDatestring · dateoptional
ExcpItemGlobalSequenceintegeroptional
ExcpAddInfoLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/exceptionitem/getExcpAddInfoSelectFields
POST /nexum/627/2022.01/exceptionitem/getExcpAddInfoSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "string",
  "ExcpItemGlobalSequence": 0,
  "ExcpAddInfoLocator": 0,
  "SelectableFields": {
    "IncludeAllExcpAddInfoFields": true,
    "ExcpAddInfoFields": {
      "AdditionInfo": [
        0
      ],
      "Locator": true,
      "Number": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getExcpAddInfoPagedList⁠

POST

Retrieves a paged list of exception item additional information.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

ExcpItemGlobalSequenceDatestring · dateoptional
ExcpItemGlobalSequenceintegeroptional
Path Parameters
symstringrequired
Sym number
Tokenstringoptional
POST/nexum/{sym}/2022.01/exceptionitem/getExcpAddInfoPagedList
POST /nexum/627/2022.01/exceptionitem/getExcpAddInfoPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "string",
  "ExcpItemGlobalSequence": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}