Mass Modification Task Report

Get Mass Modification Report By ID

HTTP Request

GET /api/v1/batch/mass-modification/reports/{id}

📋 Description: Retrieves the detailed report for a specific mass modification operation identified by the provided ID, facilitating insights into lease and contract adjustments within the Nakisa Lease Accounting Suite. This operation supports effective management of financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved mass modification task report

ResponseMassModificationTaskReportDto

400

Bad Request

Invalid ID supplied

None

404

Not Found

Mass modification task report not found

None

500

Internal Server Error

Internal server error

None

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": {
11    "id": 10000001,
12    "scheduledItemCount": 100,
13    "processingItemCount": 25,
14    "doneItemCount": 60,
15    "failedItemCount": 5,
16    "cancelledItemCount": 3,
17    "skippedItemCount": 7,
18    "totalItemCount": 100,
19    "taskId": 20000001,
20    "modificationType": {
21      "name": "LEASE_COMPONENT_MODIFICATION",
22      "captionKey": "enum.modificationType.leaseComponentModification",
23      "caption": "Lease Component Modification"
24    },
25    "objectType": {
26      "name": "CONTRACT",
27      "captionKey": "enum.objectType.contract",
28      "caption": "Contract"
29    }
30  }
31}

Update Mass Modification Report

HTTP Request

PUT /api/v1/batch/mass-modification/reports/{id}

📋 Description: Updates the specified mass modification report in the Nakisa Lease Accounting Suite, allowing users to adjust details related to leases, contracts, financial obligations, and accounting entries efficiently.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

MassModificationTaskReportDto

false

Request body containing the updated lease and contract information, including financial obligations and accounting entries, for the specified report identified by {id}.

Body Parameters

 1{
 2  "id": 10000001,
 3  "scheduledItemCount": 100,
 4  "processingItemCount": 25,
 5  "doneItemCount": 60,
 6  "failedItemCount": 5,
 7  "cancelledItemCount": 3,
 8  "skippedItemCount": 7,
 9  "totalItemCount": 100,
10  "taskId": 20000001,
11  "modificationType": {
12    "name": "LEASE_COMPONENT_MODIFICATION",
13    "captionKey": "enum.modificationType.leaseComponentModification",
14    "caption": "Lease Component Modification"
15  },
16  "objectType": {
17    "name": "CONTRACT",
18    "captionKey": "enum.objectType.contract",
19    "caption": "Contract"
20  }
21}

Responses

Status

Meaning

Description

Schema

200

OK

Mass modification task report updated successfully

ResponseMassModificationTaskReportDto

400

Bad Request

Invalid request body or ID supplied

None

404

Not Found

Mass modification task report not found

None

500

Internal Server Error

Internal server error

None

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": {
11    "id": 10000001,
12    "scheduledItemCount": 100,
13    "processingItemCount": 25,
14    "doneItemCount": 60,
15    "failedItemCount": 5,
16    "cancelledItemCount": 3,
17    "skippedItemCount": 7,
18    "totalItemCount": 100,
19    "taskId": 20000001,
20    "modificationType": {
21      "name": "LEASE_COMPONENT_MODIFICATION",
22      "captionKey": "enum.modificationType.leaseComponentModification",
23      "caption": "Lease Component Modification"
24    },
25    "objectType": {
26      "name": "CONTRACT",
27      "captionKey": "enum.objectType.contract",
28      "caption": "Contract"
29    }
30  }
31}

Bulk Upsert Mass Modification Reports

HTTP Request

PUT /api/v1/batch/mass-modification/reports/createOrUpdate/bulk

📋 Description: Updates or creates multiple reports for lease contracts and financial obligations in the Nakisa Lease Accounting Suite, ensuring accurate accounting entries are maintained. This operation facilitates bulk modifications to streamline lease management processes.

Parameters

Name

In

Type

Required

Description

body

body

MassModificationTaskReportDto

false

