Intercompanytransfer Task

Get Mass Inter-Company Transfer Task By ID

HTTP Request

GET /api/v1/batch/mass-inter-company-transfer/tasks/{id}

📋 Description: Retrieves the details of a specific mass inter-company transfer task by its unique identifier, facilitating the 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

ResponseMassInterCompanyTransferTaskDto

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": 50000001,
12    "queueTime": "2024-01-15T10:30:00Z",
13    "startTime": "2024-01-15T10:35:00Z",
14    "endTime": "2024-01-15T11:00:00Z",
15    "interruptedAt": "2019-08-24T14:15:22Z",
16    "recoveredAt": "2019-08-24T14:15:22Z",
17    "status": {
18      "name": "PROCESSING",
19      "captionKey": "enum.batchJobStatus.processing",
20      "caption": "Processing"
21    },
22    "recover": false,
23    "interrupted": false,
24    "interruptionMessage": "string",
25    "errorMessage": "string",
26    "totalObjectCount": 500,
27    "jobId": 10000001,
28    "duty": {
29      "name": "PERFORM_INTER_COMPANY_TRANSFER",
30      "captionKey": "enum.massInterCompanyTransferTaskDuty.performInterCompanyTransfer",
31      "caption": "Perform Inter-Company Transfer"
32    },
33    "templateFileStorageId": "template-file-uuid-12345",
34    "inputFileStorageId": "input-file-uuid-67890",
35    "templateDocStoreId": 40000001,
36    "inputDocStoreId": 40000002,
37    "reports": []
38  }
39}

Update Mass Inter-Company Transfer Task

HTTP Request

PUT /api/v1/batch/mass-inter-company-transfer/tasks/{id}

📋 Description: Updates the status and details of a specific mass inter-company transfer task identified by the provided ID within the Nakisa Lease Accounting Suite, ensuring accurate management of lease-related financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

MassInterCompanyTransferTaskDto

false

Request body containing the details of the inter-company transfer task, including lease and contract information, financial obligations, and accounting entry adjustments.

Body Parameters

 1{
 2  "id": 50000001,
 3  "queueTime": "2024-01-15T10:30:00Z",
 4  "startTime": "2024-01-15T10:35:00Z",
 5  "endTime": "2024-01-15T11:00:00Z",
 6  "interruptedAt": "2019-08-24T14:15:22Z",
 7  "recoveredAt": "2019-08-24T14:15:22Z",
 8  "status": {
 9    "name": "PROCESSING",
10    "captionKey": "enum.batchJobStatus.processing",
11    "caption": "Processing"
12  },
13  "recover": false,
14  "interrupted": false,
15  "interruptionMessage": "string",
16  "errorMessage": "string",
17  "totalObjectCount": 500,
18  "jobId": 10000001,
19  "duty": {
20    "name": "PERFORM_INTER_COMPANY_TRANSFER",
21    "captionKey": "enum.massInterCompanyTransferTaskDuty.performInterCompanyTransfer",
22    "caption": "Perform Inter-Company Transfer"
23  },
24  "templateFileStorageId": "template-file-uuid-12345",
25  "inputFileStorageId": "input-file-uuid-67890",
26  "templateDocStoreId": 40000001,
27  "inputDocStoreId": 40000002,
28  "reports": []
29}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseMassInterCompanyTransferTaskDto

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": 50000001,
12    "queueTime": "2024-01-15T10:30:00Z",
13    "startTime": "2024-01-15T10:35:00Z",
14    "endTime": "2024-01-15T11:00:00Z",
15    "interruptedAt": "2019-08-24T14:15:22Z",
16    "recoveredAt": "2019-08-24T14:15:22Z",
17    "status": {
18      "name": "PROCESSING",
19      "captionKey": "enum.batchJobStatus.processing",
20      "caption": "Processing"
21    },
22    "recover": false,
23    "interrupted": false,
24    "interruptionMessage": "string",
25    "errorMessage": "string",
26    "totalObjectCount": 500,
27    "jobId": 10000001,
28    "duty": {
29      "name": "PERFORM_INTER_COMPANY_TRANSFER",
30      "captionKey": "enum.massInterCompanyTransferTaskDuty.performInterCompanyTransfer",
31      "caption": "Perform Inter-Company Transfer"
32    },
33    "templateFileStorageId": "template-file-uuid-12345",
34    "inputFileStorageId": "input-file-uuid-67890",
35    "templateDocStoreId": 40000001,
36    "inputDocStoreId": 40000002,
37    "reports": []
38  }
39}

