End Of Term Mapping

Get A Resource By ID

HTTP Request

GET /api/v1/end-of-term-mappings/{id}

📋 Description: Retrieves the end-of-term mapping details for a specified financial entity within the organizational structure, providing insights into the hierarchy and relationships pertinent to 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

ResponseEndOfTermMappingDto

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    "rowNumber": 0,
17    "rowIdentifier": "string",
18    "errors": [
19      "string"
20    ],
21    "linkedErrors": [
22      "string"
23    ],
24    "warnings": [
25      "string"
26    ],
27    "remarks": [
28      "string"
29    ],
30    "skipMessage": "string",
31    "determinationId": 0,
32    "determinationDisplayId": "string",
33    "internalNoticePeriod": 0
34  }
35}

Update A Resource

HTTP Request

PUT /api/v1/end-of-term-mappings/{id}

📋 Description: Updates the end-of-term mapping for a specified financial entity within the organizational structure, allowing for adjustments to the hierarchy as necessary. This operation ensures that the financial organization reflects the most current mapping configurations.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

EndOfTermMappingDto

true

Request body containing the updated end-of-term mapping details, including organization hierarchy and financial entity attributes, for the specified identifier.

Body Parameters

 1{
 2  "id": 0,
 3  "rowNumber": 0,
 4  "rowIdentifier": "string",
 5  "errors": [
 6    "string"
 7  ],
 8  "linkedErrors": [
 9    "string"
10  ],
11  "warnings": [
12    "string"
13  ],
14  "remarks": [
15    "string"
16  ],
17  "skipMessage": "string",
18  "determinationId": 0,
19  "determinationDisplayId": "string",
20  "internalNoticePeriod": 0
21}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseEndOfTermMappingDto

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    "rowNumber": 0,
17    "rowIdentifier": "string",
18    "errors": [
19      "string"
20    ],
21    "linkedErrors": [
22      "string"
23    ],
24    "warnings": [
25      "string"
26    ],
27    "remarks": [
28      "string"
29    ],
30    "skipMessage": "string",
31    "determinationId": 0,
32    "determinationDisplayId": "string",
33    "internalNoticePeriod": 0
34  }
35}

Delete

HTTP Request

DELETE /api/v1/end-of-term-mappings/{id}

📋 Description: Deletes a specified end-of-term mapping within the financial organization structure, ensuring the integrity of the hierarchy and organization of financial entities.

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

 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}

Bulk Create-Or-Update Resources

HTTP Request

PUT /api/v1/end-of-term-mappings/createOrUpdate/bulk

📋 Description: Updates or creates multiple end-of-term mappings within the financial organization structure, enabling efficient management of organizational hierarchy for financial entities.

Parameters

Name

In

Type

Required

Description

body

body

EndOfTermMappingDto

true

Request body containing bulk data for creating or updating end-of-term mappings within the financial organization structure, including details on organizational hierarchy and financial entity relationships.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "rowNumber": 0,
 5    "rowIdentifier": "string",
 6    "errors": [
 7      "string"
 8    ],
 9    "linkedErrors": [
10      "string"
11    ],
12    "warnings": [
13      "string"
14    ],
15    "remarks": [
16      "string"
17    ],
18    "skipMessage": "string",
19    "determinationId": 0,
20    "determinationDisplayId": "string",
21    "internalNoticePeriod": 0
22  }
23]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListEndOfTermMappingDto

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      "rowNumber": 0,
18      "rowIdentifier": "string",
19      "errors": [
20        "string"
21      ],
22      "linkedErrors": [
23        "string"
24      ],
25      "warnings": [
26        "string"
27      ],
28      "remarks": [
29        "string"
30      ],
31      "skipMessage": "string",
32      "determinationId": 0,
33      "determinationDisplayId": "string",
34      "internalNoticePeriod": 0
35    }
36  ]
37}

Create Or Update A Resource

HTTP Request

PUT /api/v1/end-of-term-mappings/createOrUpdate

📋 Description: Creates or updates end-of-term mappings within the financial organization structure, ensuring accurate representation of organizational hierarchy for financial entities.

