ExceptionItemService

Manage exception item records.

Symitar eDocs References: Coming soon.

Operations

getExcpItemSelectFields

post

Retrieves exception item with selected fields.

Authorizations
Body
ExcpItemGlobalSequenceDatestring · dateOptional
ExcpItemGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/getExcpItemSelectFields
POST /nexum/627/persistent/exceptionitem/getExcpItemSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1359

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "2025-11-07",
  "ExcpItemGlobalSequence": 1,
  "SelectableFields": {
    "IncludeAllExcpItemFields": true,
    "ExcpItemFields": {
      "AchExcpReason": true,
      "AdjustmentCode": true,
      "Amount": [
        1
      ],
      "BatchAchOrigNum": true,
      "BatchId": true,
      "Branch": true,
      "Ch1": [
        1
      ],
      "Ch10": [
        1
      ],
      "Ch15": [
        1
      ],
      "Ch16": true,
      "Ch2": [
        1
      ],
      "Ch20": [
        1
      ],
      "Ch22": true,
      "Ch3": [
        1
      ],
      "Ch30": true,
      "Ch35": [
        1
      ],
      "Ch40": true,
      "Ch6": [
        1
      ],
      "Ch8": [
        1
      ],
      "Code": [
        1
      ],
      "CommentCode": true,
      "Date": [
        1
      ],
      "DeathDate": true,
      "DraftNumber": true,
      "EditRecord": [
        1
      ],
      "ExceptionCode": true,
      "ExcpItemAccount": true,
      "ExcpType": true,
      "ExtLoanAccount": true,
      "ForeignExcgInd": true,
      "ForeignExcgRef": true,
      "ForeignExcgRefInd": true,
      "GlAccount": true,
      "GlCategory": true,
      "GlCode": true,
      "GlCode1": true,
      "GlComment": true,
      "GlReference": true,
      "GlReference1": true,
      "GlobalSequence": true,
      "GlobalSequenceDate": true,
      "Id": true,
      "IdType": true,
      "IsoDestCountry": true,
      "IsoDestCurrency": true,
      "IsoOrigCurrency": true,
      "MemberBranch": true,
      "OriginatorStatus": true,
      "OtherAction": true,
      "OtherId": true,
      "OtherIdType": true,
      "PostExcpDescr": true,
      "ProcessorAccount": true,
      "RangeNumber": true,
      "ReasonCode": true,
      "RegCode": true,
      "ReviewStatus": true,
      "SubTranCode": true,
      "SubTranDescr": true,
      "TransactionCode": true,
      "TransferAccount": true,
      "TransferId": true,
      "TransferIdType": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExcpItem": {
    "AchExcpReason": "text",
    "AdjustmentCode": 1,
    "Amount": [
      {
        "EntryId": 1,
        "Amount": 1
      }
    ],
    "BatchAchOrigNum": 1,
    "BatchId": "text",
    "Branch": 1,
    "Ch1": [
      {
        "EntryId": 1,
        "Ch1": "text"
      }
    ],
    "Ch10": [
      {
        "EntryId": 1,
        "Ch10": "text"
      }
    ],
    "Ch15": [
      {
        "EntryId": 1,
        "Ch15": "text"
      }
    ],
    "Ch16": "text",
    "Ch2": [
      {
        "EntryId": 1,
        "Ch2": "text"
      }
    ],
    "Ch20": [
      {
        "EntryId": 1,
        "Ch20": "text"
      }
    ],
    "Ch22": "text",
    "Ch3": [
      {
        "EntryId": 1,
        "Ch3": "text"
      }
    ],
    "Ch30": "text",
    "Ch35": [
      {
        "EntryId": 1,
        "Ch35": "text"
      }
    ],
    "Ch40": "text",
    "Ch6": [
      {
        "EntryId": 1,
        "Ch6": "text"
      }
    ],
    "Ch8": [
      {
        "EntryId": 1,
        "Ch8": "text"
      }
    ],
    "Code": [
      {
        "EntryId": 1,
        "Code": 1
      }
    ],
    "CommentCode": 1,
    "Date": [
      {
        "EntryId": 1,
        "Date": "2025-11-07"
      }
    ],
    "DeathDate": "2025-11-07",
    "DraftNumber": "text",
    "EditRecord": [
      {
        "EntryId": 1,
        "EditRecord": "text"
      }
    ],
    "ExceptionCode": 1,
    "ExcpAddInfoList": {
      "hasReachedMaximumListSize": true,
      "ExcpAddInfo": [
        {
          "AdditionInfo": [
            {
              "EntryId": 1,
              "AdditionInfo": "text"
            }
          ],
          "Locator": 1,
          "Number": 1
        }
      ]
    },
    "ExcpAddendaList": {
      "hasReachedMaximumListSize": true,
      "ExcpAddenda": [
        {
          "AddendaInfo": [
            {
              "EntryId": 1,
              "AddendaInfo": "text"
            }
          ],
          "AddendaSeqNum": "text",
          "AddendaStd": [
            {
              "EntryId": 1,
              "AddendaStd": "text"
            }
          ],
          "AddendaType": "text",
          "CbrAddendaInfo": "text",
          "ChangeCode": "text",
          "CityState": "text",
          "CorTraceSeq": "text",
          "CorrectedData": "text",
          "CorrectedDataIat": "text",
          "CountryPostalCode": "text",
          "DateOfBirth": "text",
          "DateOfDeath": "text",
          "DetailSeqNum": "text",
          "DfiBranchCntryCode": "text",
          "DfiIdNumQualifier": "text",
          "DfiIdent": "text",
          "DfiName": "text",
          "DishonorAddendaInfo": "text",
          "DishonorReason": "text",
          "DishonorSettlDate": "text",
          "DishonorTrace": "text",
          "ExcpReason": "text",
          "ForeignAcctNum": "text",
          "ForeignPayment": "text",
          "ForeignPaymentIat": "text",
          "ForeignRecDfi": "text",
          "ForeignTrace": "text",
          "ForeignTraceIat": "text",
          "IatRetAddendaInfo": "text",
          "Locator": 1,
          "NetworkIdCode": "text",
          "OrigEntryPmt": "text",
          "OrigEntryPmtIat": "text",
          "OrigForeignPmt": "text",
          "OrigForeignRdfi": "text",
          "OrigSettlDate": "text",
          "OriginalRecDfi": "text",
          "OriginalTrace": "text",
          "OriginatorAddr": "text",
          "OriginatorName": "text",
          "PmtRelatedInfo": [
            {
              "EntryId": 1,
              "PmtRelatedInfo": "text"
            }
          ],
          "ReceiverAddr": "text",
          "ReceiverIdent": "text",
          "ReceivingName": "text",
          "RecordType": "text",
          "ReturnReason": "text",
          "ReturnSettlDate": "text",
          "ReturnTrace": "text",
          "TerminalCity": "text",
          "TerminalIdCode": "text",
          "TerminalLocation": "text",
          "TerminalState": "text",
          "TraceNumber": "text",
          "TranDateMmDd": "text",
          "TranDesc": "text",
          "TranSerial": "text",
          "TranTime": "text",
          "TranType": "text",
          "Type": 1
        }
      ]
    },
    "ExcpItemAccount": "text",
    "ExcpType": 1,
    "ExtLoanAccount": "text",
    "ForeignExcgInd": "text",
    "ForeignExcgRef": "text",
    "ForeignExcgRefInd": "text",
    "GlAccount": "text",
    "GlCategory": 1,
    "GlCode": 1,
    "GlCode1": 1,
    "GlComment": "text",
    "GlReference": "text",
    "GlReference1": "text",
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-11-07",
    "Id": "text",
    "IdType": 1,
    "IsoDestCountry": "text",
    "IsoDestCurrency": "text",
    "IsoOrigCurrency": "text",
    "MemberBranch": "text",
    "OriginatorStatus": "text",
    "OtherAction": 1,
    "OtherId": "text",
    "OtherIdType": 1,
    "PostExcpDescr": "text",
    "ProcessorAccount": "text",
    "RangeNumber": "text",
    "ReasonCode": 1,
    "RegCode": 1,
    "ReviewStatus": 1,
    "SubTranCode": 1,
    "SubTranDescr": "text",
    "TransactionCode": 1,
    "TransferAccount": "text",
    "TransferId": "text",
    "TransferIdType": 1
  }
}

