Posting Period Control

Posting Period Control - Get

HTTP Request

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

Interactive Demo

📋 Description: Retrieves the details of a specific posting period control within the financial organization structure, identified by the provided ID, to facilitate effective management of financial entity hierarchies.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePostingPeriodControlDto

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",
    "generalLedgerAccountTarget": "ALL",
    "fromAccountNumber": "string",
    "toAccountNumber": "string",
    "fiscalPeriodStart": 0,
    "fiscalYearStart": 0,
    "fiscalPeriodEnd": 0,
    "fiscalYearEnd": 0,
    "postingPeriodVariantId": 0,
    "postingPeriodVariantDisplayId": "string"
  }
}

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

Posting Period Control - Update

HTTP Request

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

Interactive Demo

📋 Description: Updates the posting period control for a specified financial entity within the organizational structure, allowing for adjustments to the hierarchy and operational parameters. This operation ensures that the financial organization maintains accurate and up-to-date posting periods.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	PostingPeriodControlDto	true	Request body containing the updated posting period control data, 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",
  "generalLedgerAccountTarget": "ALL",
  "fromAccountNumber": "string",
  "toAccountNumber": "string",
  "fiscalPeriodStart": 0,
  "fiscalYearStart": 0,
  "fiscalPeriodEnd": 0,
  "fiscalYearEnd": 0,
  "postingPeriodVariantId": 0,
  "postingPeriodVariantDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePostingPeriodControlDto

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",
    "generalLedgerAccountTarget": "ALL",
    "fromAccountNumber": "string",
    "toAccountNumber": "string",
    "fiscalPeriodStart": 0,
    "fiscalYearStart": 0,
    "fiscalPeriodEnd": 0,
    "fiscalYearEnd": 0,
    "postingPeriodVariantId": 0,
    "postingPeriodVariantDisplayId": "string"
  }
}

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

Posting Period Control - Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes a specified posting period control within the financial organization structure, ensuring the integrity of the hierarchy and maintaining accurate 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

Posting Period Control - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified posting period control from the financial organization structure, ensuring that the hierarchy and organization of financial entities remain accurate and up-to-date.

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

Posting Period Control - Delete Or Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Removes multiple posting period controls in bulk from the financial organization structure, ensuring efficient 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 periods to be removed in bulk from the financial organization structure, ensuring streamlined management of the hierarchy within the financial entity.

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

Posting Period Control - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified posting period control within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or unnecessary controls are no longer utilized in financial processes.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePostingPeriodControlDto

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",
    "generalLedgerAccountTarget": "ALL",
    "fromAccountNumber": "string",
    "toAccountNumber": "string",
    "fiscalPeriodStart": 0,
    "fiscalYearStart": 0,
    "fiscalPeriodEnd": 0,
    "fiscalYearEnd": 0,
    "postingPeriodVariantId": 0,
    "postingPeriodVariantDisplayId": "string"
  }
}

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

Posting Period Control - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Decommissions posting period controls for financial entities that were modified before the specified date, ensuring the organization’s financial structure remains current and compliant. This operation is essential for maintaining an accurate hierarchy within the financial organization.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the date and time before which posting period controls will be decommissioned, facilitating the management of financial entity structures and hierarchies.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPostingPeriodControlDto

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",
      "generalLedgerAccountTarget": "ALL",
      "fromAccountNumber": "string",
      "toAccountNumber": "string",
      "fiscalPeriodStart": 0,
      "fiscalYearStart": 0,
      "fiscalPeriodEnd": 0,
      "fiscalYearEnd": 0,
      "postingPeriodVariantId": 0,
      "postingPeriodVariantDisplayId": "string"
    }
  ]
}

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

Posting Period Control - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Decommissions posting period controls 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 the hierarchy within financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPostingPeriodControlDto

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",
      "generalLedgerAccountTarget": "ALL",
      "fromAccountNumber": "string",
      "toAccountNumber": "string",
      "fiscalPeriodStart": 0,
      "fiscalYearStart": 0,
      "fiscalPeriodEnd": 0,
      "fiscalYearEnd": 0,
      "postingPeriodVariantId": 0,
      "postingPeriodVariantDisplayId": "string"
    }
  ]
}

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