Request body containing bulk data for lease and contract modifications, including financial obligations and accounting entries for efficient processing within the Nakisa Lease Accounting Suite.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "scheduledItemCount": 100,
 5    "processingItemCount": 25,
 6    "doneItemCount": 60,
 7    "failedItemCount": 5,
 8    "cancelledItemCount": 3,
 9    "skippedItemCount": 7,
10    "totalItemCount": 100,
11    "taskId": 20000001,
12    "modificationType": {
13      "name": "LEASE_COMPONENT_MODIFICATION",
14      "captionKey": "enum.modificationType.leaseComponentModification",
15      "caption": "Lease Component Modification"
16    },
17    "objectType": {
18      "name": "CONTRACT",
19      "captionKey": "enum.objectType.contract",
20      "caption": "Contract"
21    }
22  }
23]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListMassModificationTaskReportDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": []
11}

Upsert Mass Modification Report

HTTP Request

PUT /api/v1/batch/mass-modification/reports/createOrUpdate

📋 Description: Creates or updates mass modification reports related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, ensuring accurate accounting entries are maintained.

Parameters

Name

In

Type

Required

Description

body

body

MassModificationTaskReportDto

false

Request body containing the lease and contract modification details, including financial obligations and associated accounting entries for batch processing.

Body Parameters

 1{
 2  "id": 10000001,
 3  "scheduledItemCount": 100,
 4  "processingItemCount": 25,
 5  "doneItemCount": 60,
 6  "failedItemCount": 5,
 7  "cancelledItemCount": 3,
 8  "skippedItemCount": 7,
 9  "totalItemCount": 100,
10  "taskId": 20000001,
11  "modificationType": {
12    "name": "LEASE_COMPONENT_MODIFICATION",
13    "captionKey": "enum.modificationType.leaseComponentModification",
14    "caption": "Lease Component Modification"
15  },
16  "objectType": {
17    "name": "CONTRACT",
18    "captionKey": "enum.objectType.contract",
19    "caption": "Contract"
20  }
21}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseMassModificationTaskReportDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": {
11    "id": 10000001,
12    "scheduledItemCount": 100,
13    "processingItemCount": 25,
14    "doneItemCount": 60,
15    "failedItemCount": 5,
16    "cancelledItemCount": 3,
17    "skippedItemCount": 7,
18    "totalItemCount": 100,
19    "taskId": 20000001,
20    "modificationType": {
21      "name": "LEASE_COMPONENT_MODIFICATION",
22      "captionKey": "enum.modificationType.leaseComponentModification",
23      "caption": "Lease Component Modification"
24    },
25    "objectType": {
26      "name": "CONTRACT",
27      "captionKey": "enum.objectType.contract",
28      "caption": "Contract"
29    }
30  }
31}

Bulk Update Mass Modification Reports

HTTP Request

PUT /api/v1/batch/mass-modification/reports/bulk

📋 Description: Updates multiple lease-related reports in bulk within the Nakisa Lease Accounting Suite, facilitating efficient modifications to contracts and financial obligations for streamlined accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

MassModificationTaskReportDto

false

Request body containing bulk modification data for leases, contracts, and financial obligations, including relevant accounting entries and associated metadata.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "scheduledItemCount": 100,
 5    "processingItemCount": 25,
 6    "doneItemCount": 60,
 7    "failedItemCount": 5,
 8    "cancelledItemCount": 3,
 9    "skippedItemCount": 7,
10    "totalItemCount": 100,
11    "taskId": 20000001,
12    "modificationType": {
13      "name": "LEASE_COMPONENT_MODIFICATION",
14      "captionKey": "enum.modificationType.leaseComponentModification",
15      "caption": "Lease Component Modification"
16    },
17    "objectType": {
18      "name": "CONTRACT",
19      "captionKey": "enum.objectType.contract",
20      "caption": "Contract"
21    }
22  }
23]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListMassModificationTaskReportDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": []
11}

Search Mass Modification Reports

HTTP Request

POST /api/v1/batch/mass-modification/reports/search