getExcpItemSelectFieldsFilterChildren

post

Retrieves exception item with selected fields and filtered children.

Authorizations
Body
ExcpItemGlobalSequenceDatestring · dateOptional
ExcpItemGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/getExcpItemSelectFieldsFilterChildren
POST /nexum/627/persistent/exceptionitem/getExcpItemSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2915

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "2025-11-07",
  "ExcpItemGlobalSequence": 1,
  "SelectableFields": {
    "IncludeAllExcpItemFields": true,
    "ExcpItemFields": {
      "AchExcpReason": true,
      "AdjustmentCode": true,
      "Amount": [
        1
      ],
      "BatchAchOrigNum": true,
      "BatchId": true,
      "Branch": true,
      "Ch1": [
        1
      ],
      "Ch10": [
        1
      ],
      "Ch15": [
        1
      ],
      "Ch16": true,
      "Ch2": [
        1
      ],
      "Ch20": [
        1
      ],
      "Ch22": true,
      "Ch3": [
        1
      ],
      "Ch30": true,
      "Ch35": [
        1
      ],
      "Ch40": true,
      "Ch6": [
        1
      ],
      "Ch8": [
        1
      ],
      "Code": [
        1
      ],
      "CommentCode": true,
      "Date": [
        1
      ],
      "DeathDate": true,
      "DraftNumber": true,
      "EditRecord": [
        1
      ],
      "ExceptionCode": true,
      "ExcpItemAccount": true,
      "ExcpType": true,
      "ExtLoanAccount": true,
      "ForeignExcgInd": true,
      "ForeignExcgRef": true,
      "ForeignExcgRefInd": true,
      "GlAccount": true,
      "GlCategory": true,
      "GlCode": true,
      "GlCode1": true,
      "GlComment": true,
      "GlReference": true,
      "GlReference1": true,
      "GlobalSequence": true,
      "GlobalSequenceDate": true,
      "Id": true,
      "IdType": true,
      "IsoDestCountry": true,
      "IsoDestCurrency": true,
      "IsoOrigCurrency": true,
      "MemberBranch": true,
      "OriginatorStatus": true,
      "OtherAction": true,
      "OtherId": true,
      "OtherIdType": true,
      "PostExcpDescr": true,
      "ProcessorAccount": true,
      "RangeNumber": true,
      "ReasonCode": true,
      "RegCode": true,
      "ReviewStatus": true,
      "SubTranCode": true,
      "SubTranDescr": true,
      "TransactionCode": true,
      "TransferAccount": true,
      "TransferId": true,
      "TransferIdType": true
    },
    "ExcpAddInfoSelectableFields": {
      "IncludeAllExcpAddInfoFields": true,
      "ExcpAddInfoFields": {
        "AdditionInfo": [
          1
        ],
        "Locator": true,
        "Number": true
      }
    },
    "ExcpAddendaSelectableFields": {
      "IncludeAllExcpAddendaFields": true,
      "ExcpAddendaFields": {
        "AddendaInfo": [
          1
        ],
        "AddendaSeqNum": true,
        "AddendaStd": [
          1
        ],
        "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,
        "DishonorSettlDate": true,
        "DishonorTrace": true,
        "ExcpReason": true,
        "ForeignAcctNum": true,
        "ForeignPayment": true,
        "ForeignPaymentIat": true,
        "ForeignRecDfi": true,
        "ForeignTrace": true,
        "ForeignTraceIat": true,
        "IatRetAddendaInfo": true,
        "Locator": true,
        "NetworkIdCode": true,
        "OrigEntryPmt": true,
        "OrigEntryPmtIat": true,
        "OrigForeignPmt": true,
        "OrigForeignRdfi": true,
        "OrigSettlDate": true,
        "OriginalRecDfi": true,
        "OriginalTrace": true,
        "OriginatorAddr": true,
        "OriginatorName": true,
        "PmtRelatedInfo": [
          1
        ],
        "ReceiverAddr": true,
        "ReceiverIdent": true,
        "ReceivingName": true,
        "RecordType": true,
        "ReturnReason": true,
        "ReturnSettlDate": true,
        "ReturnTrace": true,
        "TerminalCity": true,
        "TerminalIdCode": true,
        "TerminalLocation": true,
        "TerminalState": true,
        "TraceNumber": true,
        "TranDateMmDd": true,
        "TranDesc": true,
        "TranSerial": true,
        "TranTime": true,
        "TranType": true,
        "Type": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "ExcpAddInfoFilter": {
      "Query": "text"
    },
    "ExcpAddendaFilter": {
      "Query": "text"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExcpItem": {
    "AchExcpReason": "text",
    "AdjustmentCode": 1,
    "Amount": [
      {
        "EntryId": 1,
        "Amount": 1
      }
    ],
    "BatchAchOrigNum": 1,
    "BatchId": "text",
    "Branch": 1,
    "Ch1": [
      {
        "EntryId": 1,
        "Ch1": "text"
      }
    ],
    "Ch10": [
      {
        "EntryId": 1,
        "Ch10": "text"
      }
    ],
    "Ch15": [
      {
        "EntryId": 1,
        "Ch15": "text"
      }
    ],
    "Ch16": "text",
    "Ch2": [
      {
        "EntryId": 1,
        "Ch2": "text"
      }
    ],
    "Ch20": [
      {
        "EntryId": 1,
        "Ch20": "text"
      }
    ],
    "Ch22": "text",
    "Ch3": [
      {
        "EntryId": 1,
        "Ch3": "text"
      }
    ],
    "Ch30": "text",
    "Ch35": [
      {
        "EntryId": 1,
        "Ch35": "text"
      }
    ],
    "Ch40": "text",
    "Ch6": [
      {
        "EntryId": 1,
        "Ch6": "text"
      }
    ],
    "Ch8": [
      {
        "EntryId": 1,
        "Ch8": "text"
      }
    ],
    "Code": [
      {
        "EntryId": 1,
        "Code": 1
      }
    ],
    "CommentCode": 1,
    "Date": [
      {
        "EntryId": 1,
        "Date": "2025-11-07"
      }
    ],
    "DeathDate": "2025-11-07",
    "DraftNumber": "text",
    "EditRecord": [
      {
        "EntryId": 1,
        "EditRecord": "text"
      }
    ],
    "ExceptionCode": 1,
    "ExcpAddInfoList": {
      "hasReachedMaximumListSize": true,
      "ExcpAddInfo": [
        {
          "AdditionInfo": [
            {
              "EntryId": 1,
              "AdditionInfo": "text"
            }
          ],
          "Locator": 1,
          "Number": 1
        }
      ]
    },
    "ExcpAddendaList": {
      "hasReachedMaximumListSize": true,
      "ExcpAddenda": [
        {
          "AddendaInfo": [
            {
              "EntryId": 1,
              "AddendaInfo": "text"
            }
          ],
          "AddendaSeqNum": "text",
          "AddendaStd": [
            {
              "EntryId": 1,
              "AddendaStd": "text"
            }
          ],
          "AddendaType": "text",
          "CbrAddendaInfo": "text",
          "ChangeCode": "text",
          "CityState": "text",
          "CorTraceSeq": "text",
          "CorrectedData": "text",
          "CorrectedDataIat": "text",
          "CountryPostalCode": "text",
          "DateOfBirth": "text",
          "DateOfDeath": "text",
          "DetailSeqNum": "text",
          "DfiBranchCntryCode": "text",
          "DfiIdNumQualifier": "text",
          "DfiIdent": "text",
          "DfiName": "text",
          "DishonorAddendaInfo": "text",
          "DishonorReason": "text",
          "DishonorSettlDate": "text",
          "DishonorTrace": "text",
          "ExcpReason": "text",
          "ForeignAcctNum": "text",
          "ForeignPayment": "text",
          "ForeignPaymentIat": "text",
          "ForeignRecDfi": "text",
          "ForeignTrace": "text",
          "ForeignTraceIat": "text",
          "IatRetAddendaInfo": "text",
          "Locator": 1,
          "NetworkIdCode": "text",
          "OrigEntryPmt": "text",
          "OrigEntryPmtIat": "text",
          "OrigForeignPmt": "text",
          "OrigForeignRdfi": "text",
          "OrigSettlDate": "text",
          "OriginalRecDfi": "text",
          "OriginalTrace": "text",
          "OriginatorAddr": "text",
          "OriginatorName": "text",
          "PmtRelatedInfo": [
            {
              "EntryId": 1,
              "PmtRelatedInfo": "text"
            }
          ],
          "ReceiverAddr": "text",
          "ReceiverIdent": "text",
          "ReceivingName": "text",
          "RecordType": "text",
          "ReturnReason": "text",
          "ReturnSettlDate": "text",
          "ReturnTrace": "text",
          "TerminalCity": "text",
          "TerminalIdCode": "text",
          "TerminalLocation": "text",
          "TerminalState": "text",
          "TraceNumber": "text",
          "TranDateMmDd": "text",
          "TranDesc": "text",
          "TranSerial": "text",
          "TranTime": "text",
          "TranType": "text",
          "Type": 1
        }
      ]
    },
    "ExcpItemAccount": "text",
    "ExcpType": 1,
    "ExtLoanAccount": "text",
    "ForeignExcgInd": "text",
    "ForeignExcgRef": "text",
    "ForeignExcgRefInd": "text",
    "GlAccount": "text",
    "GlCategory": 1,
    "GlCode": 1,
    "GlCode1": 1,
    "GlComment": "text",
    "GlReference": "text",
    "GlReference1": "text",
    "GlobalSequence": 1,
    "GlobalSequenceDate": "2025-11-07",
    "Id": "text",
    "IdType": 1,
    "IsoDestCountry": "text",
    "IsoDestCurrency": "text",
    "IsoOrigCurrency": "text",
    "MemberBranch": "text",
    "OriginatorStatus": "text",
    "OtherAction": 1,
    "OtherId": "text",
    "OtherIdType": 1,
    "PostExcpDescr": "text",
    "ProcessorAccount": "text",
    "RangeNumber": "text",
    "ReasonCode": 1,
    "RegCode": 1,
    "ReviewStatus": 1,
    "SubTranCode": 1,
    "SubTranDescr": "text",
    "TransactionCode": 1,
    "TransferAccount": "text",
    "TransferId": "text",
    "TransferIdType": 1
  }
}

getExcpAddInfoSelectFields

post

Retrieves exception item additional information with selected fields.

Authorizations
Body
ExcpItemGlobalSequenceDatestring · dateOptional
ExcpItemGlobalSequenceintegerOptional
ExcpAddInfoLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getExcpAddInfoSelectFields
POST /nexum/627/persistent/exceptionitem/getExcpAddInfoSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 342

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "2025-11-07",
  "ExcpItemGlobalSequence": 1,
  "ExcpAddInfoLocator": 1,
  "SelectableFields": {
    "IncludeAllExcpAddInfoFields": true,
    "ExcpAddInfoFields": {
      "AdditionInfo": [
        1
      ],
      "Locator": true,
      "Number": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExcpAddInfo": {
    "AdditionInfo": [
      {
        "EntryId": 1,
        "AdditionInfo": "text"
      }
    ],
    "Locator": 1,
    "Number": 1
  }
}

getExcpAddInfoPagedListSelectFields

post

Retrieves a paged list of exception item additional information with selected fields.

Authorizations
Body
ExcpItemGlobalSequenceDatestring · dateOptional
ExcpItemGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/getExcpAddInfoPagedListSelectFields
POST /nexum/627/persistent/exceptionitem/getExcpAddInfoPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 413

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "2025-11-07",
  "ExcpItemGlobalSequence": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllExcpAddInfoFields": true,
    "ExcpAddInfoFields": {
      "AdditionInfo": [
        1
      ],
      "Locator": true,
      "Number": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExcpAddInfo": [
    {
      "AdditionInfo": [
        {
          "EntryId": 1,
          "AdditionInfo": "text"
        }
      ],
      "Locator": 1,
      "Number": 1
    }
  ],
  "Token": "text"
}

searchExcpAddInfoPagedSelectFields

post

Searches exception item additional information with pagination and selected fields.

Authorizations
Body
ExcpItemGlobalSequenceDatestring · dateOptional
ExcpItemGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/searchExcpAddInfoPagedSelectFields
POST /nexum/627/persistent/exceptionitem/searchExcpAddInfoPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 445

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "2025-11-07",
  "ExcpItemGlobalSequence": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllExcpAddInfoFields": true,
    "ExcpAddInfoFields": {
      "AdditionInfo": [
        1
      ],
      "Locator": true,
      "Number": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExcpAddInfo": [
    {
      "AdditionInfo": [
        {
          "EntryId": 1,
          "AdditionInfo": "text"
        }
      ],
      "Locator": 1,
      "Number": 1
    }
  ],
  "Token": "text"
}

