Transfer Variantยถ

Transfer Variant - Getยถ

HTTP Request

GET /api/v1/transfer-variants/{id}

๐Ÿ“‹ Description: Retrieves detailed information about a specific transfer variant within the financial organization structure, identified by the provided ID, to facilitate understanding of the entityโ€™s hierarchical 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

ResponseTransferVariantDto

Transfer Variant - Updateยถ

HTTP Request

PUT /api/v1/transfer-variants/{id}

๐Ÿ“‹ Description: Updates the details of a specific transfer variant within the financial organization structure, allowing for modifications to the hierarchy and attributes of the designated financial entity.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

TransferVariantDto

true

Request body containing the updated financial entity details, including organizational structure and hierarchy information for the specified transfer variant.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseTransferVariantDto

Transfer Variant - Deleteยถ

HTTP Request

DELETE /api/v1/transfer-variants/{id}

๐Ÿ“‹ Description: Deletes a specified transfer variant 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

Transfer Variant - Delete Or Decommissionยถ

HTTP Request

PUT /api/v1/transfer-variants/remove/{id}

๐Ÿ“‹ Description: Removes a specified transfer variant 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

Transfer Variant - Delete Or Decommission Allยถ

HTTP Request

PUT /api/v1/transfer-variants/remove/bulk

๐Ÿ“‹ Description: Removes multiple transfer variants from the financial organization structure, allowing for streamlined management of hierarchical relationships within financial entities.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing a list of financial entity transfer variant identifiers to be removed in bulk from the organizational structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Transfer Variant - Decommissionยถ

HTTP Request

PUT /api/v1/transfer-variants/decommission/{id}

๐Ÿ“‹ Description: Decommissions a specified transfer variant within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures the integrity and accuracy of the organizational framework by eliminating outdated or unnecessary transfer variants.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseTransferVariantDto

Transfer Variant - Decommission By Modification Date Beforeยถ

HTTP Request

PUT /api/v1/transfer-variants/decommission/modified-before/{modified_before}

๐Ÿ“‹ Description: Decommissions transfer variants that have been modified before the specified date, ensuring the financial organization structure remains current and aligned with operational needs. This operation supports maintaining an efficient hierarchy within the financial entity.

Parameters

Name

In

Type

Required

Description

modified_before

path

string(date-time)

true

Specifies the cutoff date for decommissioning transfer variants that were modified before the given date, ensuring alignment with the organizationโ€™s financial structure and hierarchy.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListTransferVariantDto

Transfer Variant - Decommission Before Nowยถ

HTTP Request

PUT /api/v1/transfer-variants/decommission/modified-before-now

๐Ÿ“‹ Description: Decommissions transfer variants within the financial organization structure that were modified before the current date, ensuring the hierarchy remains up-to-date and aligned with organizational changes.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListTransferVariantDto

Transfer Variant - Decommission Allยถ

HTTP Request

PUT /api/v1/transfer-variants/decommission/bulk

๐Ÿ“‹ Description: Decommissions multiple transfer variants in bulk 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 a list of financial entity transfer variant identifiers and their corresponding decommissioning details for bulk processing within the organizational structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListTransferVariantDto

Transfer Variant - Create Or Update Bulkยถ

HTTP Request

PUT /api/v1/transfer-variants/createOrUpdate/bulk

๐Ÿ“‹ Description: Creates or updates multiple transfer variants in the financial organization structure, enabling efficient management of hierarchical relationships within financial entities.

Parameters

Name

In

Type

Required

Description

body

body

TransferVariantDto

true

Request body containing bulk transfer variant data for creating or updating financial entities within the organizational structure and hierarchy.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListTransferVariantDto

Transfer Variant - Create Or Updateยถ

HTTP Request

PUT /api/v1/transfer-variants/createOrUpdate

๐Ÿ“‹ Description: Creates or updates transfer variants within the financial organization structure, enabling efficient management of organizational hierarchies and financial entities.

Parameters

Name

In

Type

Required

Description

body

body

TransferVariantDto

true

Request body containing the financial entityโ€™s transfer variant data, including organizational structure details and hierarchy specifications for creation or update.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseTransferVariantDto

Transfer Variant - Bulk Updateยถ

HTTP Request

