Fiscal Period

Fiscal Period - Get

HTTP Request

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

Interactive Demo

📋 Description: Retrieves detailed information about a specific fiscal period within the financial organization structure, identified by the provided ID, to support effective financial planning and analysis.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFiscalPeriodDto

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",
    "year": 0,
    "month": 0,
    "day": 0,
    "postingPeriod": 0,
    "yearShift": 0,
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string"
  }
}

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

Fiscal Period - Update

HTTP Request

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

Interactive Demo

📋 Description: Updates the details of a specified fiscal period within the financial organization structure, allowing for adjustments to the hierarchy and configuration of financial entities. This operation ensures that fiscal periods remain aligned with organizational changes and financial reporting requirements.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	FiscalPeriodDto	true	Request body containing updated fiscal period details, including attributes such as start date, end date, and associated financial entity information, to reflect changes in the organization’s financial structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "year": 0,
  "month": 0,
  "day": 0,
  "postingPeriod": 0,
  "yearShift": 0,
  "fiscalVariantId": 0,
  "fiscalVariantDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFiscalPeriodDto

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",
    "year": 0,
    "month": 0,
    "day": 0,
    "postingPeriod": 0,
    "yearShift": 0,
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string"
  }
}

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

Fiscal Period - Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes a specified fiscal period from the financial organization structure, ensuring that the hierarchy and organizational integrity are maintained 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

Fiscal Period - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified fiscal period 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

Fiscal Period - Delete Or Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Removes multiple fiscal periods in bulk from the financial organization structure, streamlining the management of financial entities and ensuring accurate hierarchy representation.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of fiscal period identifiers to facilitate the bulk removal of financial periods within the organizational 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 Period - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified fiscal period within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or irrelevant fiscal periods are no longer considered in financial reporting and analysis.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFiscalPeriodDto

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",
    "year": 0,
    "month": 0,
    "day": 0,
    "postingPeriod": 0,
    "yearShift": 0,
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string"
  }
}

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

Fiscal Period - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Decommissions fiscal periods that were modified before the specified date, ensuring the financial organization structure remains accurate and up-to-date. This operation is essential for maintaining the integrity of the financial entity’s hierarchy.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning fiscal periods that were modified before the given date, ensuring alignment with the financial organization’s structure and hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFiscalPeriodDto

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",
      "year": 0,
      "month": 0,
      "day": 0,
      "postingPeriod": 0,
      "yearShift": 0,
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string"
    }
  ]
}

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

Fiscal Period - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Decommissions fiscal periods 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	ResponseListFiscalPeriodDto

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",
      "year": 0,
      "month": 0,
      "day": 0,
      "postingPeriod": 0,
      "yearShift": 0,
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string"
    }
  ]
}

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

Fiscal Period - Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Decommissions multiple fiscal periods in bulk, allowing financial organizations to efficiently manage their organizational structure and hierarchy by removing outdated or unnecessary fiscal entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers and associated details for bulk decommissioning of fiscal periods within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFiscalPeriodDto

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",
      "year": 0,
      "month": 0,
      "day": 0,
      "postingPeriod": 0,
      "yearShift": 0,
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string"
    }
  ]
}

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

Fiscal Period - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates multiple fiscal periods in bulk within the financial organization structure, ensuring alignment with the hierarchical framework of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	FiscalPeriodDto	true	Request body containing an array of fiscal period objects, each detailing the financial entity’s organization structure and hierarchy for bulk creation or update.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "year": 0,
    "month": 0,
    "day": 0,
    "postingPeriod": 0,
    "yearShift": 0,
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFiscalPeriodDto

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",
      "year": 0,
      "month": 0,
      "day": 0,
      "postingPeriod": 0,
      "yearShift": 0,
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string"
    }
  ]
}

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

Fiscal Period - Create Or Update

HTTP Request

PUT /api/v1/fiscal-periods/createOrUpdate

Interactive Demo

📋 Description: Creates or updates fiscal periods within the financial organization structure, enabling users to manage the hierarchy and organization of financial entities effectively.

Parameters

Name	In	Type	Required	Description
body	body	FiscalPeriodDto	true	Request body containing the financial entity details, including organization structure and hierarchy information, for creating or updating fiscal periods.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "year": 0,
  "month": 0,
  "day": 0,
  "postingPeriod": 0,
  "yearShift": 0,
  "fiscalVariantId": 0,
  "fiscalVariantDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFiscalPeriodDto

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",
    "year": 0,
    "month": 0,
    "day": 0,
    "postingPeriod": 0,
    "yearShift": 0,
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string"
  }
}

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

Fiscal Period - Bulk Update

HTTP Request

PUT /api/v1/fiscal-periods/bulk

Interactive Demo

📋 Description: Updates multiple fiscal periods in bulk within the financial organization structure, allowing for efficient management of financial entities and their hierarchical relationships.

Parameters

Name	In	Type	Required	Description
body	body	FiscalPeriodDto	true	Request body containing a bulk update of fiscal period data, including details on organization structure and hierarchy for financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "year": 0,
    "month": 0,
    "day": 0,
    "postingPeriod": 0,
    "yearShift": 0,
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFiscalPeriodDto

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",
      "year": 0,
      "month": 0,
      "day": 0,
      "postingPeriod": 0,
      "yearShift": 0,
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string"
    }
  ]
}

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

Fiscal Period - Bulk Create

HTTP Request

POST /api/v1/fiscal-periods/bulk

Interactive Demo