getExcpAddendaSelectFields

post

Retrieves exception item addenda with selected fields.

Authorizations
Body
ExcpItemGlobalSequenceDatestring · dateOptional
ExcpItemGlobalSequenceintegerOptional
ExcpAddendaLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getExcpAddendaSelectFields
POST /nexum/627/persistent/exceptionitem/getExcpAddendaSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1525

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "2025-11-07",
  "ExcpItemGlobalSequence": 1,
  "ExcpAddendaLocator": 1,
  "SelectableFields": {
    "IncludeAllExcpAddendaFields": true,
    "ExcpAddendaFields": {
      "AddendaInfo": [
        1
      ],
      "AddendaSeqNum": true,
      "AddendaStd": [
        1
      ],
      "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,
      "DishonorSettlDate": true,
      "DishonorTrace": true,
      "ExcpReason": true,
      "ForeignAcctNum": true,
      "ForeignPayment": true,
      "ForeignPaymentIat": true,
      "ForeignRecDfi": true,
      "ForeignTrace": true,
      "ForeignTraceIat": true,
      "IatRetAddendaInfo": true,
      "Locator": true,
      "NetworkIdCode": true,
      "OrigEntryPmt": true,
      "OrigEntryPmtIat": true,
      "OrigForeignPmt": true,
      "OrigForeignRdfi": true,
      "OrigSettlDate": true,
      "OriginalRecDfi": true,
      "OriginalTrace": true,
      "OriginatorAddr": true,
      "OriginatorName": true,
      "PmtRelatedInfo": [
        1
      ],
      "ReceiverAddr": true,
      "ReceiverIdent": true,
      "ReceivingName": true,
      "RecordType": true,
      "ReturnReason": true,
      "ReturnSettlDate": true,
      "ReturnTrace": true,
      "TerminalCity": true,
      "TerminalIdCode": true,
      "TerminalLocation": true,
      "TerminalState": true,
      "TraceNumber": true,
      "TranDateMmDd": true,
      "TranDesc": true,
      "TranSerial": true,
      "TranTime": true,
      "TranType": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExcpAddenda": {
    "AddendaInfo": [
      {
        "EntryId": 1,
        "AddendaInfo": "text"
      }
    ],
    "AddendaSeqNum": "text",
    "AddendaStd": [
      {
        "EntryId": 1,
        "AddendaStd": "text"
      }
    ],
    "AddendaType": "text",
    "CbrAddendaInfo": "text",
    "ChangeCode": "text",
    "CityState": "text",
    "CorTraceSeq": "text",
    "CorrectedData": "text",
    "CorrectedDataIat": "text",
    "CountryPostalCode": "text",
    "DateOfBirth": "text",
    "DateOfDeath": "text",
    "DetailSeqNum": "text",
    "DfiBranchCntryCode": "text",
    "DfiIdNumQualifier": "text",
    "DfiIdent": "text",
    "DfiName": "text",
    "DishonorAddendaInfo": "text",
    "DishonorReason": "text",
    "DishonorSettlDate": "text",
    "DishonorTrace": "text",
    "ExcpReason": "text",
    "ForeignAcctNum": "text",
    "ForeignPayment": "text",
    "ForeignPaymentIat": "text",
    "ForeignRecDfi": "text",
    "ForeignTrace": "text",
    "ForeignTraceIat": "text",
    "IatRetAddendaInfo": "text",
    "Locator": 1,
    "NetworkIdCode": "text",
    "OrigEntryPmt": "text",
    "OrigEntryPmtIat": "text",
    "OrigForeignPmt": "text",
    "OrigForeignRdfi": "text",
    "OrigSettlDate": "text",
    "OriginalRecDfi": "text",
    "OriginalTrace": "text",
    "OriginatorAddr": "text",
    "OriginatorName": "text",
    "PmtRelatedInfo": [
      {
        "EntryId": 1,
        "PmtRelatedInfo": "text"
      }
    ],
    "ReceiverAddr": "text",
    "ReceiverIdent": "text",
    "ReceivingName": "text",
    "RecordType": "text",
    "ReturnReason": "text",
    "ReturnSettlDate": "text",
    "ReturnTrace": "text",
    "TerminalCity": "text",
    "TerminalIdCode": "text",
    "TerminalLocation": "text",
    "TerminalState": "text",
    "TraceNumber": "text",
    "TranDateMmDd": "text",
    "TranDesc": "text",
    "TranSerial": "text",
    "TranTime": "text",
    "TranType": "text",
    "Type": 1
  }
}

