Posting Period VariantΒΆ

Posting Period Variant - GetΒΆ

HTTP Request

GET /api/v1/posting-period-variants/{id}

πŸ“‹ Description: Retrieves the details of a specific posting period variant identified by the provided ID, facilitating insights into the financial organization structure and hierarchy of the associated 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

ResponsePostingPeriodVariantDto

Posting Period Variant - UpdateΒΆ

HTTP Request

PUT /api/v1/posting-period-variants/{id}

πŸ“‹ Description: Updates the details of a specific posting period variant within the financial organization structure, allowing for modifications to align with organizational hierarchy and entity requirements.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

PostingPeriodVariantDto

true

Request body containing the updated posting period variant details, including attributes that define the financial entity’s organizational structure and hierarchy.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePostingPeriodVariantDto

Posting Period Variant - DeleteΒΆ

HTTP Request

DELETE /api/v1/posting-period-variants/{id}

πŸ“‹ Description: Deletes a specified posting period variant 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

Posting Period Variant - Delete Or DecommissionΒΆ

HTTP Request

PUT /api/v1/posting-period-variants/remove/{id}

πŸ“‹ Description: Removes a specified posting period variant 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

Posting Period Variant - Delete Or Decommission AllΒΆ

HTTP Request

PUT /api/v1/posting-period-variants/remove/bulk

πŸ“‹ Description: Removes multiple posting period variants in bulk from the financial organization structure, streamlining the management of financial entities within the hierarchy.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of identifiers for the posting period variants to be removed in bulk, facilitating updates to the financial organization structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Posting Period Variant - DecommissionΒΆ

HTTP Request

PUT /api/v1/posting-period-variants/decommission/{id}

πŸ“‹ Description: Decommissions a specified posting period variant within the financial organization structure, effectively removing it from active use in the hierarchy of financial entities. This operation ensures the integrity and accuracy of the organizational structure by managing obsolete posting periods.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePostingPeriodVariantDto

Posting Period Variant - Decommission By Modification Date BeforeΒΆ

HTTP Request

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

πŸ“‹ Description: Decommissions posting period variants in the financial organization structure that were modified before the specified date, ensuring the integrity and relevance of the entity’s hierarchical data. This operation helps maintain an organized and efficient financial entity framework.

Parameters

Name

In

Type

Required

Description

modified_before

path

string(date-time)

true

Specifies the cutoff date for decommissioning posting period variants within the financial organization structure, ensuring that only those modified before this date are affected.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPostingPeriodVariantDto

Posting Period Variant - Decommission Before NowΒΆ

HTTP Request

PUT /api/v1/posting-period-variants/decommission/modified-before-now

πŸ“‹ Description: Decommissions posting period variants that were modified before the current date, ensuring the financial organization structure remains accurate and up-to-date. This operation is essential for maintaining the integrity of financial entity hierarchies within the system.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPostingPeriodVariantDto

Posting Period Variant - Decommission AllΒΆ

HTTP Request

PUT /api/v1/posting-period-variants/decommission/bulk

πŸ“‹ Description: Decommissions multiple posting period variants in bulk, effectively managing the financial organization structure and hierarchy within the financial entity. This operation ensures streamlined updates to the organizational framework by removing obsolete posting periods.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing a list of posting period variants to be decommissioned in bulk, reflecting changes in the financial organization structure and hierarchy.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPostingPeriodVariantDto

Posting Period Variant - Create Or Update BulkΒΆ

HTTP Request

PUT /api/v1/posting-period-variants/createOrUpdate/bulk

πŸ“‹ Description: Creates or updates multiple posting period variants in bulk for a financial organization, ensuring accurate alignment within the organizational structure and hierarchy.

Parameters

Name

In

Type

Required

Description

body

body

PostingPeriodVariantDto

true

Request body containing bulk data for creating or updating posting period variants within the financial organization structure, including relevant identifiers and attributes for each financial entity.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPostingPeriodVariantDto

Posting Period Variant - Create Or UpdateΒΆ

HTTP Request

PUT /api/v1/posting-period-variants/createOrUpdate

πŸ“‹ Description: Creates or updates posting period variants within the financial organization structure, ensuring accurate representation of the hierarchy and financial entity configurations.

Parameters

Name

In

Type

