Mass Modification Task Controller

Get Mass Modification Task By ID

HTTP Request

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

📋 Description: Retrieves details of a specific mass modification task by its unique identifier, facilitating effective management of lease contracts and associated financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseMassModificationTaskDto

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    "queueTime": "2025-01-01T10:00:00Z",
13    "startTime": "2025-01-01T10:00:00Z",
14    "endTime": "2025-01-01T10:00:00Z",
15    "interruptedAt": "2025-01-01T10:00:00Z",
16    "recoveredAt": "2025-01-01T10:00:00Z",
17    "status": {
18      "name": "PROCESSING",
19      "captionKey": "enum.batchJobStatus.processing",
20      "caption": "Processing"
21    },
22    "recover": false,
23    "interrupted": false,
24    "interruptionMessage": "sample_interruptionMessage",
25    "errorMessage": "sample_errorMessage",
26    "totalObjectCount": 100,
27    "jobId": 10000001,
28    "duty": {
29      "name": "GENERATE_EXCEL_INPUT_TEMPLATE",
30      "captionKey": "enum.modificationTaskDuty.generateExcelInputTemplate",
31      "caption": "Generate Excel Input Template"
32    },
33    "templateFileStorageId": "sample_templateFileStorageId",
34    "inputFileStorageId": "sample_inputFileStorageId",
35    "reports": [],
36    "templateDocStoreId": 10000001,
37    "inputDocStoreId": 10000001
38  }
39}

Update Mass Modification Task

HTTP Request

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

📋 Description: Updates the specified mass modification task in the Nakisa Lease Accounting Suite, allowing users to adjust lease, contract, financial obligation, or accounting entry details as necessary for accurate financial reporting and compliance.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

MassModificationTaskDto

false

Request body containing the updated lease and contract information, including financial obligations and accounting entries, for the specified mass modification task.

Body Parameters

 1{
 2  "id": 10000001,
 3  "queueTime": "2025-01-01T10:00:00Z",
 4  "startTime": "2025-01-01T10:00:00Z",
 5  "endTime": "2025-01-01T10:00:00Z",
 6  "interruptedAt": "2025-01-01T10:00:00Z",
 7  "recoveredAt": "2025-01-01T10:00:00Z",
 8  "status": {
 9    "name": "PROCESSING",
10    "captionKey": "enum.batchJobStatus.processing",
11    "caption": "Processing"
12  },
13  "recover": false,
14  "interrupted": false,
15  "interruptionMessage": "sample_interruptionMessage",
16  "errorMessage": "sample_errorMessage",
17  "totalObjectCount": 100,
18  "jobId": 10000001,
19  "duty": {
20    "name": "GENERATE_EXCEL_INPUT_TEMPLATE",
21    "captionKey": "enum.modificationTaskDuty.generateExcelInputTemplate",
22    "caption": "Generate Excel Input Template"
23  },
24  "templateFileStorageId": "sample_templateFileStorageId",
25  "inputFileStorageId": "sample_inputFileStorageId",
26  "reports": [],
27  "templateDocStoreId": 10000001,
28  "inputDocStoreId": 10000001
29}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseMassModificationTaskDto

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    "queueTime": "2025-01-01T10:00:00Z",
13    "startTime": "2025-01-01T10:00:00Z",
14    "endTime": "2025-01-01T10:00:00Z",
15    "interruptedAt": "2025-01-01T10:00:00Z",
16    "recoveredAt": "2025-01-01T10:00:00Z",
17    "status": {
18      "name": "PROCESSING",
19      "captionKey": "enum.batchJobStatus.processing",
20      "caption": "Processing"
21    },
22    "recover": false,
23    "interrupted": false,
24    "interruptionMessage": "sample_interruptionMessage",
25    "errorMessage": "sample_errorMessage",
26    "totalObjectCount": 100,
27    "jobId": 10000001,
28    "duty": {
29      "name": "GENERATE_EXCEL_INPUT_TEMPLATE",
30      "captionKey": "enum.modificationTaskDuty.generateExcelInputTemplate",
31      "caption": "Generate Excel Input Template"
32    },
33    "templateFileStorageId": "sample_templateFileStorageId",
34    "inputFileStorageId": "sample_inputFileStorageId",
35    "reports": [],
36    "templateDocStoreId": 10000001,
37    "inputDocStoreId": 10000001
38  }
39}