getExcpAddendaPagedListSelectFields

post

Retrieves a paged list of exception item addenda with selected fields.

Authorizations
Body
ExcpItemGlobalSequenceDatestring · dateOptional
ExcpItemGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/getExcpAddendaPagedListSelectFields
POST /nexum/627/persistent/exceptionitem/getExcpAddendaPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1596

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "2025-11-07",
  "ExcpItemGlobalSequence": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllExcpAddendaFields": true,
    "ExcpAddendaFields": {
      "AddendaInfo": [
        1
      ],
      "AddendaSeqNum": true,
      "AddendaStd": [
        1
      ],
      "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,
      "DishonorSettlDate": true,
      "DishonorTrace": true,
      "ExcpReason": true,
      "ForeignAcctNum": true,
      "ForeignPayment": true,
      "ForeignPaymentIat": true,
      "ForeignRecDfi": true,
      "ForeignTrace": true,
      "ForeignTraceIat": true,
      "IatRetAddendaInfo": true,
      "Locator": true,
      "NetworkIdCode": true,
      "OrigEntryPmt": true,
      "OrigEntryPmtIat": true,
      "OrigForeignPmt": true,
      "OrigForeignRdfi": true,
      "OrigSettlDate": true,
      "OriginalRecDfi": true,
      "OriginalTrace": true,
      "OriginatorAddr": true,
      "OriginatorName": true,
      "PmtRelatedInfo": [
        1
      ],
      "ReceiverAddr": true,
      "ReceiverIdent": true,
      "ReceivingName": true,
      "RecordType": true,
      "ReturnReason": true,
      "ReturnSettlDate": true,
      "ReturnTrace": true,
      "TerminalCity": true,
      "TerminalIdCode": true,
      "TerminalLocation": true,
      "TerminalState": true,
      "TraceNumber": true,
      "TranDateMmDd": true,
      "TranDesc": true,
      "TranSerial": true,
      "TranTime": true,
      "TranType": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExcpAddenda": [
    {
      "AddendaInfo": [
        {
          "EntryId": 1,
          "AddendaInfo": "text"
        }
      ],
      "AddendaSeqNum": "text",
      "AddendaStd": [
        {
          "EntryId": 1,
          "AddendaStd": "text"
        }
      ],
      "AddendaType": "text",
      "CbrAddendaInfo": "text",
      "ChangeCode": "text",
      "CityState": "text",
      "CorTraceSeq": "text",
      "CorrectedData": "text",
      "CorrectedDataIat": "text",
      "CountryPostalCode": "text",
      "DateOfBirth": "text",
      "DateOfDeath": "text",
      "DetailSeqNum": "text",
      "DfiBranchCntryCode": "text",
      "DfiIdNumQualifier": "text",
      "DfiIdent": "text",
      "DfiName": "text",
      "DishonorAddendaInfo": "text",
      "DishonorReason": "text",
      "DishonorSettlDate": "text",
      "DishonorTrace": "text",
      "ExcpReason": "text",
      "ForeignAcctNum": "text",
      "ForeignPayment": "text",
      "ForeignPaymentIat": "text",
      "ForeignRecDfi": "text",
      "ForeignTrace": "text",
      "ForeignTraceIat": "text",
      "IatRetAddendaInfo": "text",
      "Locator": 1,
      "NetworkIdCode": "text",
      "OrigEntryPmt": "text",
      "OrigEntryPmtIat": "text",
      "OrigForeignPmt": "text",
      "OrigForeignRdfi": "text",
      "OrigSettlDate": "text",
      "OriginalRecDfi": "text",
      "OriginalTrace": "text",
      "OriginatorAddr": "text",
      "OriginatorName": "text",
      "PmtRelatedInfo": [
        {
          "EntryId": 1,
          "PmtRelatedInfo": "text"
        }
      ],
      "ReceiverAddr": "text",
      "ReceiverIdent": "text",
      "ReceivingName": "text",
      "RecordType": "text",
      "ReturnReason": "text",
      "ReturnSettlDate": "text",
      "ReturnTrace": "text",
      "TerminalCity": "text",
      "TerminalIdCode": "text",
      "TerminalLocation": "text",
      "TerminalState": "text",
      "TraceNumber": "text",
      "TranDateMmDd": "text",
      "TranDesc": "text",
      "TranSerial": "text",
      "TranTime": "text",
      "TranType": "text",
      "Type": 1
    }
  ],
  "Token": "text"
}

