End Of Term Determination

End Of Term Determination - Get

HTTP Request

GET /api/v1/end-of-term-determinations/{id}

Interactive Demo

📋 Description: Retrieves the end-of-term determination details for a specified financial entity within the organizational structure, providing insights into the hierarchy and financial implications associated with the given ID.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseEndOfTermDeterminationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "countryDisplayId": "string",
    "companyName": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Update

HTTP Request

PUT /api/v1/end-of-term-determinations/{id}

Interactive Demo

📋 Description: Updates the end-of-term determination for a specified financial entity within the organizational structure, allowing for modifications to the hierarchy and associated attributes.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	EndOfTermDeterminationDto	true	Request body containing the updated end-of-term determination data, including financial entity details and hierarchical structure information.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "companyId": 0,
  "companyDisplayId": "string",
  "countryDisplayId": "string",
  "companyName": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseEndOfTermDeterminationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "countryDisplayId": "string",
    "companyName": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Delete

HTTP Request

DELETE /api/v1/end-of-term-determinations/{id}

Interactive Demo

📋 Description: Deletes a specific end-of-term determination identified by the provided ID, facilitating the management of financial organization structures and ensuring accurate hierarchy representation within the financial entity.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Delete Or Decommission

HTTP Request

PUT /api/v1/end-of-term-determinations/remove/{id}

Interactive Demo

📋 Description: Removes a specified end-of-term determination from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Delete Or Decommission All

HTTP Request

PUT /api/v1/end-of-term-determinations/remove/bulk

Interactive Demo

📋 Description: Removes multiple end-of-term determinations from the financial organization structure, enabling efficient management of hierarchical data within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers to facilitate the bulk removal of end-of-term determinations within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Decommission

HTTP Request

PUT /api/v1/end-of-term-determinations/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified end-of-term determination within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or irrelevant determinations are no longer considered in organizational assessments.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseEndOfTermDeterminationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "countryDisplayId": "string",
    "companyName": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/end-of-term-determinations/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions end-of-term determinations for financial entities that were modified before the specified date, ensuring the organization’s structure and hierarchy remain current and compliant.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning end-of-term determinations, allowing financial organizations to manage their structural hierarchy effectively.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListEndOfTermDeterminationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "countryDisplayId": "string",
      "companyName": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Decommission Before Now

HTTP Request

PUT /api/v1/end-of-term-determinations/decommission/modified-before-now

Interactive Demo

📋 Description: Updates the status of financial entities within the organizational structure by decommissioning those modified before the current date, ensuring accurate hierarchy management.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListEndOfTermDeterminationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "countryDisplayId": "string",
      "companyName": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Decommission All

HTTP Request

PUT /api/v1/end-of-term-determinations/decommission/bulk

Interactive Demo

📋 Description: Updates the status of multiple end-of-term determinations to ‘decommission’ within the financial organization structure, facilitating the management of organizational hierarchy and financial entity transitions.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers and associated decommissioning details for bulk processing of end-of-term determinations within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListEndOfTermDeterminationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "countryDisplayId": "string",
      "companyName": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Create Or Update Bulk

HTTP Request

PUT /api/v1/end-of-term-determinations/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple end-of-term determinations for financial entities within the organizational structure, ensuring accurate hierarchy management and compliance with financial regulations.

Parameters

Name	In	Type	Required	Description
body	body	EndOfTermDeterminationDto	true	Request body containing bulk data for creating or updating end-of-term determinations, including organizational hierarchy and financial entity details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "countryDisplayId": "string",
    "companyName": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListEndOfTermDeterminationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "countryDisplayId": "string",
      "companyName": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Create Or Update

HTTP Request

PUT /api/v1/end-of-term-determinations/createOrUpdate

Interactive Demo

📋 Description: Creates or updates end-of-term determinations within the financial organization structure, ensuring accurate representation of the hierarchy and financial entity relationships.

