Skip to content
NexumAPI Docs

CollateralService⁠

Manage collateral records.

Operations⁠

getCollateral⁠

POST

Retrieves collateral.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CollateralNumberstringrequired
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/collateral/getCollateral
POST /nexum/627/2022.01/collateral/getCollateral HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CollateralNumber": "string",
  "nxAttributes": {
    "customFields": {}
  }
}

getCollateralSelectFields⁠

POST

Retrieves collateral with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CollateralNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/collateral/getCollateralSelectFields
POST /nexum/627/2022.01/collateral/getCollateralSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CollateralNumber": "string",
  "SelectableFields": {
    "IncludeAllCollateralFields": true,
    "CollateralFields": {
      "CollateralAppStatus": true,
      "CollateralOwner": true,
      "CreateDate": true,
      "Description": true,
      "ExpireDate": true,
      "FmLastPurgeDate": true,
      "LastFmDate": true,
      "Number": true,
      "RecordChangeDate": true,
      "RequiredDocumentList": true,
      "Type": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserChar5": true,
      "UserChar6": true,
      "Value": true,
      "ValueDate": true,
      "ValueSource": true
    },
    "CollateralCollHoldSelectableFields": {
      "IncludeAllCollateralCollHoldFields": true,
      "CollateralCollHoldFields": {
        "AccountNumber": true,
        "Amount": true,
        "EffectiveDate": true,
        "ExpirationDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true
      }
    },
    "CollateralDocumentSelectableFields": {
      "IncludeAllCollateralDocumentFields": true,
      "CollateralDocumentFields": {
        "AccountNumber": true,
        "Branch": true,
        "Description": true,
        "DocumentDate": true,
        "ExcpDays": true,
        "ExcpNoticeCount": true,
        "ExcpNoticeCountCpWork": true,
        "ExcpNoticeDate": true,
        "ExcpNoticeOption": true,
        "ExpireDate": true,
        "LastFmDate": true,
        "Location": true,
        "Locator": true,
        "Number": true,
        "OfficerCode": true,
        "ReceivedDate": true,
        "RecordChangeDate": true,
        "SlId": true,
        "SlIdType": true,
        "Status": true
      },
      "CollateralDocumentTrackingSelectableFields": {
        "IncludeAllCollateralDocumentTrackingFields": true,
        "CollateralDocumentTrackingFields": {
          "CreationDate": true,
          "CreationTime": true,
          "ExpireDate": true,
          "FmLastDate": true,
          "Id": true,
          "IdType": true,
          "Locator": true,
          "RecordChangeDate": true,
          "TrackingCode": true,
          "Type": true,
          "UserAmount1": true,
          "UserAmount10": true,
          "UserAmount11": true,
          "UserAmount12": true,
          "UserAmount13": true,
          "UserAmount14": true,
          "UserAmount15": true,
          "UserAmount16": true,
          "UserAmount17": true,
          "UserAmount18": true
        }
      }
    },
    "CollateralFmHistorySelectableFields": {
      "IncludeAllCollateralFmHistoryFields": true,
      "CollateralFmHistoryFields": {
        "AccountNumber": true,
        "BatchSequence": true,
        "Branch": 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
      }
    },
    "CollateralTrackingSelectableFields": {
      "IncludeAllCollateralTrackingFields": true,
      "CollateralTrackingFields": {
        "CreationDate": true,
        "CreationTime": true,
        "ExpireDate": true,
        "FmLastDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true,
        "TrackingCode": true,
        "Type": true,
        "UserAmount1": true,
        "UserAmount10": true,
        "UserAmount11": true,
        "UserAmount12": true,
        "UserAmount13": true,
        "UserAmount14": true,
        "UserAmount15": true,
        "UserAmount16": true,
        "UserAmount17": true,
        "UserAmount18": true
      }
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCollateralSelectFieldsFilterChildren⁠

POST

Retrieves collateral with selected fields and filtered children.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CollateralNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/collateral/getCollateralSelectFieldsFilterChildren
POST /nexum/627/2022.01/collateral/getCollateralSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CollateralNumber": "string",
  "SelectableFields": {
    "IncludeAllCollateralFields": true,
    "CollateralFields": {
      "CollateralAppStatus": true,
      "CollateralOwner": true,
      "CreateDate": true,
      "Description": true,
      "ExpireDate": true,
      "FmLastPurgeDate": true,
      "LastFmDate": true,
      "Number": true,
      "RecordChangeDate": true,
      "RequiredDocumentList": true,
      "Type": true,
      "UserChar1": true,
      "UserChar2": true,
      "UserChar3": true,
      "UserChar4": true,
      "UserChar5": true,
      "UserChar6": true,
      "Value": true,
      "ValueDate": true,
      "ValueSource": true
    },
    "CollateralCollHoldSelectableFields": {
      "IncludeAllCollateralCollHoldFields": true,
      "CollateralCollHoldFields": {
        "AccountNumber": true,
        "Amount": true,
        "EffectiveDate": true,
        "ExpirationDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true
      }
    },
    "CollateralDocumentSelectableFields": {
      "IncludeAllCollateralDocumentFields": true,
      "CollateralDocumentFields": {
        "AccountNumber": true,
        "Branch": true,
        "Description": true,
        "DocumentDate": true,
        "ExcpDays": true,
        "ExcpNoticeCount": true,
        "ExcpNoticeCountCpWork": true,
        "ExcpNoticeDate": true,
        "ExcpNoticeOption": true,
        "ExpireDate": true,
        "LastFmDate": true,
        "Location": true,
        "Locator": true,
        "Number": true,
        "OfficerCode": true,
        "ReceivedDate": true,
        "RecordChangeDate": true,
        "SlId": true,
        "SlIdType": true,
        "Status": true
      },
      "CollateralDocumentTrackingSelectableFields": {
        "IncludeAllCollateralDocumentTrackingFields": true,
        "CollateralDocumentTrackingFields": {
          "CreationDate": true,
          "CreationTime": true,
          "ExpireDate": true,
          "FmLastDate": true,
          "Id": true,
          "IdType": true,
          "Locator": true,
          "RecordChangeDate": true,
          "TrackingCode": true,
          "Type": true,
          "UserAmount1": true,
          "UserAmount10": true,
          "UserAmount11": true,
          "UserAmount12": true,
          "UserAmount13": true,
          "UserAmount14": true,
          "UserAmount15": true,
          "UserAmount16": true,
          "UserAmount17": true,
          "UserAmount18": true
        }
      }
    },
    "CollateralFmHistorySelectableFields": {
      "IncludeAllCollateralFmHistoryFields": true,
      "CollateralFmHistoryFields": {
        "AccountNumber": true,
        "BatchSequence": true,
        "Branch": 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
      }
    },
    "CollateralTrackingSelectableFields": {
      "IncludeAllCollateralTrackingFields": true,
      "CollateralTrackingFields": {
        "CreationDate": true,
        "CreationTime": true,
        "ExpireDate": true,
        "FmLastDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true,
        "TrackingCode": true,
        "Type": true,
        "UserAmount1": true,
        "UserAmount10": true,
        "UserAmount11": true,
        "UserAmount12": true,
        "UserAmount13": true,
        "UserAmount14": true,
        "UserAmount15": true,
        "UserAmount16": true,
        "UserAmount17": true,
        "UserAmount18": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "CollateralCollHoldFilter": {
      "Query": "string"
    },
    "CollateralDocumentFilter": {
      "Query": "string",
      "CollateralDocumentChildrenFilter": {
        "CollateralDocumentTrackingFilter": {
          "Query": "string"
        }
      }
    },
    "CollateralFmHistoryFilter": {
      "Query": "string"
    },
    "CollateralTrackingFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCollateralCollHold⁠

POST

Retrieves collateral collateral hold.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CollateralNumberstringoptional
CollateralCollHoldLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/collateral/getCollateralCollHold
POST /nexum/627/2022.01/collateral/getCollateralCollHold HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CollateralNumber": "string",
  "CollateralCollHoldLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}

getCollateralCollHoldSelectFields⁠

POST

Retrieves collateral collateral hold with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CollateralNumberstringoptional
CollateralCollHoldLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/collateral/getCollateralCollHoldSelectFields
POST /nexum/627/2022.01/collateral/getCollateralCollHoldSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CollateralNumber": "string",
  "CollateralCollHoldLocator": 0,
  "SelectableFields": {
    "IncludeAllCollateralCollHoldFields": true,
    "CollateralCollHoldFields": {
      "AccountNumber": true,
      "Amount": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "Id": true,
      "IdType": true,
      "Locator": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCollateralCollHoldPagedList⁠

POST

Retrieves a paged list of collateral collateral holds.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
CollateralNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/collateral/getCollateralCollHoldPagedList
POST /nexum/627/2022.01/collateral/getCollateralCollHoldPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

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