Bulk Upsert Mass Modification Tasks

HTTP Request

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

📋 Description: Creates or updates multiple lease-related tasks in bulk within the Nakisa Lease Accounting Suite, streamlining the management of contracts, financial obligations, and accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

MassModificationTaskDto

false

Request body containing bulk data for creating or updating lease, contract, financial obligation, and accounting entry tasks within the Nakisa Lease Accounting Suite.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "queueTime": "2025-01-01T10:00:00Z",
 5    "startTime": "2025-01-01T10:00:00Z",
 6    "endTime": "2025-01-01T10:00:00Z",
 7    "interruptedAt": "2025-01-01T10:00:00Z",
 8    "recoveredAt": "2025-01-01T10:00:00Z",
 9    "status": {
10      "name": "PROCESSING",
11      "captionKey": "enum.batchJobStatus.processing",
12      "caption": "Processing"
13    },
14    "recover": false,
15    "interrupted": false,
16    "interruptionMessage": "sample_interruptionMessage",
17    "errorMessage": "sample_errorMessage",
18    "totalObjectCount": 100,
19    "jobId": 10000001,
20    "duty": {
21      "name": "GENERATE_EXCEL_INPUT_TEMPLATE",
22      "captionKey": "enum.modificationTaskDuty.generateExcelInputTemplate",
23      "caption": "Generate Excel Input Template"
24    },
25    "templateFileStorageId": "sample_templateFileStorageId",
26    "inputFileStorageId": "sample_inputFileStorageId",
27    "reports": [],
28    "templateDocStoreId": 10000001,
29    "inputDocStoreId": 10000001
30  }
31]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListMassModificationTaskDto

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 Task

HTTP Request

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

📋 Description: Updates or creates batch tasks for mass modifications related to leases, contracts, financial obligations, or accounting entries within the Nakisa Lease Accounting Suite. This operation ensures efficient management of multiple records in a single request, streamlining the modification process.

Parameters

Name

In

Type

Required

Description

body

body

MassModificationTaskDto

false

Request body containing the lease and contract modification data, including financial obligations and accounting entries, for creating or updating batch tasks in the Nakisa Lease Accounting Suite.

Body Parameters

 1{
 2  "id": 10000001,
 3  "queueTime": "2025-01-01T10:00:00Z",
 4  "startTime": "2025-01-01T10:00:00Z",
 5  "endTime": "2025-01-01T10:00:00Z",
 6  "interruptedAt": "2025-01-01T10:00:00Z",
 7  "recoveredAt": "2025-01-01T10:00:00Z",
 8  "status": {
 9    "name": "PROCESSING",
10    "captionKey": "enum.batchJobStatus.processing",
11    "caption": "Processing"
12  },
13  "recover": false,
14  "interrupted": false,
15  "interruptionMessage": "sample_interruptionMessage",
16  "errorMessage": "sample_errorMessage",
17  "totalObjectCount": 100,
18  "jobId": 10000001,
19  "duty": {
20    "name": "GENERATE_EXCEL_INPUT_TEMPLATE",
21    "captionKey": "enum.modificationTaskDuty.generateExcelInputTemplate",
22    "caption": "Generate Excel Input Template"
23  },
24  "templateFileStorageId": "sample_templateFileStorageId",
25  "inputFileStorageId": "sample_inputFileStorageId",
26  "reports": [],
27  "templateDocStoreId": 10000001,
28  "inputDocStoreId": 10000001
29}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseMassModificationTaskDto

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    "queueTime": "2025-01-01T10:00:00Z",
13    "startTime": "2025-01-01T10:00:00Z",
14    "endTime": "2025-01-01T10:00:00Z",
15    "interruptedAt": "2025-01-01T10:00:00Z",
16    "recoveredAt": "2025-01-01T10:00:00Z",
17    "status": {
18      "name": "PROCESSING",
19      "captionKey": "enum.batchJobStatus.processing",
20      "caption": "Processing"
21    },
22    "recover": false,
23    "interrupted": false,
24    "interruptionMessage": "sample_interruptionMessage",
25    "errorMessage": "sample_errorMessage",
26    "totalObjectCount": 100,
27    "jobId": 10000001,
28    "duty": {
29      "name": "GENERATE_EXCEL_INPUT_TEMPLATE",
30      "captionKey": "enum.modificationTaskDuty.generateExcelInputTemplate",
31      "caption": "Generate Excel Input Template"
32    },
33    "templateFileStorageId": "sample_templateFileStorageId",
34    "inputFileStorageId": "sample_inputFileStorageId",
35    "reports": [],
36    "templateDocStoreId": 10000001,
37    "inputDocStoreId": 10000001
38  }
39}

