Operational Posting Task

Get Operational Posting Task By ID

HTTP Request

GET /api/v1/batch/operationalposting/tasks/{id}

📋 Description: Retrieves details of a specific operational posting task by its unique identifier, facilitating effective management of lease-related financial obligations and accounting entries 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

ResponseOperationalPostingTaskDto

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    "batchTaskObjectType": {
29      "name": "CONTRACT",
30      "captionKey": "enum.objectType.contract",
31      "caption": "Contract"
32    },
33    "taskReports": []
34  }
35}

Update Operational Posting Task

HTTP Request

PUT /api/v1/batch/operationalposting/tasks/{id}

📋 Description: Updates the operational posting task identified by the specified ID within the Nakisa Lease Accounting Suite, allowing users to modify lease-related financial obligations and accounting entries associated with contracts.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

OperationalPostingTaskDto

false

Request body containing the updated operational posting task data, including lease details, contract information, and associated financial obligations for accurate accounting entries.

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  "batchTaskObjectType": {
20    "name": "CONTRACT",
21    "captionKey": "enum.objectType.contract",
22    "caption": "Contract"
23  },
24  "taskReports": []
25}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseOperationalPostingTaskDto

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    "batchTaskObjectType": {
29      "name": "CONTRACT",
30      "captionKey": "enum.objectType.contract",
31      "caption": "Contract"
32    },
33    "taskReports": []
34  }
35}

Bulk Upsert Operational Posting Tasks

HTTP Request

PUT /api/v1/batch/operationalposting/tasks/createOrUpdate/bulk

📋 Description: Updates or creates multiple operational posting tasks in the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, and financial obligations within accounting entries. This operation ensures efficient bulk processing to enhance financial accuracy and compliance.

Parameters

Name

In

Type

Required

Description

body

body

OperationalPostingTaskDto

false

Request body containing bulk data for creating or updating operational posting tasks related to leases, contracts, financial obligations, and accounting entries.

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    "batchTaskObjectType": {
21      "name": "CONTRACT",
22      "captionKey": "enum.objectType.contract",
23      "caption": "Contract"
24    },
25    "taskReports": []
26  }
27]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListOperationalPostingTaskDto

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 Operational Posting Task

HTTP Request

PUT /api/v1/batch/operationalposting/tasks/createOrUpdate

📋 Description: Creates or updates operational posting tasks within the Nakisa Lease Accounting Suite, ensuring accurate management of lease contracts and financial obligations in accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

OperationalPostingTaskDto

false

Request body containing the lease and contract data necessary for creating or updating financial obligations and accounting entries within 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  "batchTaskObjectType": {
20    "name": "CONTRACT",
21    "captionKey": "enum.objectType.contract",
22    "caption": "Contract"
23  },
24  "taskReports": []
25}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseOperationalPostingTaskDto

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    "batchTaskObjectType": {
29      "name": "CONTRACT",
30      "captionKey": "enum.objectType.contract",
31      "caption": "Contract"
32    },
33    "taskReports": []
34  }
35}

Bulk Update Operational Posting Tasks

HTTP Request

PUT /api/v1/batch/operationalposting/tasks/bulk

📋 Description: Updates multiple operational posting tasks in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of lease contracts and financial obligations related to accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

OperationalPostingTaskDto

false

Request body containing bulk operational posting task data, including lease details, contract information, financial obligations, and associated accounting entries.

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    "batchTaskObjectType": {
21      "name": "CONTRACT",
22      "captionKey": "enum.objectType.contract",
23      "caption": "Contract"
24    },
25    "taskReports": []
26  }
27]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListOperationalPostingTaskDto

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 Operational Posting Tasks

HTTP Request

POST /api/v1/batch/operationalposting/tasks/search

📋 Description: Submits a request to search for operational posting tasks related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, facilitating efficient management of 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

OperationalPostingTaskDtoFilter

false

Request body containing search criteria and filters for operational posting tasks 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  "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

PageOperationalPostingTaskDto

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 Operational Posting Task

HTTP Request

POST /api/v1/batch/operationalposting/tasks/cancel/{id}

📋 Description: Cancels a specific operational posting task identified by the provided ID, ensuring that any associated lease or contract financial obligations are appropriately managed 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

None

Bulk Cancel Operational Posting Tasks

HTTP Request

POST /api/v1/batch/operationalposting/tasks/cancel/bulk

📋 Description: Initiates the cancellation of multiple operational posting tasks in bulk, streamlining the management of leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

Request body containing an array of lease and contract identifiers to facilitate 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 Operational Posting Tasks

HTTP Request

GET /api/v1/batch/operationalposting/tasks

📋 Description: Retrieves a list of operational posting tasks related to leases and contracts, enabling users to manage financial obligations and accounting entries effectively.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the operational posting tasks should be returned in a paginated format, facilitating efficient retrieval of lease and contract-related data.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageOperationalPostingTaskDto

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}