Required

Description

body

body

PostingPeriodVariantDto

true

Request body containing the financial entity’s posting period variant data, including details necessary for creating or updating organizational structure and hierarchy.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePostingPeriodVariantDto

Posting Period Variant - Bulk UpdateΒΆ

HTTP Request

PUT /api/v1/posting-period-variants/bulk

πŸ“‹ Description: Updates multiple posting period variants in bulk within the financial organization structure, allowing for efficient management of hierarchical financial entities.

Parameters

Name

In

Type

Required

Description

body

body

PostingPeriodVariantDto

true

Request body containing an array of posting period variant data, including attributes for financial entities within the organizational structure and hierarchy.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPostingPeriodVariantDto

Posting Period Variant - Bulk CreateΒΆ

HTTP Request

POST /api/v1/posting-period-variants/bulk

πŸ“‹ Description: Creates multiple posting period variants in bulk for a financial entity, enabling efficient updates to the organization’s financial structure and hierarchy.

Parameters

Name

In

Type

Required

Description

body

body

PostingPeriodVariantDto

true

Request body containing an array of posting period variant objects, each detailing the financial entity’s organizational structure and hierarchy for bulk processing.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListPostingPeriodVariantDto

Posting Period Variant - Bulk DeleteΒΆ

HTTP Request

DELETE /api/v1/posting-period-variants/bulk

πŸ“‹ Description: Deletes multiple posting period 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 posting period variant identifiers to be deleted, relevant for managing the financial organization structure and hierarchy.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Posting Period Variant - Find AllΒΆ

HTTP Request

GET /api/v1/posting-period-variants

πŸ“‹ Description: Retrieves a list of posting period variants within the financial organization structure, enabling users to understand the hierarchy and organization of financial entities. This operation supports efficient management and analysis of financial reporting periods.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the response should be paginated, facilitating efficient retrieval of posting period variants within the financial organization structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePostingPeriodVariantDto

Posting Period Variant - CreateΒΆ

HTTP Request

POST /api/v1/posting-period-variants

πŸ“‹ Description: Creates a new posting period variant within the financial organization structure, allowing for the effective management of hierarchical financial entities.

Parameters

Name

In

Type

Required

Description

body

body

PostingPeriodVariantDto

true

Request body containing the posting period variant data, including details on the financial entity’s organizational structure and hierarchy.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponsePostingPeriodVariantDto

Posting Period Variant - Get All By Posting Period ControlΒΆ

HTTP Request

GET /api/v1/posting-period-variants/posting-period-control/{fiscalPeriodId}

πŸ“‹ Description: Retrieves the posting period control details for a specified fiscal period within the financial organization structure, enabling users to manage and analyze fiscal timelines effectively.

Parameters

Name

In

Type

Required

Description

fiscalPeriodId

path

integer(int64)

true

Unique identifier for the fiscal period

pageable

query

Pageable

true

Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure related to the specified fiscal period.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePostingPeriodVariantDto

Posting Period Variant - Get MetadataΒΆ

HTTP Request

GET /api/v1/posting-period-variants/meta

πŸ“‹ Description: Retrieves metadata for posting period variants within the financial organization structure, providing insights into the hierarchy and organization of financial entities. This operation supports efficient navigation and understanding of the posting periods relevant to financial reporting.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Response Schema

Posting Period Variant - Find All By System IDΒΆ

HTTP Request

GET /api/v1/posting-period-variants/erp-system/{systemId}

πŸ“‹ Description: Retrieves posting period variants for a specified ERP system, enabling organizations to effectively manage their financial entity structures and hierarchies.

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 posting period variants for the specified ERP system should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePostingPeriodVariantDto

Posting Period Variant - Get All By CompanyΒΆ

HTTP Request

GET /api/v1/posting-period-variants/company/{company_id}

πŸ“‹ Description: Retrieves posting period variants for a specified financial organization, allowing users to understand the hierarchical structure and organization of financial entities within the company.

Parameters

Name

In

Type

Required

Description

company_id

path

integer(int64)

true

Unique identifier for the financial entity within the organizational structure, used to retrieve posting period variants specific to the specified company.

pageable

query

Pageable

true

Indicates whether the results of the posting period variants for the specified company should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePostingPeriodVariantDto