Fiscal Variant

Fiscal Variant - Get

HTTP Request

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

Interactive Demo

📋 Description: Retrieves the details of a specific fiscal variant identified by the provided ID, facilitating insights into the financial organization structure and hierarchy of the 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	ResponseFiscalVariantDto

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",
    "numberOfPostingPeriods": 0,
    "numberOfSpecialPeriods": 0,
    "isCalendarYear": true,
    "yearDependent": true,
    "companyId": 0,
    "fiscalPeriodId": 0,
    "postingPeriodControlId": 0
  }
}

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

Fiscal Variant - Update

HTTP Request

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

Interactive Demo

📋 Description: Updates the specified fiscal variant within the financial organization structure, allowing for modifications to its attributes and hierarchy as needed to reflect changes in the financial entity.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	FiscalVariantDto	true	Request body containing the updated fiscal variant details, including attributes related to the financial organization structure and hierarchy for the specified financial entity.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "numberOfPostingPeriods": 0,
  "numberOfSpecialPeriods": 0,
  "isCalendarYear": true,
  "yearDependent": true,
  "companyId": 0,
  "fiscalPeriodId": 0,
  "postingPeriodControlId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFiscalVariantDto

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",
    "numberOfPostingPeriods": 0,
    "numberOfSpecialPeriods": 0,
    "isCalendarYear": true,
    "yearDependent": true,
    "companyId": 0,
    "fiscalPeriodId": 0,
    "postingPeriodControlId": 0
  }
}

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

Fiscal Variant - Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes a specified fiscal variant from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective financial entity management.

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

Fiscal Variant - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified fiscal variant from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective financial entity management.

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

Fiscal Variant - Delete Or Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Removes multiple fiscal variants from the financial organization structure in a single operation, 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 financial entity identifiers for bulk removal 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

Fiscal Variant - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified fiscal variant within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or unnecessary fiscal variants are no longer considered in organizational financial planning and reporting.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFiscalVariantDto

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",
    "numberOfPostingPeriods": 0,
    "numberOfSpecialPeriods": 0,
    "isCalendarYear": true,
    "yearDependent": true,
    "companyId": 0,
    "fiscalPeriodId": 0,
    "postingPeriodControlId": 0
  }
}

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

Fiscal Variant - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Decommissions fiscal variants in the financial organization structure that were modified before the specified date, ensuring the hierarchy remains current and aligned with organizational needs. This operation helps maintain an efficient and accurate representation of financial entities.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFiscalVariantDto

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",
      "numberOfPostingPeriods": 0,
      "numberOfSpecialPeriods": 0,
      "isCalendarYear": true,
      "yearDependent": true,
      "companyId": 0,
      "fiscalPeriodId": 0,
      "postingPeriodControlId": 0
    }
  ]
}

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

Fiscal Variant - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Decommissions fiscal variants that were modified before the current date, ensuring the financial organization structure remains up-to-date and aligned with organizational hierarchy requirements. This operation helps maintain the integrity of financial entities by removing outdated configurations.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFiscalVariantDto

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",
      "numberOfPostingPeriods": 0,
      "numberOfSpecialPeriods": 0,
      "isCalendarYear": true,
      "yearDependent": true,
      "companyId": 0,
      "fiscalPeriodId": 0,
      "postingPeriodControlId": 0
    }
  ]
}

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

Fiscal Variant - Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Decommissions multiple fiscal variants within the financial organization structure, enabling efficient management of financial entities and their hierarchical 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 for bulk processing within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFiscalVariantDto

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",
      "numberOfPostingPeriods": 0,
      "numberOfSpecialPeriods": 0,
      "isCalendarYear": true,
      "yearDependent": true,
      "companyId": 0,
      "fiscalPeriodId": 0,
      "postingPeriodControlId": 0
    }
  ]
}

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

Fiscal Variant - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates multiple fiscal variants in bulk within the financial organization structure, ensuring efficient management of financial entities and their hierarchical relationships.

Parameters

Name	In	Type	Required	Description
body	body	FiscalVariantDto	true	Request body containing a list of fiscal variant objects for bulk creation or update, including details essential for defining the financial organization structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "numberOfPostingPeriods": 0,
    "numberOfSpecialPeriods": 0,
    "isCalendarYear": true,
    "yearDependent": true,
    "companyId": 0,
    "fiscalPeriodId": 0,
    "postingPeriodControlId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFiscalVariantDto

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",
      "numberOfPostingPeriods": 0,
      "numberOfSpecialPeriods": 0,
      "isCalendarYear": true,
      "yearDependent": true,
      "companyId": 0,
      "fiscalPeriodId": 0,
      "postingPeriodControlId": 0
    }
  ]
}

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