PUT /api/v1/transfer-variants/bulk

๐Ÿ“‹ Description: Updates multiple transfer variants within the financial organization structure, allowing for efficient management of hierarchical relationships among financial entities.

Parameters

Name

In

Type

Required

Description

body

body

TransferVariantDto

true

Request body containing a collection of financial entity transfer variant data, including organizational hierarchy details and associated metadata for bulk updates.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListTransferVariantDto

Transfer Variant - Bulk Createยถ

HTTP Request

POST /api/v1/transfer-variants/bulk

๐Ÿ“‹ Description: Facilitates the bulk transfer of financial variants within the organizational structure, enabling efficient management of financial entities and their hierarchical relationships.

Parameters

Name

In

Type

Required

Description

body

body

TransferVariantDto

true

Request body containing a collection of financial entity transfer variant details, including organization hierarchy and structural attributes for bulk processing.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListTransferVariantDto

Transfer Variant - Bulk Deleteยถ

HTTP Request

DELETE /api/v1/transfer-variants/bulk

๐Ÿ“‹ Description: Deletes multiple transfer variants within the financial organization structure, allowing for streamlined management of hierarchical financial entities.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing a list of financial entity transfer variant identifiers to be deleted in bulk, reflecting changes in the organizationโ€™s structure and hierarchy.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Transfer Variant - Detach Companyยถ

HTTP Request

POST /api/v1/transfer-variants/detach/company/{companyId}

๐Ÿ“‹ Description: Detaches a specified financial entity from its associated organization structure, allowing for adjustments in the hierarchy of the financial organization. This operation is essential for maintaining accurate organizational relationships and ensuring compliance with financial governance.

Parameters

Name

In

Type

Required

Description

companyId

path

integer(int64)

true

Unique identifier for the company

body

body

TransferVariantDto

true

Request body containing the details of the financial entityโ€™s transfer variant to be detached from the specified company, including relevant identifiers and metadata.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Transfer Variant - Attach Companyยถ

HTTP Request

POST /api/v1/transfer-variants/attach/company/{companyId}

๐Ÿ“‹ Description: Attaches a specified financial entity to the organizational structure by linking it to the designated company ID, facilitating the management of hierarchical relationships within the financial organization.

Parameters

Name

In

Type

Required

Description

companyId

path

integer(int64)

true

Unique identifier for the company

body

body

TransferVariantDto

true

Request body containing the financial entity details to be attached to the specified companyโ€™s organizational structure, including relevant hierarchy information.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Transfer Variant - Find Allยถ

HTTP Request

GET /api/v1/transfer-variants

๐Ÿ“‹ Description: Retrieves transfer variants associated with the financial organization structure, enabling users to view and analyze the hierarchical relationships within financial entities.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the financial organization structureโ€™s transfer variants should be returned in a paginated format, facilitating efficient data retrieval for hierarchical analysis.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageTransferVariantDto

Transfer Variant - Createยถ

HTTP Request

POST /api/v1/transfer-variants

๐Ÿ“‹ Description: Creates new transfer variants within the financial organization structure, enabling the establishment of hierarchical relationships among financial entities.

Parameters

Name

In

Type

Required

Description

body

body

TransferVariantDto

true

Request body containing the financial entity transfer variant details, including organizational hierarchy and structural attributes.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseTransferVariantDto

Transfer Variant - Get Metadataยถ

HTTP Request

GET /api/v1/transfer-variants/meta

๐Ÿ“‹ Description: Retrieves metadata related to transfer variants within the financial organization structure, providing insights into the hierarchy and relationships of financial entities. This operation supports effective management and analysis of organizational configurations.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Transfer Variant - Find All By System IDยถ

HTTP Request

GET /api/v1/transfer-variants/erp-system/{systemId}

๐Ÿ“‹ Description: Retrieves transfer variants associated with a specified ERP system, providing insights into the financial organization structure and hierarchy of the designated financial entity.

Parameters

Name

In

Type

Required

Description

systemId

path

integer(int64)

true

Unique identifier for the system

pageable

query

Pageable

true

Indicates whether the results of the financial organization structure transfer variants should be returned in a paginated format, facilitating efficient data retrieval for large datasets within the specified ERP system.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageTransferVariantDto