Agreement Group

Agreement Group - Get

HTTP Request

GET /api/v1/agreement-groups/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific agreement group within the financial organization structure, identified by the provided ID, to facilitate understanding of the organization’s hierarchy and 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	ResponseAgreementGroupDto

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

Agreement Group - Update

HTTP Request

PUT /api/v1/agreement-groups/{id}

Interactive Demo

📋 Description: Updates the details of a specified agreement group within the financial organization structure, enabling users to maintain accurate hierarchy and organizational information for financial entities.

Parameters

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

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAgreementGroupDto

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

Agreement Group - Delete

HTTP Request

DELETE /api/v1/agreement-groups/{id}

Interactive Demo

📋 Description: Deletes a specified agreement group from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective management 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

Agreement Group - Delete Or Decommission

HTTP Request

PUT /api/v1/agreement-groups/remove/{id}

Interactive Demo

📋 Description: Removes a specified agreement group from the financial organization structure, ensuring the hierarchy remains aligned with the current organizational 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	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

Agreement Group - Delete Or Decommission All

HTTP Request

PUT /api/v1/agreement-groups/remove/bulk

Interactive Demo

📋 Description: Removes multiple agreement groups from the financial organization structure, allowing for efficient management of hierarchical relationships within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of agreement group identifiers to be removed in bulk, facilitating the management of the financial organization structure and 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

Agreement Group - Decommission

HTTP Request

PUT /api/v1/agreement-groups/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified agreement group within the financial organization structure, effectively removing it from the active hierarchy and ensuring it is no longer utilized in organizational operations.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAgreementGroupDto

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

Agreement Group - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/agreement-groups/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions agreement groups within the financial organization structure that have been modified before a specified date, ensuring the hierarchy remains streamlined and up-to-date. This operation supports effective management of financial entities by removing outdated agreements.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning agreement groups, ensuring that only those modified before this date are processed within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAgreementGroupDto

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

Agreement Group - Decommission Before Now

HTTP Request

PUT /api/v1/agreement-groups/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions agreement groups that have been modified before the current date, ensuring the financial organization’s structure remains up-to-date and aligned with its operational hierarchy. This operation supports the maintenance of an organized and efficient financial entity framework.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAgreementGroupDto

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

Agreement Group - Decommission All

HTTP Request

PUT /api/v1/agreement-groups/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple agreement groups within the financial organization structure, allowing for efficient management of organizational hierarchies and entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of agreement group identifiers and their respective decommissioning details, facilitating the management of financial entity structures within the organization.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAgreementGroupDto

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

Agreement Group - Create Or Update Bulk

HTTP Request

PUT /api/v1/agreement-groups/createOrUpdate/bulk

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	AgreementGroupDto	true	Request body containing a bulk set of agreement group data, including organizational hierarchy details and financial entity attributes, for creating or updating records within the financial organization structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAgreementGroupDto

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

Agreement Group - Create Or Update

HTTP Request

PUT /api/v1/agreement-groups/createOrUpdate

Interactive Demo

📋 Description: Creates or updates agreement groups within the financial organization structure, ensuring alignment with the established hierarchy and organizational framework. This operation facilitates the management of financial entities by allowing for the seamless integration of new or modified agreement group data.

Parameters

Name	In	Type	Required	Description
body	body	AgreementGroupDto	true	Request body containing the details of the agreement group, including its hierarchical structure and associated financial entity information for creation or update purposes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAgreementGroupDto

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

Agreement Group - Bulk Update

HTTP Request

PUT /api/v1/agreement-groups/bulk

Interactive Demo

📋 Description: Updates multiple agreement groups within the financial organization structure, allowing for efficient management of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	AgreementGroupDto	true	Request body containing an array of agreement group data, including identifiers and hierarchical relationships, to facilitate bulk updates within the financial organization structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAgreementGroupDto

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

Agreement Group - Bulk Create

HTTP Request

POST /api/v1/agreement-groups/bulk

Interactive Demo

📋 Description: Creates multiple agreement groups in bulk within the financial organization structure, facilitating efficient management of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	AgreementGroupDto	true	Request body containing a collection of agreement group data, including hierarchical relationships and attributes relevant to the financial organization structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListAgreementGroupDto

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

Agreement Group - Bulk Delete

HTTP Request

DELETE /api/v1/agreement-groups/bulk

Interactive Demo

📋 Description: Deletes multiple agreement groups within the financial organization structure, allowing for streamlined management of organizational hierarchies and entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of identifiers for the agreement groups to be deleted, facilitating the management of the financial organization’s structure and 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

Agreement Group - Search

HTTP Request

POST /api/v1/agreement-groups/search

Interactive Demo

📋 Description: Submits a request to search for agreement groups 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	AgreementGroupDtoFilter	false	Request body containing search criteria for agreement groups within the financial organization structure, including parameters related to organizational hierarchy and financial entities.

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	PageAgreementGroupDto

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

Agreement Group - Find All

HTTP Request

GET /api/v1/agreement-groups

Interactive Demo

📋 Description: Retrieves a list of agreement groups within the financial organization structure, providing insights into the hierarchical relationships and classifications of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of agreement group data within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageAgreementGroupDto

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

Agreement Group - Create

HTTP Request

POST /api/v1/agreement-groups

Interactive Demo

📋 Description: Creates a new agreement group within the financial organization structure, enabling the establishment of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	AgreementGroupDto	true	Request body containing the details of agreement groups, including organizational hierarchy and financial entity attributes, to facilitate structured management within the financial organization.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseAgreementGroupDto

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

Agreement Group - Get Metadata

HTTP Request

GET /api/v1/agreement-groups/meta

Interactive Demo

📋 Description: Retrieves metadata for agreement groups within the financial organization structure, providing insights into the hierarchy and relationships of financial entities. This operation supports effective management and analysis of organizational agreements.

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

---