CollateralService

Manage collateral records.

Symitar eDocs References: Coming soon.

Operations

getCollateral

post

Retrieves collateral.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringRequired
Responses
200

Successful operation.

application/json
post
/getCollateral
200

Successful operation.

getCollateralSelectFields

post

Retrieves collateral with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralSelectFields
200

Successful operation.

getCollateralSelectFieldsFilterChildren

post

Retrieves collateral with selected fields and filtered children.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralSelectFieldsFilterChildren
200

Successful operation.

getCollateralCollHold

post

Retrieves collateral collateral hold.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralCollHoldLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getCollateralCollHold
200

Successful operation.

getCollateralCollHoldSelectFields

post

Retrieves collateral collateral hold with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralCollHoldLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getCollateralCollHoldSelectFields
200

Successful operation.

getCollateralCollHoldPagedList

post

Retrieves a paged list of collateral collateral holds.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralCollHoldPagedList
200

Successful operation.

getCollateralCollHoldListSelectFields

post

Retrieves a list of collateral collateral holds with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralCollHoldListSelectFields
200

Successful operation.

searchCollateralCollHoldSelectFields

post

Searches collateral collateral holds with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/searchCollateralCollHoldSelectFields
200

Successful operation.

getCollateralCollHoldPagedListSelectFields

post

Retrieves a paged list of collateral collateral holds with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralCollHoldPagedListSelectFields
200

Successful operation.

searchCollateralCollHoldPagedSelectFields

post

Searches collateral collateral holds with pagination and selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchCollateralCollHoldPagedSelectFields
200

Successful operation.

getCollateralDocument

post

Retrieves collateral document.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getCollateralDocument
200

Successful operation.

getCollateralDocumentSelectFields

post

Retrieves collateral document with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getCollateralDocumentSelectFields
200

Successful operation.

getCollateralDocumentSelectFieldsFilterChildren

post

Retrieves collateral document with selected fields and filtered children.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getCollateralDocumentSelectFieldsFilterChildren
200

Successful operation.

getCollateralDocumentPagedList

post

Retrieves a paged list of collateral documents.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralDocumentPagedList
200

Successful operation.

getCollateralDocumentListSelectFields

post

Retrieves a list of collateral documents with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralDocumentListSelectFields
200

Successful operation.

searchCollateralDocumentSelectFields

post

Searches collateral documents with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/searchCollateralDocumentSelectFields
200

Successful operation.

getCollateralDocumentPagedListSelectFields

post

Retrieves a paged list of collateral documents with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralDocumentPagedListSelectFields
200

Successful operation.

searchCollateralDocumentPagedSelectFields

post

Searches collateral documents with pagination and selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchCollateralDocumentPagedSelectFields
200

Successful operation.

getCollateralDocumentTracking

post

Retrieves collateral document tracking.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
CollateralDocumentTrackingLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getCollateralDocumentTracking
200

Successful operation.

getCollateralDocumentTrackingSelectFields

post

Retrieves collateral document tracking with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
CollateralDocumentTrackingLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getCollateralDocumentTrackingSelectFields
200

Successful operation.

getCollateralDocumentTrackingPagedList

post

Retrieves a paged list of collateral document tracking.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getCollateralDocumentTrackingPagedList
200

Successful operation.

getCollateralDocumentTrackingListSelectFields

post

Retrieves a list of collateral document tracking with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getCollateralDocumentTrackingListSelectFields
200

Successful operation.

searchCollateralDocumentTrackingSelectFields

post

Searches collateral document tracking with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/searchCollateralDocumentTrackingSelectFields
200

Successful operation.

getCollateralDocumentTrackingPagedListSelectFields

post

Retrieves a paged list of collateral document tracking with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getCollateralDocumentTrackingPagedListSelectFields
200

Successful operation.

searchCollateralDocumentTrackingPagedSelectFields

post

Searches collateral document tracking with pagination and selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchCollateralDocumentTrackingPagedSelectFields
200

