CollateralService⁠

Manage collateral records.

Operations⁠

getCollateralDocumentSelectFieldsFilterChildren⁠

POST

Retrieves collateral document 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

CollateralDocumentLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/collateral/getCollateralDocumentSelectFieldsFilterChildren

POST /nexum/627/2022.01/collateral/getCollateralDocumentSelectFieldsFilterChildren 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",
  "CollateralDocumentLocator": 0,
  "SelectableFields": {
    "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
      }
    }
  },
  "ChildrenSearchFilter": {
    "CollateralDocumentTrackingFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCollateralDocumentPagedList⁠

POST

Retrieves a paged list of collateral documents.

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/getCollateralDocumentPagedList

POST /nexum/627/2022.01/collateral/getCollateralDocumentPagedList 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": {}
  }
}

getCollateralDocumentListSelectFields⁠

POST

Retrieves a list of collateral documents 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/getCollateralDocumentListSelectFields

POST /nexum/627/2022.01/collateral/getCollateralDocumentListSelectFields 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": {
    "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
      }
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchCollateralDocumentSelectFields⁠

POST

Searches collateral documents 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/searchCollateralDocumentSelectFields

POST /nexum/627/2022.01/collateral/searchCollateralDocumentSelectFields 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": {
    "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
      }
    }
  },
  "SearchFilter": {
    "Query": "string",
    "CollateralDocumentChildrenFilter": {
      "CollateralDocumentTrackingFilter": {
        "Query": "string"
      }
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCollateralDocumentPagedListSelectFields⁠

POST

Retrieves a paged list of collateral documents 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

Tokenstringoptional

POST/nexum/{sym}/2022.01/collateral/getCollateralDocumentPagedListSelectFields

POST /nexum/627/2022.01/collateral/getCollateralDocumentPagedListSelectFields 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"
  },
  "SelectableFields": {
    "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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchCollateralDocumentPagedSelectFields⁠

POST

Searches collateral documents with pagination and selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

CollateralNumberstringoptional

Querystringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/2022.01/collateral/searchCollateralDocumentPagedSelectFields

POST /nexum/627/2022.01/collateral/searchCollateralDocumentPagedSelectFields 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"
  },
  "SelectableFields": {
    "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
    }
  },
  "Query": "string",
  "nxAttributes": {
    "customFields": {}
  }
}