📋 Description: Creates multiple fiscal periods in bulk for a specified financial entity, enabling efficient management of the organization’s financial structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	FiscalPeriodDto	true	Request body containing an array of fiscal period definitions, including attributes such as start date, end date, and associated financial entity identifiers, to facilitate bulk creation within the organization’s financial structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "year": 0,
    "month": 0,
    "day": 0,
    "postingPeriod": 0,
    "yearShift": 0,
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFiscalPeriodDto

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",
      "year": 0,
      "month": 0,
      "day": 0,
      "postingPeriod": 0,
      "yearShift": 0,
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "string"
    }
  ]
}

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

Fiscal Period - Bulk Delete

HTTP Request

DELETE /api/v1/fiscal-periods/bulk

Interactive Demo

📋 Description: Deletes multiple fiscal periods in bulk from the financial organization structure, allowing for 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 period identifiers to be deleted in bulk, relevant for managing 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

Fiscal Period - Search

HTTP Request

POST /api/v1/fiscal-periods/search

Interactive Demo

📋 Description: Submits a request to search for fiscal periods 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	FiscalPeriodDtoFilter	false	Request body containing search criteria for fiscal periods, including parameters related 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",
  "yearLike": "string",
  "monthLike": "string",
  "dayLike": "string",
  "postingPeriodLike": "string",
  "yearShiftEqual": 0,
  "fiscalVariantIdEqual": 0,
  "fiscalVariantDisplayIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFiscalPeriodDto

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",
      "year": 0,
      "month": 0,
      "day": 0,
      "postingPeriod": 0,
      "yearShift": 0,
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "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

Fiscal Period - Detach Fiscal Variant

HTTP Request

POST /api/v1/fiscal-periods/detach/fiscal-variant/{fiscalVariantId}

Interactive Demo

📋 Description: Detaches a specified fiscal variant from the financial organization structure, allowing for adjustments in the hierarchy of financial entities. This operation ensures that the fiscal variant is no longer associated with the current fiscal periods, facilitating effective financial management.

Parameters

Name	In	Type	Required	Description
fiscalVariantId	path	integer(int64)	true	Unique identifier for the fiscal variant
body	body	FiscalPeriodDto	true	Request body containing the details necessary to detach a fiscal variant from the financial organization structure, including relevant identifiers and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "year": 0,
    "month": 0,
    "day": 0,
    "postingPeriod": 0,
    "yearShift": 0,
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string"
  }
]

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 Period - Attach Fiscal Variant

HTTP Request

POST /api/v1/fiscal-periods/attach/fiscal-variant/{relation_id}

Interactive Demo

📋 Description: Attaches a specified fiscal variant to a fiscal period within the financial organization structure, enabling the alignment of financial entities with their respective organizational hierarchies.

Parameters

Name	In	Type	Required	Description
relation_id	path	integer(int64)	true	Unique identifier for the fiscal variant being attached to the financial organization’s structure, facilitating the integration of hierarchical financial entities.
body	body	FiscalPeriodDto	true	Request body containing the fiscal variant details to be attached to the specified financial entity’s organizational structure, including relevant attributes and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "year": 0,
    "month": 0,
    "day": 0,
    "postingPeriod": 0,
    "yearShift": 0,
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string"
  }
]

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 Period - Find All

HTTP Request

GET /api/v1/fiscal-periods

Interactive Demo

📋 Description: Retrieves a list of fiscal periods within the financial organization structure, enabling users to understand the hierarchy and timeline of financial entities.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFiscalPeriodDto

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",
      "year": 0,
      "month": 0,
      "day": 0,
      "postingPeriod": 0,
      "yearShift": 0,
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "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

Fiscal Period - Create

HTTP Request

POST /api/v1/fiscal-periods

Interactive Demo

📋 Description: Creates a new fiscal period within the financial organization structure, enabling the establishment of timeframes for financial reporting and analysis within the organizational hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	FiscalPeriodDto	true	Request body containing the financial period details, including start and end dates, associated organization identifiers, and hierarchical structure information for effective fiscal management.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "year": 0,
  "month": 0,
  "day": 0,
  "postingPeriod": 0,
  "yearShift": 0,
  "fiscalVariantId": 0,
  "fiscalVariantDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFiscalPeriodDto

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",
    "year": 0,
    "month": 0,
    "day": 0,
    "postingPeriod": 0,
    "yearShift": 0,
    "fiscalVariantId": 0,
    "fiscalVariantDisplayId": "string"
  }
}

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

Fiscal Period - Get Metadata

HTTP Request

GET /api/v1/fiscal-periods/meta

Interactive Demo

📋 Description: Retrieves metadata for fiscal periods within the financial organization structure, providing essential information for understanding the hierarchy and organization of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "YEAR"
]

Response Schema

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

Fiscal Period - Get All By Fiscal Variant

HTTP Request

GET /api/v1/fiscal-periods/fiscal-variant/{fiscalVariantId}

Interactive Demo

📋 Description: Retrieves the fiscal periods associated with a specified fiscal variant, providing insight into the financial organization structure and hierarchy of the entity. This operation is essential for understanding the temporal framework within which financial activities are organized.

Parameters

Name	In	Type	Required	Description
fiscalVariantId	path	integer(int64)	true	Unique identifier for the fiscal variant
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient retrieval of fiscal periods within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFiscalPeriodDto

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",
      "year": 0,
      "month": 0,
      "day": 0,
      "postingPeriod": 0,
      "yearShift": 0,
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "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

Fiscal Period - Find All By System ID

HTTP Request

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

Interactive Demo

📋 Description: Retrieves fiscal periods associated with a specified ERP system, providing insights into the financial organization structure and hierarchy of the 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 retrieval of fiscal periods within the specified financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFiscalPeriodDto

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",
      "year": 0,
      "month": 0,
      "day": 0,
      "postingPeriod": 0,
      "yearShift": 0,
      "fiscalVariantId": 0,
      "fiscalVariantDisplayId": "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

---