Parameters

Name

In

Type

Required

Description

body

body

EndOfTermMappingDto

true

Request body containing the financial entity mapping data, including organization hierarchy details for creating or updating end-of-term mappings.

Body Parameters

 1{
 2  "id": 0,
 3  "rowNumber": 0,
 4  "rowIdentifier": "string",
 5  "errors": [
 6    "string"
 7  ],
 8  "linkedErrors": [
 9    "string"
10  ],
11  "warnings": [
12    "string"
13  ],
14  "remarks": [
15    "string"
16  ],
17  "skipMessage": "string",
18  "determinationId": 0,
19  "determinationDisplayId": "string",
20  "internalNoticePeriod": 0
21}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseEndOfTermMappingDto

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    "rowNumber": 0,
17    "rowIdentifier": "string",
18    "errors": [
19      "string"
20    ],
21    "linkedErrors": [
22      "string"
23    ],
24    "warnings": [
25      "string"
26    ],
27    "remarks": [
28      "string"
29    ],
30    "skipMessage": "string",
31    "determinationId": 0,
32    "determinationDisplayId": "string",
33    "internalNoticePeriod": 0
34  }
35}

Bulk-Update Resources

HTTP Request

PUT /api/v1/end-of-term-mappings/bulk

📋 Description: Updates multiple end-of-term mappings within the financial organization structure, allowing for efficient management of hierarchical relationships among financial entities.

Parameters

Name

In

Type

Required

Description

body

body

EndOfTermMappingDto

true

Request body containing a bulk set of end-of-term mapping data for financial entities, including hierarchical relationships and organizational structure details.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "rowNumber": 0,
 5    "rowIdentifier": "string",
 6    "errors": [
 7      "string"
 8    ],
 9    "linkedErrors": [
10      "string"
11    ],
12    "warnings": [
13      "string"
14    ],
15    "remarks": [
16      "string"
17    ],
18    "skipMessage": "string",
19    "determinationId": 0,
20    "determinationDisplayId": "string",
21    "internalNoticePeriod": 0
22  }
23]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListEndOfTermMappingDto

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      "rowNumber": 0,
18      "rowIdentifier": "string",
19      "errors": [
20        "string"
21      ],
22      "linkedErrors": [
23        "string"
24      ],
25      "warnings": [
26        "string"
27      ],
28      "remarks": [
29        "string"
30      ],
31      "skipMessage": "string",
32      "determinationId": 0,
33      "determinationDisplayId": "string",
34      "internalNoticePeriod": 0
35    }
36  ]
37}

Bulk Create

HTTP Request

POST /api/v1/end-of-term-mappings/bulk

📋 Description: Submits bulk end-of-term mappings to establish or update the financial organization structure and hierarchy for multiple financial entities simultaneously.

Parameters

Name

In

Type

Required

Description

body

body

EndOfTermMappingDto

true

Request body containing a bulk list of end-of-term mappings for financial entities, detailing their organizational structure and hierarchy.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "rowNumber": 0,
 5    "rowIdentifier": "string",
 6    "errors": [
 7      "string"
 8    ],
 9    "linkedErrors": [
10      "string"
11    ],
12    "warnings": [
13      "string"
14    ],
15    "remarks": [
16      "string"
17    ],
18    "skipMessage": "string",
19    "determinationId": 0,
20    "determinationDisplayId": "string",
21    "internalNoticePeriod": 0
22  }
23]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListEndOfTermMappingDto

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      "rowNumber": 0,
18      "rowIdentifier": "string",
19      "errors": [
20        "string"
21      ],
22      "linkedErrors": [
23        "string"
24      ],
25      "warnings": [
26        "string"
27      ],
28      "remarks": [
29        "string"
30      ],
31      "skipMessage": "string",
32      "determinationId": 0,
33      "determinationDisplayId": "string",
34      "internalNoticePeriod": 0
35    }
36  ]
37}

Bulk Delete

HTTP Request

DELETE /api/v1/end-of-term-mappings/bulk

