Posting Period VariantΒΆ
Posting Period Variant - GetΒΆ
HTTP Request
GET /api/v1/posting-period-variants/{id}
π Description: Retrieves the details of a specific posting period variant identified by the provided ID, facilitating insights into the financial organization structure and hierarchy of the associated financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "value": "string",
21 "companyId": 0,
22 "postingPeriodControlId": 0
23 }
24}
Posting Period Variant - UpdateΒΆ
HTTP Request
PUT /api/v1/posting-period-variants/{id}
π Description: Updates the details of a specific posting period variant within the financial organization structure, allowing for modifications to align with organizational hierarchy and entity requirements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated posting period variant details, including attributes that define the financial entityβs organizational structure and hierarchy. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "value": "string",
8 "companyId": 0,
9 "postingPeriodControlId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "value": "string",
21 "companyId": 0,
22 "postingPeriodControlId": 0
23 }
24}
Posting Period Variant - DeleteΒΆ
HTTP Request
DELETE /api/v1/posting-period-variants/{id}
π Description: Deletes a specified posting period variant from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Posting Period Variant - Delete Or DecommissionΒΆ
HTTP Request
PUT /api/v1/posting-period-variants/remove/{id}
π Description: Removes a specified posting period variant from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Posting Period Variant - Delete Or Decommission AllΒΆ
HTTP Request
PUT /api/v1/posting-period-variants/remove/bulk
π Description: Removes multiple posting period variants in bulk from the financial organization structure, streamlining the management of financial entities within the hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of identifiers for the posting period variants to be removed in bulk, facilitating updates to the financial organization structure. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Posting Period Variant - DecommissionΒΆ
HTTP Request
PUT /api/v1/posting-period-variants/decommission/{id}
π Description: Decommissions a specified posting period variant within the financial organization structure, effectively removing it from active use in the hierarchy of financial entities. This operation ensures the integrity and accuracy of the organizational structure by managing obsolete posting periods.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "value": "string",
21 "companyId": 0,
22 "postingPeriodControlId": 0
23 }
24}
Posting Period Variant - Decommission By Modification Date BeforeΒΆ
HTTP Request
PUT /api/v1/posting-period-variants/decommission/modified-before/{modified_before}
π Description: Decommissions posting period variants in the financial organization structure that were modified before the specified date, ensuring the integrity and relevance of the entityβs hierarchical data. This operation helps maintain an organized and efficient financial entity framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
modified_before |
path |
string(date-time) |
true |
Specifies the cutoff date for decommissioning posting period variants within the financial organization structure, ensuring that only those modified before this date are affected. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "value": "string",
22 "companyId": 0,
23 "postingPeriodControlId": 0
24 }
25 ]
26}
Posting Period Variant - Decommission Before NowΒΆ
HTTP Request
PUT /api/v1/posting-period-variants/decommission/modified-before-now
π Description: Decommissions posting period variants that were modified before the current date, ensuring the financial organization structure remains accurate and up-to-date. This operation is essential for maintaining the integrity of financial entity hierarchies within the system.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "value": "string",
22 "companyId": 0,
23 "postingPeriodControlId": 0
24 }
25 ]
26}
Posting Period Variant - Decommission AllΒΆ
HTTP Request
PUT /api/v1/posting-period-variants/decommission/bulk
π Description: Decommissions multiple posting period variants in bulk, effectively managing the financial organization structure and hierarchy within the financial entity. This operation ensures streamlined updates to the organizational framework by removing obsolete posting periods.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a list of posting period variants to be decommissioned in bulk, reflecting changes in the financial organization structure and hierarchy. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "value": "string",
22 "companyId": 0,
23 "postingPeriodControlId": 0
24 }
25 ]
26}
Posting Period Variant - Create Or Update BulkΒΆ
HTTP Request
PUT /api/v1/posting-period-variants/createOrUpdate/bulk
π Description: Creates or updates multiple posting period variants in bulk for a financial organization, ensuring accurate alignment within the organizational structure and hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk data for creating or updating posting period variants within the financial organization structure, including relevant identifiers and attributes for each financial entity. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "value": "string",
9 "companyId": 0,
10 "postingPeriodControlId": 0
11 }
12]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "value": "string",
22 "companyId": 0,
23 "postingPeriodControlId": 0
24 }
25 ]
26}
Posting Period Variant - Create Or UpdateΒΆ
HTTP Request
PUT /api/v1/posting-period-variants/createOrUpdate
π Description: Creates or updates posting period variants within the financial organization structure, ensuring accurate representation of the hierarchy and financial entity configurations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial entityβs posting period variant data, including details necessary for creating or updating organizational structure and hierarchy. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "value": "string",
8 "companyId": 0,
9 "postingPeriodControlId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "value": "string",
21 "companyId": 0,
22 "postingPeriodControlId": 0
23 }
24}
Posting Period Variant - Bulk UpdateΒΆ
HTTP Request
PUT /api/v1/posting-period-variants/bulk
π Description: Updates multiple posting period variants in bulk within the financial organization structure, allowing for efficient management of hierarchical financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of posting period variant data, including attributes for financial entities within the organizational structure and hierarchy. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "value": "string",
9 "companyId": 0,
10 "postingPeriodControlId": 0
11 }
12]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "value": "string",
22 "companyId": 0,
23 "postingPeriodControlId": 0
24 }
25 ]
26}
Posting Period Variant - Bulk CreateΒΆ
HTTP Request
POST /api/v1/posting-period-variants/bulk
π Description: Creates multiple posting period variants in bulk for a financial entity, enabling efficient updates to the organizationβs financial structure and hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of posting period variant objects, each detailing the financial entityβs organizational structure and hierarchy for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "value": "string",
9 "companyId": 0,
10 "postingPeriodControlId": 0
11 }
12]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "value": "string",
22 "companyId": 0,
23 "postingPeriodControlId": 0
24 }
25 ]
26}
Posting Period Variant - Bulk DeleteΒΆ
HTTP Request
DELETE /api/v1/posting-period-variants/bulk
π Description: Deletes multiple posting period variants within the financial organization structure, allowing for streamlined management of hierarchical financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a list of posting period variant identifiers to be deleted, relevant for managing the financial organization structure and hierarchy. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Posting Period Variant - SearchΒΆ
HTTP Request
POST /api/v1/posting-period-variants/search
π Description: Searches for posting period variants 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 |
false |
Request body containing search criteria for posting period variants within the financial organization structure, including relevant identifiers and parameters to facilitate hierarchical data retrieval. |
Default ValuesΒΆ
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter ConstraintsΒΆ
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "statusEqual": "CREATED",
16 "statusIn": [
17 "CREATED"
18 ],
19 "displayIdIn": [
20 "string"
21 ],
22 "displayIdLike": "string",
23 "erpSystemIdEqual": 0,
24 "erpSystemIdIn": [
25 0
26 ],
27 "erpSystemDisplayIdLike": "string",
28 "uiSelector": "string",
29 "valueLike": "string",
30 "companyIdEqual": 0,
31 "postingPeriodControlIdEqual": 0
32}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "value": "string",
26 "companyId": 0,
27 "postingPeriodControlId": 0
28 }
29 ],
30 "number": 0,
31 "sort": {
32 "unsorted": true,
33 "sorted": true,
34 "empty": true
35 },
36 "first": true,
37 "last": true,
38 "empty": true
39}
Posting Period Variant - Find AllΒΆ
HTTP Request
GET /api/v1/posting-period-variants
π Description: Retrieves a list of posting period variants within the financial organization structure, enabling users to understand the hierarchy and organization of financial entities. This operation supports efficient management and analysis of financial reporting periods.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the response should be paginated, facilitating efficient retrieval of posting period variants within the financial organization structure. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "value": "string",
26 "companyId": 0,
27 "postingPeriodControlId": 0
28 }
29 ],
30 "number": 0,
31 "sort": {
32 "unsorted": true,
33 "sorted": true,
34 "empty": true
35 },
36 "first": true,
37 "last": true,
38 "empty": true
39}
Posting Period Variant - CreateΒΆ
HTTP Request
POST /api/v1/posting-period-variants
π Description: Creates a new posting period variant within the financial organization structure, allowing for the effective management of hierarchical financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the posting period variant data, including details on the financial entityβs organizational structure and hierarchy. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "value": "string",
8 "companyId": 0,
9 "postingPeriodControlId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "value": "string",
21 "companyId": 0,
22 "postingPeriodControlId": 0
23 }
24}
Posting Period Variant - Get All By Posting Period ControlΒΆ
HTTP Request
GET /api/v1/posting-period-variants/posting-period-control/{fiscalPeriodId}
π Description: Retrieves the posting period control details for a specified fiscal period within the financial organization structure, enabling users to manage and analyze fiscal timelines effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
fiscalPeriodId |
path |
integer(int64) |
true |
Unique identifier for the fiscal period |
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure related to the specified fiscal period. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "value": "string",
26 "companyId": 0,
27 "postingPeriodControlId": 0
28 }
29 ],
30 "number": 0,
31 "sort": {
32 "unsorted": true,
33 "sorted": true,
34 "empty": true
35 },
36 "first": true,
37 "last": true,
38 "empty": true
39}
Posting Period Variant - Get MetadataΒΆ
HTTP Request
GET /api/v1/posting-period-variants/meta
π Description: Retrieves metadata for posting period variants within the financial organization structure, providing insights into the hierarchy and organization of financial entities. This operation supports efficient navigation and understanding of the posting periods relevant to financial reporting.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "VALUE"
3]
Response Schema
Posting Period Variant - Find All By System IDΒΆ
HTTP Request
GET /api/v1/posting-period-variants/erp-system/{systemId}
π Description: Retrieves posting period variants for a specified ERP system, enabling organizations to effectively manage their financial entity structures and hierarchies.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
systemId |
path |
integer(int64) |
true |
Unique identifier for the system |
pageable |
query |
true |
Indicates whether the results of the posting period variants for the specified ERP system should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "value": "string",
26 "companyId": 0,
27 "postingPeriodControlId": 0
28 }
29 ],
30 "number": 0,
31 "sort": {
32 "unsorted": true,
33 "sorted": true,
34 "empty": true
35 },
36 "first": true,
37 "last": true,
38 "empty": true
39}
Posting Period Variant - Get All By CompanyΒΆ
HTTP Request
GET /api/v1/posting-period-variants/company/{company_id}
π Description: Retrieves posting period variants for a specified financial organization, allowing users to understand the hierarchical structure and organization of financial entities within the company.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
company_id |
path |
integer(int64) |
true |
Unique identifier for the financial entity within the organizational structure, used to retrieve posting period variants specific to the specified company. |
pageable |
query |
true |
Indicates whether the results of the posting period variants for the specified company should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "value": "string",
26 "companyId": 0,
27 "postingPeriodControlId": 0
28 }
29 ],
30 "number": 0,
31 "sort": {
32 "unsorted": true,
33 "sorted": true,
34 "empty": true
35 },
36 "first": true,
37 "last": true,
38 "empty": true
39}