Mass Indexation Task Report

Get Mass Indexation Report By ID

HTTP Request

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

Interactive Demo

📋 Description: Retrieves the report for a specific mass indexation process identified by the given ID, providing insights into 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	ResponseMassIndexationTaskReportDto

Example Responses

{
  "code": {
    "name": "OK",
    "captionKey": "enum.responseCode.ok",
    "caption": "OK"
  },
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000001,
    "scheduledItemCount": 100,
    "processingItemCount": 100,
    "doneItemCount": 100,
    "failedItemCount": 100,
    "cancelledItemCount": 100,
    "skippedItemCount": 100,
    "totalItemCount": 100,
    "taskId": 10000001
  }
}

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

Update Mass Indexation Report

HTTP Request

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

Interactive Demo

📋 Description: Updates the mass indexation report identified by the specified ID within the Nakisa Lease Accounting Suite, enabling users to modify lease, contract, financial obligation, or accounting entry details as necessary.

Parameters

Name	In	Type	Required	Description
id	path	integer	true	Unique identifier for the resource
body	body	MassIndexationTaskReportDto	false	Request body containing the updated mass indexation report data, including lease, contract, and financial obligation details relevant for accounting entries.

Body Parameters

{
  "id": 10000001,
  "scheduledItemCount": 100,
  "processingItemCount": 100,
  "doneItemCount": 100,
  "failedItemCount": 100,
  "cancelledItemCount": 100,
  "skippedItemCount": 100,
  "totalItemCount": 100,
  "taskId": 10000001
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseMassIndexationTaskReportDto

Example Responses

{
  "code": {
    "name": "OK",
    "captionKey": "enum.responseCode.ok",
    "caption": "OK"
  },
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000001,
    "scheduledItemCount": 100,
    "processingItemCount": 100,
    "doneItemCount": 100,
    "failedItemCount": 100,
    "cancelledItemCount": 100,
    "skippedItemCount": 100,
    "totalItemCount": 100,
    "taskId": 10000001
  }
}

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

Bulk Upsert Mass Indexation Reports

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates multiple mass indexation reports for leases and contracts in the Nakisa Lease Accounting Suite, ensuring accurate financial obligations and accounting entries are maintained.

Parameters

Name	In	Type	Required	Description
body	body	MassIndexationTaskReportDto	false	Request body containing bulk data for creating or updating lease contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.

Body Parameters

[
  {
    "id": 10000001,
    "scheduledItemCount": 100,
    "processingItemCount": 100,
    "doneItemCount": 100,
    "failedItemCount": 100,
    "cancelledItemCount": 100,
    "skippedItemCount": 100,
    "totalItemCount": 100,
    "taskId": 10000001
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListMassIndexationTaskReportDto

Example Responses

{
  "code": {
    "name": "OK",
    "captionKey": "enum.responseCode.ok",
    "caption": "OK"
  },
  "errors": {
    "all": []
  },
  "object": []
}

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

Upsert Mass Indexation Report

HTTP Request

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

Interactive Demo

📋 Description: Updates or creates mass indexation reports within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, financial obligations, and accounting entries efficiently.

Parameters

Name	In	Type	Required	Description
body	body	MassIndexationTaskReportDto	false	Request body containing the lease and contract details, including financial obligations and accounting entries, for creating or updating mass indexation reports.

Body Parameters

{
  "id": 10000001,
  "scheduledItemCount": 100,
  "processingItemCount": 100,
  "doneItemCount": 100,
  "failedItemCount": 100,
  "cancelledItemCount": 100,
  "skippedItemCount": 100,
  "totalItemCount": 100,
  "taskId": 10000001
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseMassIndexationTaskReportDto

Example Responses

{
  "code": {
    "name": "OK",
    "captionKey": "enum.responseCode.ok",
    "caption": "OK"
  },
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000001,
    "scheduledItemCount": 100,
    "processingItemCount": 100,
    "doneItemCount": 100,
    "failedItemCount": 100,
    "cancelledItemCount": 100,
    "skippedItemCount": 100,
    "totalItemCount": 100,
    "taskId": 10000001
  }
}

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

Bulk Update Mass Indexation Reports

HTTP Request

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

Interactive Demo

📋 Description: Updates multiple mass indexation reports in the Nakisa Lease Accounting Suite, enabling efficient management of lease, contract, and financial obligation data for accurate accounting entries.

Parameters

Name	In	Type	Required	Description
body	body	MassIndexationTaskReportDto	false	Request body containing bulk report data for lease contracts, including financial obligations and accounting entries for mass indexation within the Nakisa Lease Accounting Suite.

Body Parameters

[
  {
    "id": 10000001,
    "scheduledItemCount": 100,
    "processingItemCount": 100,
    "doneItemCount": 100,
    "failedItemCount": 100,
    "cancelledItemCount": 100,
    "skippedItemCount": 100,
    "totalItemCount": 100,
    "taskId": 10000001
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListMassIndexationTaskReportDto

Example Responses

{
  "code": {
    "name": "OK",
    "captionKey": "enum.responseCode.ok",
    "caption": "OK"
  },
  "errors": {
    "all": []
  },
  "object": []
}

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

Search Mass Indexation Reports

HTTP Request

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

Interactive Demo

📋 Description: Submits a search request for mass indexation reports within the Nakisa Lease Accounting Suite, enabling users to efficiently locate and analyze lease, contract, financial obligation, and accounting entry 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	MassIndexationTaskReportDtoFilter	false	Request body containing search criteria and filters for retrieving mass indexation reports related to leases, contracts, financial obligations, and accounting entries.

Default Values

Parameter	Default	Type
sort	["createdAt,ASC"]	query

Body Parameters

{
  "idIn": [],
  "idEqual": 10000001,
  "idLike": "sample_idLike",
  "createdAtGreaterThanOrEqual": "2025-01-01T10:00:00Z",
  "createdAtLessThanOrEqual": "2025-01-01T10:00:00Z",
  "createdByLike": "sample_createdByLike",
  "createdByEqual": "sample_createdByEqual",
  "modifiedAtGreaterThanOrEqual": "2025-01-01T10:00:00Z",
  "modifiedAtLessThanOrEqual": "2025-01-01T10:00:00Z",
  "modifiedByLike": "sample_modifiedByLike",
  "modifiedByEqual": "sample_modifiedByEqual"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageMassIndexationTaskReportDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 100,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

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

Search Mass Indexation Reports (With Items And Search)

HTTP Request

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

Interactive Demo

📋 Description: Submits a search request for items related to lease contracts and financial obligations within the Nakisa Lease Accounting Suite, facilitating efficient mass indexation reporting.

Parameters

Name	In	Type	Required	Description
pageSizeAll	query	boolean	false	none
body	body	object	false	Request body containing search criteria and filters for retrieving mass indexation report items related to leases, contracts, financial obligations, and accounting entries.

Body Parameters

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageMassIndexationTaskReportItemDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 100,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

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

List All Mass Indexation Reports

HTTP Request

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

Interactive Demo

📋 Description: Retrieves reports on mass indexation processes related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, providing insights into accounting entries and compliance status.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the mass indexation 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	PageMassIndexationTaskReportDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 100,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

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

---