Bulk Upsert Mass Inter-Company Transfer Tasks

HTTP Request

PUT /api/v1/batch/mass-inter-company-transfer/tasks/createOrUpdate/bulk

📋 Description: Creates or updates multiple inter-company transfer tasks in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of leases, contracts, and financial obligations related to accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

MassInterCompanyTransferTaskDto

false

Request body containing bulk data for creating or updating inter-company transfer tasks, including lease details, contract information, financial obligations, and associated accounting entries.

Body Parameters

 1[
 2  {
 3    "id": 50000001,
 4    "queueTime": "2024-01-15T10:30:00Z",
 5    "startTime": "2024-01-15T10:35:00Z",
 6    "endTime": "2024-01-15T11:00:00Z",
 7    "interruptedAt": "2019-08-24T14:15:22Z",
 8    "recoveredAt": "2019-08-24T14:15:22Z",
 9    "status": {
10      "name": "PROCESSING",
11      "captionKey": "enum.batchJobStatus.processing",
12      "caption": "Processing"
13    },
14    "recover": false,
15    "interrupted": false,
16    "interruptionMessage": "string",
17    "errorMessage": "string",
18    "totalObjectCount": 500,
19    "jobId": 10000001,
20    "duty": {
21      "name": "PERFORM_INTER_COMPANY_TRANSFER",
22      "captionKey": "enum.massInterCompanyTransferTaskDuty.performInterCompanyTransfer",
23      "caption": "Perform Inter-Company Transfer"
24    },
25    "templateFileStorageId": "template-file-uuid-12345",
26    "inputFileStorageId": "input-file-uuid-67890",
27    "templateDocStoreId": 40000001,
28    "inputDocStoreId": 40000002,
29    "reports": []
30  }
31]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListMassInterCompanyTransferTaskDto

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 Inter-Company Transfer Task

HTTP Request

PUT /api/v1/batch/mass-inter-company-transfer/tasks/createOrUpdate

📋 Description: Creates or updates tasks related to mass inter-company transfers within the Nakisa Lease Accounting Suite, ensuring accurate management of leases, contracts, and financial obligations in accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

MassInterCompanyTransferTaskDto

false

Request body containing the lease and contract details, including financial obligations and accounting entries, for creating or updating mass inter-company transfer tasks.

Body Parameters

 1{
 2  "id": 50000001,
 3  "queueTime": "2024-01-15T10:30:00Z",
 4  "startTime": "2024-01-15T10:35:00Z",
 5  "endTime": "2024-01-15T11:00:00Z",
 6  "interruptedAt": "2019-08-24T14:15:22Z",
 7  "recoveredAt": "2019-08-24T14:15:22Z",
 8  "status": {
 9    "name": "PROCESSING",
10    "captionKey": "enum.batchJobStatus.processing",
11    "caption": "Processing"
12  },
13  "recover": false,
14  "interrupted": false,
15  "interruptionMessage": "string",
16  "errorMessage": "string",
17  "totalObjectCount": 500,
18  "jobId": 10000001,
19  "duty": {
20    "name": "PERFORM_INTER_COMPANY_TRANSFER",
21    "captionKey": "enum.massInterCompanyTransferTaskDuty.performInterCompanyTransfer",
22    "caption": "Perform Inter-Company Transfer"
23  },
24  "templateFileStorageId": "template-file-uuid-12345",
25  "inputFileStorageId": "input-file-uuid-67890",
26  "templateDocStoreId": 40000001,
27  "inputDocStoreId": 40000002,
28  "reports": []
29}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseMassInterCompanyTransferTaskDto

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": 50000001,
12    "queueTime": "2024-01-15T10:30:00Z",
13    "startTime": "2024-01-15T10:35:00Z",
14    "endTime": "2024-01-15T11:00:00Z",
15    "interruptedAt": "2019-08-24T14:15:22Z",
16    "recoveredAt": "2019-08-24T14:15:22Z",
17    "status": {
18      "name": "PROCESSING",
19      "captionKey": "enum.batchJobStatus.processing",
20      "caption": "Processing"
21    },
22    "recover": false,
23    "interrupted": false,
24    "interruptionMessage": "string",
25    "errorMessage": "string",
26    "totalObjectCount": 500,
27    "jobId": 10000001,
28    "duty": {
29      "name": "PERFORM_INTER_COMPANY_TRANSFER",
30      "captionKey": "enum.massInterCompanyTransferTaskDuty.performInterCompanyTransfer",
31      "caption": "Perform Inter-Company Transfer"
32    },
33    "templateFileStorageId": "template-file-uuid-12345",
34    "inputFileStorageId": "input-file-uuid-67890",
35    "templateDocStoreId": 40000001,
36    "inputDocStoreId": 40000002,
37    "reports": []
38  }
39}