Parameters

Name	In	Type	Required	Description
body	body	EndOfTermDeterminationDto	true	Request body containing the financial entity’s end-of-term determination data, including organizational hierarchy details and relevant attributes for creation or update.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "companyId": 0,
  "companyDisplayId": "string",
  "countryDisplayId": "string",
  "companyName": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseEndOfTermDeterminationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "countryDisplayId": "string",
    "companyName": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Bulk Update

HTTP Request

PUT /api/v1/end-of-term-determinations/bulk

Interactive Demo

📋 Description: Updates multiple end-of-term determinations for financial entities within the organizational structure, allowing for efficient management of hierarchical financial data.

Parameters

Name	In	Type	Required	Description
body	body	EndOfTermDeterminationDto	true	Request body containing a bulk set of end-of-term determination data, including financial entity identifiers and hierarchical structure details for organizational assessment.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "countryDisplayId": "string",
    "companyName": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListEndOfTermDeterminationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "countryDisplayId": "string",
      "companyName": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Bulk Create

HTTP Request

POST /api/v1/end-of-term-determinations/bulk

Interactive Demo

📋 Description: Submits bulk end-of-term determinations for financial entities within the organizational structure, enabling efficient processing and management of hierarchical financial data.

Parameters

Name	In	Type	Required	Description
body	body	EndOfTermDeterminationDto	true	Request body containing a bulk submission of end-of-term determination data for financial entities, including organization identifiers and hierarchical structure details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "countryDisplayId": "string",
    "companyName": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListEndOfTermDeterminationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "countryDisplayId": "string",
      "companyName": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Bulk Delete

HTTP Request

DELETE /api/v1/end-of-term-determinations/bulk

Interactive Demo

📋 Description: Deletes multiple end-of-term determinations within the financial organization structure, streamlining the management of financial entities and their hierarchical relationships.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of financial entity identifiers for bulk deletion of end-of-term determinations within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Search

HTTP Request

POST /api/v1/end-of-term-determinations/search

Interactive Demo

📋 Description: Submits a request to search for end-of-term determinations within the financial organization structure, allowing users to filter results based on specific criteria related to organizational hierarchy and financial entities.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	EndOfTermDeterminationDtoFilter	false	Request body containing the criteria for searching end-of-term determinations within the financial organization structure, including relevant parameters for organization hierarchy and financial entity identification.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "erpSystemIdEqual": 0,
  "erpSystemDisplayIdLike": "string",
  "companyDisplayIdLike": "string",
  "companyIdEqual": 0,
  "countryDisplayIdLike": "string",
  "companyNameLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageEndOfTermDeterminationDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "countryDisplayId": "string",
      "companyName": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Find All

HTTP Request

GET /api/v1/end-of-term-determinations

Interactive Demo

📋 Description: Retrieves end-of-term determinations for financial entities within the organizational structure, providing insights into hierarchical financial assessments.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the end-of-term determinations query should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageEndOfTermDeterminationDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "countryDisplayId": "string",
      "companyName": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Create

HTTP Request

POST /api/v1/end-of-term-determinations

Interactive Demo

📋 Description: Creates end-of-term determinations for financial entities within the organizational structure, enabling effective management of hierarchy and compliance with financial regulations.

Parameters

Name	In	Type	Required	Description
body	body	EndOfTermDeterminationDto	true	Request body containing the end-of-term determination data for financial entities, including organizational structure and hierarchy details.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "companyId": 0,
  "companyDisplayId": "string",
  "countryDisplayId": "string",
  "companyName": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseEndOfTermDeterminationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "countryDisplayId": "string",
    "companyName": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

End Of Term Determination - Get Metadata

HTTP Request

GET /api/v1/end-of-term-determinations/meta

Interactive Demo

📋 Description: Retrieves metadata related to end-of-term determinations within the financial organization structure, providing insights into the hierarchy and organization of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "COMPANY"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---