📋 Description: Submits a search request for mass modification reports related to leases and contracts within the Nakisa Lease Accounting Suite, enabling users to efficiently identify financial obligations and corresponding accounting entries.

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

MassModificationTaskReportDtoFilter

false

Request body containing the criteria for searching mass modification reports related to leases, contracts, financial obligations, and accounting entries.

Default Values

Parameter

Default

Type

sort

["createdAt,ASC"]

query

Body Parameters

 1{
 2  "idIn": [],
 3  "idEqual": 10000001,
 4  "idLike": "sample_idLike",
 5  "createdAtGreaterThanOrEqual": "2025-01-01T10:00:00Z",
 6  "createdAtLessThanOrEqual": "2025-01-01T10:00:00Z",
 7  "createdByLike": "sample_createdByLike",
 8  "createdByEqual": "sample_createdByEqual",
 9  "modifiedAtGreaterThanOrEqual": "2025-01-01T10:00:00Z",
10  "modifiedAtLessThanOrEqual": "2025-01-01T10:00:00Z",
11  "modifiedByLike": "sample_modifiedByLike",
12  "modifiedByEqual": "sample_modifiedByEqual"
13}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageMassModificationTaskReportDto

Example Responses

 1{
 2  "totalElements": 10000001,
 3  "totalPages": 100,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 100,
17  "size": 100,
18  "content": [],
19  "number": 100,
20  "sort": {
21    "unsorted": false,
22    "sorted": true,
23    "empty": false
24  },
25  "first": false,
26  "last": false,
27  "empty": false
28}

Search Mass Modification Report Items

HTTP Request

POST /api/v1/batch/mass-modification/reports/items/search

📋 Description: Submits a search request for batch mass modification reports related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite, enabling users to efficiently identify and analyze relevant data.

Parameters

Name

In

Type

Required

Description

page

query

integer

false

Page number (0-indexed)

size

query

integer

false

Number of items per page

sort

query

array[string]

false

Sorting criteria in format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

pageSizeAll

query

boolean

false

When set to true, returns all results without pagination limits.

body

body

MassModificationTaskReportItemDtoFilter

false

Request body containing the search criteria and parameters for retrieving mass modification reports related to leases, contracts, financial obligations, and accounting entries.

Default Values

Parameter

Default

Type

page

0

query

size

20

query

pageSizeAll

false

query

Parameter Constraints

Parameter

Constraints

page

Min: 0

size

Min: 1, Max: 100

Body Parameters

 1{
 2  "entityDisplayIdLike": "sample_entityDisplayIdLike",
 3  "typeEqual": {
 4    "name": "DONE",
 5    "captionKey": "enum.taskStatus.done",
 6    "caption": "Done"
 7  },
 8  "reportIdEqual": 10000001,
 9  "reportIdIn": []
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageMassModificationTaskReportItemDto

Example Responses

 1{
 2  "totalElements": 10000001,
 3  "totalPages": 100,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 100,
17  "size": 100,
18  "content": [],
19  "number": 100,
20  "sort": {
21    "unsorted": false,
22    "sorted": true,
23    "empty": false
24  },
25  "first": false,
26  "last": false,
27  "empty": false
28}

List All Mass Modification Reports

HTTP Request

GET /api/v1/batch/mass-modification/reports

📋 Description: Retrieves reports related to mass modifications of leases and contracts, providing insights into financial obligations and accounting entries within the Nakisa Lease Accounting Suite. This operation facilitates informed decision-making by delivering comprehensive data on batch processing activities.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the mass modification reports should be returned in a paginated format, facilitating efficient data retrieval for lease and contract management within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageMassModificationTaskReportDto

Example Responses

 1{
 2  "totalElements": 10000001,
 3  "totalPages": 100,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 100,
17  "size": 100,
18  "content": [],
19  "number": 100,
20  "sort": {
21    "unsorted": false,
22    "sorted": true,
23    "empty": false
24  },
25  "first": false,
26  "last": false,
27  "empty": false
28}