searchExcpAddendaPagedSelectFields

post

Searches exception item addenda with pagination and selected fields.

Authorizations
Body
ExcpItemGlobalSequenceDatestring · dateOptional
ExcpItemGlobalSequenceintegerOptional
Responses
200

Successful operation.

application/json
post
/searchExcpAddendaPagedSelectFields
POST /nexum/627/persistent/exceptionitem/searchExcpAddendaPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1628

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExcpItemGlobalSequenceDate": "2025-11-07",
  "ExcpItemGlobalSequence": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllExcpAddendaFields": true,
    "ExcpAddendaFields": {
      "AddendaInfo": [
        1
      ],
      "AddendaSeqNum": true,
      "AddendaStd": [
        1
      ],
      "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,
      "DishonorSettlDate": true,
      "DishonorTrace": true,
      "ExcpReason": true,
      "ForeignAcctNum": true,
      "ForeignPayment": true,
      "ForeignPaymentIat": true,
      "ForeignRecDfi": true,
      "ForeignTrace": true,
      "ForeignTraceIat": true,
      "IatRetAddendaInfo": true,
      "Locator": true,
      "NetworkIdCode": true,
      "OrigEntryPmt": true,
      "OrigEntryPmtIat": true,
      "OrigForeignPmt": true,
      "OrigForeignRdfi": true,
      "OrigSettlDate": true,
      "OriginalRecDfi": true,
      "OriginalTrace": true,
      "OriginatorAddr": true,
      "OriginatorName": true,
      "PmtRelatedInfo": [
        1
      ],
      "ReceiverAddr": true,
      "ReceiverIdent": true,
      "ReceivingName": true,
      "RecordType": true,
      "ReturnReason": true,
      "ReturnSettlDate": true,
      "ReturnTrace": true,
      "TerminalCity": true,
      "TerminalIdCode": true,
      "TerminalLocation": true,
      "TerminalState": true,
      "TraceNumber": true,
      "TranDateMmDd": true,
      "TranDesc": true,
      "TranSerial": true,
      "TranTime": true,
      "TranType": true,
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExcpAddenda": [
    {
      "AddendaInfo": [
        {
          "EntryId": 1,
          "AddendaInfo": "text"
        }
      ],
      "AddendaSeqNum": "text",
      "AddendaStd": [
        {
          "EntryId": 1,
          "AddendaStd": "text"
        }
      ],
      "AddendaType": "text",
      "CbrAddendaInfo": "text",
      "ChangeCode": "text",
      "CityState": "text",
      "CorTraceSeq": "text",
      "CorrectedData": "text",
      "CorrectedDataIat": "text",
      "CountryPostalCode": "text",
      "DateOfBirth": "text",
      "DateOfDeath": "text",
      "DetailSeqNum": "text",
      "DfiBranchCntryCode": "text",
      "DfiIdNumQualifier": "text",
      "DfiIdent": "text",
      "DfiName": "text",
      "DishonorAddendaInfo": "text",
      "DishonorReason": "text",
      "DishonorSettlDate": "text",
      "DishonorTrace": "text",
      "ExcpReason": "text",
      "ForeignAcctNum": "text",
      "ForeignPayment": "text",
      "ForeignPaymentIat": "text",
      "ForeignRecDfi": "text",
      "ForeignTrace": "text",
      "ForeignTraceIat": "text",
      "IatRetAddendaInfo": "text",
      "Locator": 1,
      "NetworkIdCode": "text",
      "OrigEntryPmt": "text",
      "OrigEntryPmtIat": "text",
      "OrigForeignPmt": "text",
      "OrigForeignRdfi": "text",
      "OrigSettlDate": "text",
      "OriginalRecDfi": "text",
      "OriginalTrace": "text",
      "OriginatorAddr": "text",
      "OriginatorName": "text",
      "PmtRelatedInfo": [
        {
          "EntryId": 1,
          "PmtRelatedInfo": "text"
        }
      ],
      "ReceiverAddr": "text",
      "ReceiverIdent": "text",
      "ReceivingName": "text",
      "RecordType": "text",
      "ReturnReason": "text",
      "ReturnSettlDate": "text",
      "ReturnTrace": "text",
      "TerminalCity": "text",
      "TerminalIdCode": "text",
      "TerminalLocation": "text",
      "TerminalState": "text",
      "TraceNumber": "text",
      "TranDateMmDd": "text",
      "TranDesc": "text",
      "TranSerial": "text",
      "TranTime": "text",
      "TranType": "text",
      "Type": 1
    }
  ],
  "Token": "text"
}
PreviousEcaaServiceNextFileManagementService

Last updated

Was this helpful?