Posting Period Control - Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Decommissions multiple posting period controls in bulk, allowing financial organizations to efficiently manage their structural hierarchy and streamline the organization of financial entities.

Parameters

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

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPostingPeriodControlDto

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",
      "generalLedgerAccountTarget": "ALL",
      "fromAccountNumber": "string",
      "toAccountNumber": "string",
      "fiscalPeriodStart": 0,
      "fiscalYearStart": 0,
      "fiscalPeriodEnd": 0,
      "fiscalYearEnd": 0,
      "postingPeriodVariantId": 0,
      "postingPeriodVariantDisplayId": "string"
    }
  ]
}

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

Posting Period Control - Create Or Update

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates posting period controls within the financial organization structure, ensuring accurate management of financial entities and their hierarchical relationships.

Parameters

Name	In	Type	Required	Description
body	body	PostingPeriodControlDto	true	Request body containing the financial entity’s posting period control data, including organizational hierarchy details and relevant metadata for creation or update.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "generalLedgerAccountTarget": "ALL",
  "fromAccountNumber": "string",
  "toAccountNumber": "string",
  "fiscalPeriodStart": 0,
  "fiscalYearStart": 0,
  "fiscalPeriodEnd": 0,
  "fiscalYearEnd": 0,
  "postingPeriodVariantId": 0,
  "postingPeriodVariantDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePostingPeriodControlDto

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",
    "generalLedgerAccountTarget": "ALL",
    "fromAccountNumber": "string",
    "toAccountNumber": "string",
    "fiscalPeriodStart": 0,
    "fiscalYearStart": 0,
    "fiscalPeriodEnd": 0,
    "fiscalYearEnd": 0,
    "postingPeriodVariantId": 0,
    "postingPeriodVariantDisplayId": "string"
  }
}

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

Posting Period Control - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates multiple posting period controls within the financial organization structure, ensuring accurate hierarchy management for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PostingPeriodControlDto	true	Request body containing bulk data for creating or updating posting period controls, including financial entity identifiers and hierarchical structure details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "generalLedgerAccountTarget": "ALL",
    "fromAccountNumber": "string",
    "toAccountNumber": "string",
    "fiscalPeriodStart": 0,
    "fiscalYearStart": 0,
    "fiscalPeriodEnd": 0,
    "fiscalYearEnd": 0,
    "postingPeriodVariantId": 0,
    "postingPeriodVariantDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPostingPeriodControlDto

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",
      "generalLedgerAccountTarget": "ALL",
      "fromAccountNumber": "string",
      "toAccountNumber": "string",
      "fiscalPeriodStart": 0,
      "fiscalYearStart": 0,
      "fiscalPeriodEnd": 0,
      "fiscalYearEnd": 0,
      "postingPeriodVariantId": 0,
      "postingPeriodVariantDisplayId": "string"
    }
  ]
}

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

Posting Period Control - Bulk Update

HTTP Request

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

Interactive Demo

📋 Description: Updates multiple posting period controls within the financial organization structure, enabling efficient management of hierarchical financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PostingPeriodControlDto	true	Request body containing bulk updates for posting period controls, including details on organization structure and financial entity hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "generalLedgerAccountTarget": "ALL",
    "fromAccountNumber": "string",
    "toAccountNumber": "string",
    "fiscalPeriodStart": 0,
    "fiscalYearStart": 0,
    "fiscalPeriodEnd": 0,
    "fiscalYearEnd": 0,
    "postingPeriodVariantId": 0,
    "postingPeriodVariantDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPostingPeriodControlDto

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",
      "generalLedgerAccountTarget": "ALL",
      "fromAccountNumber": "string",
      "toAccountNumber": "string",
      "fiscalPeriodStart": 0,
      "fiscalYearStart": 0,
      "fiscalPeriodEnd": 0,
      "fiscalYearEnd": 0,
      "postingPeriodVariantId": 0,
      "postingPeriodVariantDisplayId": "string"
    }
  ]
}

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