Bulk Update Mass Modification Tasks

HTTP Request

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

📋 Description: Updates multiple lease and contract records in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

MassModificationTaskDto

false

Request body containing the bulk modification data for lease contracts, including financial obligations and accounting entries, to facilitate efficient updates within the Nakisa Lease Accounting Suite.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "queueTime": "2025-01-01T10:00:00Z",
 5    "startTime": "2025-01-01T10:00:00Z",
 6    "endTime": "2025-01-01T10:00:00Z",
 7    "interruptedAt": "2025-01-01T10:00:00Z",
 8    "recoveredAt": "2025-01-01T10:00:00Z",
 9    "status": {
10      "name": "PROCESSING",
11      "captionKey": "enum.batchJobStatus.processing",
12      "caption": "Processing"
13    },
14    "recover": false,
15    "interrupted": false,
16    "interruptionMessage": "sample_interruptionMessage",
17    "errorMessage": "sample_errorMessage",
18    "totalObjectCount": 100,
19    "jobId": 10000001,
20    "duty": {
21      "name": "GENERATE_EXCEL_INPUT_TEMPLATE",
22      "captionKey": "enum.modificationTaskDuty.generateExcelInputTemplate",
23      "caption": "Generate Excel Input Template"
24    },
25    "templateFileStorageId": "sample_templateFileStorageId",
26    "inputFileStorageId": "sample_inputFileStorageId",
27    "reports": [],
28    "templateDocStoreId": 10000001,
29    "inputDocStoreId": 10000001
30  }
31]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListMassModificationTaskDto

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 Tasks

HTTP Request

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

📋 Description: Submits a request to search for mass modification tasks related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.

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

MassModificationTaskDtoFilter

false

Request body containing search criteria and parameters for identifying lease, contract, financial obligation, and accounting entry tasks for mass modification within the Nakisa Lease Accounting Suite.

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  "queueTimeGreaterThanOrEqual": "2025-01-01T10:00:00Z",
14  "queueTimeLessThanOrEqual": "2025-01-01T10:00:00Z",
15  "startTimeGreaterThanOrEqual": "2025-01-01T10:00:00Z",
16  "startTimeLessThanOrEqual": "2025-01-01T10:00:00Z",
17  "endTimeGreaterThanOrEqual": "2025-01-01T10:00:00Z",
18  "endTimeLessThanOrEqual": "2025-01-01T10:00:00Z",
19  "statusIn": {
20    "name": "PROCESSING",
21    "captionKey": "enum.batchJobStatus.processing",
22    "caption": "Processing"
23  },
24  "statusEqual": {
25    "name": "PROCESSING",
26    "captionKey": "enum.batchJobStatus.processing",
27    "caption": "Processing"
28  },
29  "jobIdEqual": 10000001
30}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageMassModificationTaskDto

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}

Cancel Mass Modification Task

HTTP Request

POST /api/v1/batch/mass-modification/tasks/cancel/{id}

📋 Description: Cancels a specified mass modification task within the Nakisa Lease Accounting Suite, allowing users to manage lease, contract, and financial obligation processes effectively. This operation ensures that any pending accounting entries associated with the task are halted, maintaining accurate financial records.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Bulk Cancel Mass Modification Tasks

HTTP Request

POST /api/v1/batch/mass-modification/tasks/cancel/bulk

📋 Description: Initiates a bulk cancellation of mass modification tasks related to leases and contracts within the Nakisa Lease Accounting Suite, ensuring efficient management of financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

Request body containing a list of lease and contract identifiers for the bulk cancellation of financial obligations and associated accounting entries.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

List All Mass Modification Tasks

HTTP Request

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

📋 Description: Retrieves a list of mass modification tasks related to leases and contracts within the Nakisa Lease Accounting Suite, enabling users to efficiently manage financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the mass modification tasks query 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

PageMassModificationTaskDto

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}