Bulk Update Mass Inter-Company Transfer Tasks

HTTP Request

PUT /api/v1/batch/mass-inter-company-transfer/tasks/bulk

📋 Description: Updates multiple inter-company transfer tasks in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of lease contracts and financial obligations associated with accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

MassInterCompanyTransferTaskDto

false

Request body containing a collection of inter-company transfer task details, including lease and contract information, financial obligations, and associated accounting entries for bulk processing.

Body Parameters

 1[
 2  {
 3    "id": 50000001,
 4    "queueTime": "2024-01-15T10:30:00Z",
 5    "startTime": "2024-01-15T10:35:00Z",
 6    "endTime": "2024-01-15T11:00:00Z",
 7    "interruptedAt": "2019-08-24T14:15:22Z",
 8    "recoveredAt": "2019-08-24T14:15:22Z",
 9    "status": {
10      "name": "PROCESSING",
11      "captionKey": "enum.batchJobStatus.processing",
12      "caption": "Processing"
13    },
14    "recover": false,
15    "interrupted": false,
16    "interruptionMessage": "string",
17    "errorMessage": "string",
18    "totalObjectCount": 500,
19    "jobId": 10000001,
20    "duty": {
21      "name": "PERFORM_INTER_COMPANY_TRANSFER",
22      "captionKey": "enum.massInterCompanyTransferTaskDuty.performInterCompanyTransfer",
23      "caption": "Perform Inter-Company Transfer"
24    },
25    "templateFileStorageId": "template-file-uuid-12345",
26    "inputFileStorageId": "input-file-uuid-67890",
27    "templateDocStoreId": 40000001,
28    "inputDocStoreId": 40000002,
29    "reports": []
30  }
31]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListMassInterCompanyTransferTaskDto

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 Inter-Company Transfer Tasks

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/tasks/search

📋 Description: Submits a request to search for tasks related to mass inter-company transfers within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, and associated financial obligations. This operation enhances the efficiency of accounting entries by providing targeted task retrieval.

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

MassInterCompanyTransferTaskDtoFilter

false

Request body containing the criteria for searching tasks related to inter-company transfers, including lease details, contract specifications, 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

PageMassInterCompanyTransferTaskDto

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 Inter-Company Transfer Task

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/tasks/cancel/{id}

📋 Description: Cancels a specified mass inter-company transfer task by its unique identifier, ensuring accurate 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

None

Bulk Cancel Mass Inter-Company Transfer Tasks

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/tasks/cancel/bulk

📋 Description: Initiates a bulk cancellation of mass inter-company transfer tasks within the Nakisa Lease Accounting Suite, streamlining the management of lease-related contracts and financial obligations.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

Request body containing a list of inter-company transfer task identifiers to be canceled in bulk, relevant to lease and contract management within the Nakisa Lease Accounting Suite.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

List All Mass Inter-Company Transfer Tasks

HTTP Request

GET /api/v1/batch/mass-inter-company-transfer/tasks

📋 Description: Retrieves a list of tasks related to mass inter-company transfers within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, and financial obligations in accounting entries.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the mass inter-company transfer tasks should be returned in a paginated format, facilitating efficient retrieval of lease and contract-related data within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageMassInterCompanyTransferTaskDto

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}