Fiscal Variant - Create Or Update

HTTP Request

PUT /api/v1/fiscal-variants/createOrUpdate

Interactive Demo

📋 Description: Creates or updates fiscal variants within the financial organization structure, ensuring accurate representation of the hierarchy and financial entity configurations.

Parameters

Name	In	Type	Required	Description
body	body	FiscalVariantDto	true	Request body containing the financial entity’s organizational structure data, including details for creating or updating fiscal variants within the hierarchy.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "numberOfPostingPeriods": 0,
  "numberOfSpecialPeriods": 0,
  "isCalendarYear": true,
  "yearDependent": true,
  "companyId": 0,
  "fiscalPeriodId": 0,
  "postingPeriodControlId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFiscalVariantDto

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",
    "numberOfPostingPeriods": 0,
    "numberOfSpecialPeriods": 0,
    "isCalendarYear": true,
    "yearDependent": true,
    "companyId": 0,
    "fiscalPeriodId": 0,
    "postingPeriodControlId": 0
  }
}

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

Fiscal Variant - Bulk Update

HTTP Request

PUT /api/v1/fiscal-variants/bulk

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	FiscalVariantDto	true	Request body containing a collection of fiscal variant data, including attributes for organization structure and hierarchy relevant to financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "numberOfPostingPeriods": 0,
    "numberOfSpecialPeriods": 0,
    "isCalendarYear": true,
    "yearDependent": true,
    "companyId": 0,
    "fiscalPeriodId": 0,
    "postingPeriodControlId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFiscalVariantDto

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",
      "numberOfPostingPeriods": 0,
      "numberOfSpecialPeriods": 0,
      "isCalendarYear": true,
      "yearDependent": true,
      "companyId": 0,
      "fiscalPeriodId": 0,
      "postingPeriodControlId": 0
    }
  ]
}

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

Fiscal Variant - Bulk Create

HTTP Request

POST /api/v1/fiscal-variants/bulk

Interactive Demo

📋 Description: Creates multiple fiscal variants in a single request, enabling efficient management of financial entities within the organizational structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	FiscalVariantDto	true	Request body containing a collection of fiscal variant data, including attributes necessary for defining financial entities within the organizational structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "numberOfPostingPeriods": 0,
    "numberOfSpecialPeriods": 0,
    "isCalendarYear": true,
    "yearDependent": true,
    "companyId": 0,
    "fiscalPeriodId": 0,
    "postingPeriodControlId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFiscalVariantDto

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",
      "numberOfPostingPeriods": 0,
      "numberOfSpecialPeriods": 0,
      "isCalendarYear": true,
      "yearDependent": true,
      "companyId": 0,
      "fiscalPeriodId": 0,
      "postingPeriodControlId": 0
    }
  ]
}

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

Fiscal Variant - Bulk Delete

HTTP Request

DELETE /api/v1/fiscal-variants/bulk

Interactive Demo

📋 Description: Deletes multiple fiscal variants from the financial organization structure, enabling efficient management of financial entities and their hierarchical configurations.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of fiscal variant identifiers to be deleted in bulk from the financial organization 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

Fiscal Variant - Search

HTTP Request

POST /api/v1/fiscal-variants/search

Interactive Demo

📋 Description: Submits a search request for fiscal variants within the financial organization structure, enabling users to efficiently identify and analyze hierarchical 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	FiscalVariantDtoFilter	false	Request body containing the search criteria for fiscal variants, including parameters relevant to the organization’s financial structure and hierarchy.

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,
  "erpSystemIdIn": [
    0
  ],
  "erpSystemDisplayIdLike": "string",
  "uiSelector": "string",
  "numberOfPostingPeriodsLike": "string",
  "numberOfSpecialPeriodsLike": "string",
  "isCalendarYearEqual": true,
  "yearDependentEqual": true,
  "companyIdEqual": 0,
  "fiscalPeriodIdEqual": 0,
  "postingPeriodControlIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFiscalVariantDto

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",
      "numberOfPostingPeriods": 0,
      "numberOfSpecialPeriods": 0,
      "isCalendarYear": true,
      "yearDependent": true,
      "companyId": 0,
      "fiscalPeriodId": 0,
      "postingPeriodControlId": 0
    }
  ],
  "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

Fiscal Variant - Detach Company To Fiscal Variant

HTTP Request

POST /api/v1/fiscal-variants/detach/company/{company_id}

Interactive Demo