Successful operation.

getCollateralFmHistoryPagedList

post

Retrieves a paged list of collateral FM history.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralFmHistoryPagedList
200

Successful operation.

getCollateralFmHistoryListSelectFields

post

Retrieves a list of collateral FM history with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralFmHistoryListSelectFields
200

Successful operation.

searchCollateralFmHistorySelectFields

post

Searches collateral FM history with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/searchCollateralFmHistorySelectFields
200

Successful operation.

getCollateralFmHistoryPagedListSelectFields

post

Retrieves a paged list of collateral FM history with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralFmHistoryPagedListSelectFields
200

Successful operation.

searchCollateralFmHistoryPagedSelectFields

post

Searches collateral FM history with pagination and selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchCollateralFmHistoryPagedSelectFields
200

Successful operation.

getCollateralTracking

post

Retrieves collateral tracking.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralTrackingLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getCollateralTracking
200

Successful operation.

getCollateralTrackingSelectFields

post

Retrieves collateral tracking with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralTrackingLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getCollateralTrackingSelectFields
200

Successful operation.

getCollateralTrackingPagedList

post

Retrieves a paged list of collateral tracking.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralTrackingPagedList
200

Successful operation.

getCollateralTrackingListSelectFields

post

Retrieves a list of collateral tracking with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralTrackingListSelectFields
200

Successful operation.

searchCollateralTrackingSelectFields

post

Searches collateral tracking with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/searchCollateralTrackingSelectFields
200

Successful operation.

getCollateralTrackingPagedListSelectFields

post

Retrieves a paged list of collateral tracking with selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getCollateralTrackingPagedListSelectFields
200

Successful operation.

searchCollateralTrackingPagedSelectFields

post

Searches collateral tracking with pagination and selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchCollateralTrackingPagedSelectFields
200

Successful operation.

updateCollateralByID

post

Updates collateral by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/updateCollateralByID
200

Successful operation.

updateCollateralCollHoldByID

post

Updates collateral collateral hold by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralCollHoldLocatorintegerOptional
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/updateCollateralCollHoldByID
200

Successful operation.

updateCollateralDocumentByID

post

Updates collateral document by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralDocumentLocatorintegerOptional
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/updateCollateralDocumentByID
200

Successful operation.

updateCollateralDocumentTrackingByID

post

Updates collateral document tracking by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralDocumentTrackingLocatorintegerOptional
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/updateCollateralDocumentTrackingByID
200

Successful operation.

updateCollateralTrackingByID

post

Updates collateral tracking by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralTrackingLocatorintegerOptional
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/updateCollateralTrackingByID
200

Successful operation.

createCollateral

post

Creates collateral.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful operation.

application/json
post
/createCollateral
200

Successful operation.

createCollateralCollHold

post

Creates collateral collateral hold.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/createCollateralCollHold
200

Successful operation.

createCollateralDocument

post

Creates collateral document.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/createCollateralDocument
200

Successful operation.

createCollateralDocumentTracking

post

Creates collateral document tracking.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/createCollateralDocumentTracking
200

Successful operation.

createCollateralTracking

post

Creates collateral tracking.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
Responses
200

Successful operation.

application/json
post
/createCollateralTracking
200

Successful operation.

deleteCollateralCollHold

post

Deletes collateral collateral hold.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralCollHoldLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/deleteCollateralCollHold
200

Successful operation.

deleteCollateralDocument

post

Deletes collateral document.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/deleteCollateralDocument
200

Successful operation.

deleteCollateralDocumentTracking

post

Deletes collateral document tracking.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralDocumentLocatorintegerOptional
CollateralDocumentTrackingLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/deleteCollateralDocumentTracking
200

Successful operation.

deleteCollateralTracking

post

Deletes collateral tracking.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CollateralNumberstringOptional
CollateralTrackingLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/deleteCollateralTracking
200

Successful operation.

Last updated

Was this helpful?