📋 Description: Deletes multiple end-of-term mappings in the financial organization structure, allowing for efficient management of organizational hierarchies and financial entities.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of financial entity identifiers for bulk deletion of end-of-term mappings within the organizational structure.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

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}

Search Resources

HTTP Request

POST /api/v1/end-of-term-mappings/search

📋 Description: Submits a search request for end-of-term mappings within the financial organization structure, allowing users to identify and analyze the hierarchical relationships of 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

EndOfTermMappingDtoFilter

false

Request body containing search criteria for end-of-term mappings, including relevant organizational structure and hierarchy details for financial entities.

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

 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  "determinationIdEqual": 0,
16  "determinationDisplayIdLike": "string",
17  "internalNoticePeriodEqual": 0
18}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageEndOfTermMappingDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": 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      "rowNumber": 0,
22      "rowIdentifier": "string",
23      "errors": [
24        "string"
25      ],
26      "linkedErrors": [
27        "string"
28      ],
29      "warnings": [
30        "string"
31      ],
32      "remarks": [
33        "string"
34      ],
35      "skipMessage": "string",
36      "determinationId": 0,
37      "determinationDisplayId": "string",
38      "internalNoticePeriod": 0
39    }
40  ],
41  "number": 0,
42  "sort": {
43    "unsorted": true,
44    "sorted": true,
45    "empty": true
46  },
47  "first": true,
48  "last": true,
49  "empty": true
50}

List All Resources

HTTP Request

GET /api/v1/end-of-term-mappings

📋 Description: Retrieves end-of-term mappings for financial entities within the organization’s structure, providing insights into the hierarchy and relationships among financial components.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure’s end-of-term mappings.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageEndOfTermMappingDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": 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      "rowNumber": 0,
22      "rowIdentifier": "string",
23      "errors": [
24        "string"
25      ],
26      "linkedErrors": [
27        "string"
28      ],
29      "warnings": [
30        "string"
31      ],
32      "remarks": [
33        "string"
34      ],
35      "skipMessage": "string",
36      "determinationId": 0,
37      "determinationDisplayId": "string",
38      "internalNoticePeriod": 0
39    }
40  ],
41  "number": 0,
42  "sort": {
43    "unsorted": true,
44    "sorted": true,
45    "empty": true
46  },
47  "first": true,
48  "last": true,
49  "empty": true
50}

Create

HTTP Request

POST /api/v1/end-of-term-mappings

📋 Description: Creates new end-of-term mappings within the financial organization structure, enabling the alignment of organizational hierarchies and financial entities for enhanced reporting and analysis.

Parameters

Name

In

Type

Required

Description

body

body

EndOfTermMappingDto

true

Request body containing the end-of-term mapping data, including organizational hierarchy and financial entity details, essential for structuring financial organization transitions.

Body Parameters

 1{
 2  "id": 0,
 3  "rowNumber": 0,
 4  "rowIdentifier": "string",
 5  "errors": [
 6    "string"
 7  ],
 8  "linkedErrors": [
 9    "string"
10  ],
11  "warnings": [
12    "string"
13  ],
14  "remarks": [
15    "string"
16  ],
17  "skipMessage": "string",
18  "determinationId": 0,
19  "determinationDisplayId": "string",
20  "internalNoticePeriod": 0
21}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseEndOfTermMappingDto

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    "rowNumber": 0,
17    "rowIdentifier": "string",
18    "errors": [
19      "string"
20    ],
21    "linkedErrors": [
22      "string"
23    ],
24    "warnings": [
25      "string"
26    ],
27    "remarks": [
28      "string"
29    ],
30    "skipMessage": "string",
31    "determinationId": 0,
32    "determinationDisplayId": "string",
33    "internalNoticePeriod": 0
34  }
35}

Get Meta Data

HTTP Request

GET /api/v1/end-of-term-mappings/meta

📋 Description: Retrieves metadata related to end-of-term mappings within the financial organization structure, providing insights into the hierarchy and relationships of financial entities.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "INTERNAL_NOTICE_PERIOD"
3]

Response Schema