Contract Group 1

Contract Group - Get

HTTP Request

GET /api/v1/contract-group-1/{id}

Interactive Demo

📋 Description: Retrieves the details of a specific contract group within the financial organization structure, identified by its unique ID, to facilitate understanding of the organization’s hierarchy and financial entity relationships.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContractGroup1Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
}

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

Contract Group - Update

HTTP Request

PUT /api/v1/contract-group-1/{id}

Interactive Demo

📋 Description: Updates the details of a specified contract group within the financial organization structure, allowing for modifications to the hierarchy and organization of financial entities. This operation ensures that the contract group reflects the most current business requirements and organizational changes.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ContractGroup1Dto	true	Request body containing the updated financial entity details for the specified contract group, including organizational hierarchy and structural attributes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContractGroup1Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
}

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

Contract Group - Delete

HTTP Request

DELETE /api/v1/contract-group-1/{id}

Interactive Demo

📋 Description: Deletes a specified contract group within the financial organization structure, thereby removing it from the hierarchy of financial entities.

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

Contract Group - Delete Or Decommission

HTTP Request

PUT /api/v1/contract-group-1/remove/{id}

Interactive Demo

📋 Description: Removes a specified contract group from the financial organization structure, ensuring the integrity of the hierarchy 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

Contract Group - Delete Or Decommission All

HTTP Request

PUT /api/v1/contract-group-1/remove/bulk

Interactive Demo

📋 Description: Removes multiple contract groups from the financial organization structure, enabling efficient management of organizational hierarchy and resources.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers to be removed in bulk from the organizational structure hierarchy.

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

Contract Group - Decommission

HTTP Request

PUT /api/v1/contract-group-1/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified contract group within the financial organization structure, effectively removing it from the active hierarchy. This operation ensures that the organizational structure remains current and accurately reflects the financial entity’s operational needs.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContractGroup1Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
}

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

Contract Group - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/contract-group-1/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions financial entities within the specified contract group that were modified before the given date, ensuring the organization’s structure remains current and aligned with operational requirements.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning contract groups, allowing for the management of financial entity structures based on modification timelines.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContractGroup1Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string"
    }
  ]
}

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

Contract Group - Decommission Before Now

HTTP Request

PUT /api/v1/contract-group-1/decommission/modified-before-now

Interactive Demo

📋 Description: Updates the status of specified contract groups within the financial organization structure to decommission those modified before the current date, ensuring accurate hierarchy management and compliance within the organization.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContractGroup1Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string"
    }
  ]
}

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

Contract Group - Decommission All

HTTP Request

PUT /api/v1/contract-group-1/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple contract groups within the financial organization structure, allowing for efficient management of organizational hierarchy and entity relationships.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers and their corresponding decommissioning details to facilitate the bulk decommissioning process within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContractGroup1Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string"
    }
  ]
}

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

Contract Group - Create Or Update Bulk

HTTP Request

PUT /api/v1/contract-group-1/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple contract groups within the financial organization structure, enabling efficient management of organizational hierarchy and relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ContractGroup1Dto	true	Request body containing bulk data for creating or updating financial organization structures, including details on hierarchy and associated financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContractGroup1Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string"
    }
  ]
}

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

Contract Group - Create Or Update

HTTP Request

PUT /api/v1/contract-group-1/createOrUpdate

Interactive Demo

📋 Description: Creates or updates a contract group within the financial organization structure, ensuring alignment with the established hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ContractGroup1Dto	true	Request body containing the financial entity details for creating or updating an organizational structure within the specified contract group.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContractGroup1Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
}

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

Contract Group - Bulk Update

HTTP Request

PUT /api/v1/contract-group-1/bulk

Interactive Demo

📋 Description: Updates multiple contract groups within the financial organization structure, enabling efficient management of hierarchical relationships and organizational entities.

Parameters

Name	In	Type	Required	Description
body	body	ContractGroup1Dto	true	Request body containing a collection of financial entity data for bulk updates to the organizational structure and hierarchy within the specified contract group.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContractGroup1Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string"
    }
  ]
}

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

Contract Group - Bulk Create

HTTP Request

POST /api/v1/contract-group-1/bulk

Interactive Demo

📋 Description: Creates multiple contract groups within the financial organization structure, enabling efficient management of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	ContractGroup1Dto	true	Request body containing a collection of financial entity data for bulk processing within the organizational structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListContractGroup1Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string"
    }
  ]
}

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

Contract Group - Bulk Delete

HTTP Request

DELETE /api/v1/contract-group-1/bulk

Interactive Demo

📋 Description: Deletes multiple contract groups within the financial organization structure, allowing for efficient management of organizational hierarchy and financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing identifiers for multiple contract groups to be deleted within the financial organization structure, facilitating efficient management of organizational hierarchy.

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

Contract Group - Search

HTTP Request

POST /api/v1/contract-group-1/search

Interactive Demo

📋 Description: Submits a search request to retrieve contract groups within the financial organization structure, enabling users to explore the hierarchy and relationships of 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	ContractGroup1DtoFilter	false	Request body containing search criteria and filters for retrieving financial organization structure data relevant to the specified contract group.

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",
  "uiSelector": "string",
  "nameLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageContractGroup1Dto

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",
      "name": "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

Contract Group - Find All

HTTP Request

GET /api/v1/contract-group-1

Interactive Demo

📋 Description: Fetches the details of the specified contract group within the financial organization structure, providing insights into the hierarchy and relationships of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure data.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageContractGroup1Dto

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",
      "name": "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

Contract Group - Create

HTTP Request

POST /api/v1/contract-group-1

Interactive Demo

📋 Description: Creates a new contract group within the financial organization structure, enabling the establishment of hierarchical relationships among financial entities for improved organizational management.

Parameters

Name	In	Type	Required	Description
body	body	ContractGroup1Dto	true	Request body containing the organizational structure data for a financial entity, including details on hierarchy and group classifications.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseContractGroup1Dto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string"
  }
}

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

Contract Group - Get Metadata

HTTP Request

GET /api/v1/contract-group-1/meta

Interactive Demo

📋 Description: Retrieves metadata related to the financial organization structure, providing insights into the hierarchy and relationships of financial entities within Contract Group 1.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

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

---