Posting Period Control - Bulk Create

HTTP Request

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

Interactive Demo

📋 Description: Submits a bulk update of posting period controls for financial entities within the organizational structure, enabling efficient management of hierarchical financial data.

Parameters

Name	In	Type	Required	Description
body	body	PostingPeriodControlDto	true	Request body containing an array of posting period control records, including details necessary for managing the financial organization structure and hierarchy of the specified financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "generalLedgerAccountTarget": "ALL",
    "fromAccountNumber": "string",
    "toAccountNumber": "string",
    "fiscalPeriodStart": 0,
    "fiscalYearStart": 0,
    "fiscalPeriodEnd": 0,
    "fiscalYearEnd": 0,
    "postingPeriodVariantId": 0,
    "postingPeriodVariantDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPostingPeriodControlDto

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",
      "generalLedgerAccountTarget": "ALL",
      "fromAccountNumber": "string",
      "toAccountNumber": "string",
      "fiscalPeriodStart": 0,
      "fiscalYearStart": 0,
      "fiscalPeriodEnd": 0,
      "fiscalYearEnd": 0,
      "postingPeriodVariantId": 0,
      "postingPeriodVariantDisplayId": "string"
    }
  ]
}

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

Posting Period Control - Bulk Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes multiple posting period controls within the financial organization structure, allowing for efficient management of financial entity hierarchies.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of identifiers for the posting period controls to be deleted, relevant to 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

Posting Period Control - Find All

HTTP Request

GET /api/v1/posting-period-controls

Interactive Demo

📋 Description: Retrieves the posting period controls for financial entities within the organizational structure, enabling users to manage and understand the hierarchy of financial operations effectively.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePostingPeriodControlDto

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",
      "generalLedgerAccountTarget": "ALL",
      "fromAccountNumber": "string",
      "toAccountNumber": "string",
      "fiscalPeriodStart": 0,
      "fiscalYearStart": 0,
      "fiscalPeriodEnd": 0,
      "fiscalYearEnd": 0,
      "postingPeriodVariantId": 0,
      "postingPeriodVariantDisplayId": "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

Posting Period Control - Create

HTTP Request

POST /api/v1/posting-period-controls

Interactive Demo

📋 Description: Creates a new posting period control within the financial organization structure, enabling the management of hierarchical posting periods for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PostingPeriodControlDto	true	Request body containing the posting period control data, including details on the financial entity’s organization structure and hierarchy.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "generalLedgerAccountTarget": "ALL",
  "fromAccountNumber": "string",
  "toAccountNumber": "string",
  "fiscalPeriodStart": 0,
  "fiscalYearStart": 0,
  "fiscalPeriodEnd": 0,
  "fiscalYearEnd": 0,
  "postingPeriodVariantId": 0,
  "postingPeriodVariantDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePostingPeriodControlDto

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",
    "generalLedgerAccountTarget": "ALL",
    "fromAccountNumber": "string",
    "toAccountNumber": "string",
    "fiscalPeriodStart": 0,
    "fiscalYearStart": 0,
    "fiscalPeriodEnd": 0,
    "fiscalYearEnd": 0,
    "postingPeriodVariantId": 0,
    "postingPeriodVariantDisplayId": "string"
  }
}

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

Posting Period Control - Search

HTTP Request

POST /api/v1/posting-period-controls/search

Interactive Demo

📋 Description: Submits a search request for posting period controls within the financial organization structure, enabling users to efficiently locate and manage hierarchical financial entity data.

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	PostingPeriodControlDtoFilter	false	Request body containing search criteria and filters for retrieving posting period control data within the financial organization structure.

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",
  "generalLedgerAccountTargetIn": [
    "ALL"
  ],
  "fromAccountNumberEqual": "string",
  "toAccountNumberEqual": "string",
  "fiscalPeriodStartLike": "string",
  "fiscalYearStartLike": "string",
  "fiscalPeriodEndLike": "string",
  "fiscalYearEndLike": "string",
  "postingPeriodVariantIdEqual": 0,
  "postingPeriodVariantDisplayIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePostingPeriodControlDto

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",
      "generalLedgerAccountTarget": "ALL",
      "fromAccountNumber": "string",
      "toAccountNumber": "string",
      "fiscalPeriodStart": 0,
      "fiscalYearStart": 0,
      "fiscalPeriodEnd": 0,
      "fiscalYearEnd": 0,
      "postingPeriodVariantId": 0,
      "postingPeriodVariantDisplayId": "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