📋 Description: Detaches a specified company from its associated fiscal variants within the financial organization structure, enabling the reconfiguration of the entity’s hierarchical relationships. This operation is essential for maintaining accurate organizational alignment and financial reporting.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organizational structure, used to detach a fiscal variant from the specified company.

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

Fiscal Variant - Attach Company To Fiscal Variant

HTTP Request

POST /api/v1/fiscal-variants/attach/company/{company_id}/{fiscal_variant_id}

Interactive Demo

📋 Description: Attaches a specified fiscal variant to a designated company within the financial organization structure, enabling the alignment of financial entities with their respective fiscal policies and regulations.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organizational structure, used to associate a fiscal variant with the specified company.
fiscal_variant_id	path	integer(int64)	true	Unique identifier for the fiscal variant being attached to the specified company within the financial organization structure.

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

Fiscal Variant - Find All

HTTP Request

GET /api/v1/fiscal-variants

Interactive Demo

📋 Description: Retrieves a list of fiscal variants within the financial organization structure, providing insights into the hierarchical configuration of financial entities.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFiscalVariantDto

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",
      "numberOfPostingPeriods": 0,
      "numberOfSpecialPeriods": 0,
      "isCalendarYear": true,
      "yearDependent": true,
      "companyId": 0,
      "fiscalPeriodId": 0,
      "postingPeriodControlId": 0
    }
  ],
  "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

Fiscal Variant - Create

HTTP Request

POST /api/v1/fiscal-variants

Interactive Demo

📋 Description: Creates a new fiscal variant within the financial organization structure, enabling the establishment of distinct financial entities and hierarchies for enhanced organizational management.

Parameters

Name	In	Type	Required	Description
body	body	FiscalVariantDto	true	Request body containing the financial variant details, including organizational structure and hierarchy information for the specified financial entity.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "numberOfPostingPeriods": 0,
  "numberOfSpecialPeriods": 0,
  "isCalendarYear": true,
  "yearDependent": true,
  "companyId": 0,
  "fiscalPeriodId": 0,
  "postingPeriodControlId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFiscalVariantDto

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",
    "numberOfPostingPeriods": 0,
    "numberOfSpecialPeriods": 0,
    "isCalendarYear": true,
    "yearDependent": true,
    "companyId": 0,
    "fiscalPeriodId": 0,
    "postingPeriodControlId": 0
  }
}

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

Fiscal Variant - Get Metadata

HTTP Request

GET /api/v1/fiscal-variants/meta

Interactive Demo

📋 Description: Retrieves metadata for fiscal variants 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

[
  "NUMBER_OF_POSTING_PERIODS"
]

Response Schema

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

Fiscal Variant - Get All By Fiscal Period

HTTP Request

GET /api/v1/fiscal-variants/fiscal-period/{fiscalPeriodId}

Interactive Demo

📋 Description: Retrieves the details of a specific fiscal period identified by the provided fiscalPeriodId within the financial organization structure, facilitating insights into the organization’s financial hierarchy and planning.

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 entities associated with the specified fiscal period.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFiscalVariantDto

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",
      "numberOfPostingPeriods": 0,
      "numberOfSpecialPeriods": 0,
      "isCalendarYear": true,
      "yearDependent": true,
      "companyId": 0,
      "fiscalPeriodId": 0,
      "postingPeriodControlId": 0
    }
  ],
  "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

Fiscal Variant - Find All By System ID

HTTP Request

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

Interactive Demo

📋 Description: Retrieves the fiscal 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 should be returned in a paginated format, facilitating efficient navigation through the financial organization structure associated with the specified ERP system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFiscalVariantDto

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",
      "numberOfPostingPeriods": 0,
      "numberOfSpecialPeriods": 0,
      "isCalendarYear": true,
      "yearDependent": true,
      "companyId": 0,
      "fiscalPeriodId": 0,
      "postingPeriodControlId": 0
    }
  ],
  "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

Fiscal Variant - Get All By Company

HTTP Request

GET /api/v1/fiscal-variants/company/{company_id}

Interactive Demo

📋 Description: Retrieves fiscal variants associated with a specified company, providing insights into the financial organization structure and hierarchy of the entity. This operation supports effective management and analysis of financial data within the organization.

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 specific fiscal variants associated with the company.
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure of the specified company.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFiscalVariantDto

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",
      "numberOfPostingPeriods": 0,
      "numberOfSpecialPeriods": 0,
      "isCalendarYear": true,
      "yearDependent": true,
      "companyId": 0,
      "fiscalPeriodId": 0,
      "postingPeriodControlId": 0
    }
  ],
  "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

---