Posting Period Control - Detach Posting Period Variant From Posting Period Controls

HTTP Request

POST /api/v1/posting-period-controls/detach/posting-period-variant/{postingPeriodVariantId}

Interactive Demo

📋 Description: Detaches a specified posting period variant from the financial organization structure, allowing for adjustments in the hierarchy and organization of financial entities. This operation ensures that the posting period variant is no longer associated with the current posting period controls.

Parameters

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

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "generalLedgerAccountTarget": "ALL",
    "fromAccountNumber": "string",
    "toAccountNumber": "string",
    "fiscalPeriodStart": 0,
    "fiscalYearStart": 0,
    "fiscalPeriodEnd": 0,
    "fiscalYearEnd": 0,
    "postingPeriodVariantId": 0,
    "postingPeriodVariantDisplayId": "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

Posting Period Control - Attach Posting Period Variant To Posting Period Controls

HTTP Request

POST /api/v1/posting-period-controls/attach/posting-period-variant/{postingPeriodVariantId}

Interactive Demo

📋 Description: Attaches a specified posting period variant to the financial organization structure, facilitating the alignment of financial entities within the established hierarchy.

Parameters

Name	In	Type	Required	Description
postingPeriodVariantId	path	integer(int64)	true	Unique identifier for the posting period variant
body	body	PostingPeriodControlDto	true	Request body containing the details of the posting period variant to be attached, including relevant financial entity identifiers and organizational hierarchy information.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "generalLedgerAccountTarget": "ALL",
    "fromAccountNumber": "string",
    "toAccountNumber": "string",
    "fiscalPeriodStart": 0,
    "fiscalYearStart": 0,
    "fiscalPeriodEnd": 0,
    "fiscalYearEnd": 0,
    "postingPeriodVariantId": 0,
    "postingPeriodVariantDisplayId": "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

Posting Period Control - Get Metadata

HTTP Request

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

Interactive Demo

📋 Description: Retrieves metadata related to posting period controls 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

[
  "GENERAL_LEDGER_ACCOUNT_TARGET"
]

Response Schema

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

Posting Period Control - Get All By Posting Period Variant

HTTP Request

GET /api/v1/posting-period-controls/fiscal-variant/{postingPeriodVariantId}

Interactive Demo

📋 Description: Retrieves the details of a specific fiscal variant within the financial organization structure, identified by the postingPeriodVariantId, to facilitate effective management of organizational hierarchies and financial entities.

Parameters

Name	In	Type	Required	Description
postingPeriodVariantId	path	integer(int64)	true	Unique identifier for the posting period variant
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure data associated with the specified posting period variant.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePostingPeriodControlDto

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",
      "generalLedgerAccountTarget": "ALL",
      "fromAccountNumber": "string",
      "toAccountNumber": "string",
      "fiscalPeriodStart": 0,
      "fiscalYearStart": 0,
      "fiscalPeriodEnd": 0,
      "fiscalYearEnd": 0,
      "postingPeriodVariantId": 0,
      "postingPeriodVariantDisplayId": "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

Posting Period Control - Find All By System ID

HTTP Request

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

Interactive Demo

📋 Description: Retrieves posting period control details for a specified ERP system, enabling organizations to manage their financial entity structures and hierarchies effectively.

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePostingPeriodControlDto

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",
      "generalLedgerAccountTarget": "ALL",
      "fromAccountNumber": "string",
      "toAccountNumber": "string",
      "fiscalPeriodStart": 0,
      "fiscalYearStart": 0,
      "fiscalPeriodEnd": 0,
      "fiscalYearEnd": 0,
      "postingPeriodVariantId": 0,
      "postingPeriodVariantDisplayId": "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

---