Intercompanytransfer Job¶

Get Mass Inter-Company Transfer Job By ID¶

HTTP Request

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

📋 Description: Fetches the details of a specific mass inter-company transfer job 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(int64)	true	Unique identifier for the resource

Example Values¶

Parameter	Example	Type
id	`10000001`	path

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved mass inter-company transfer job	ResponseMassInterCompanyTransferJobDto
400	Bad Request	Invalid ID supplied	None
404	Not Found	Mass inter-company transfer job not found	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "code": {
    "name": "OK",
    "captionKey": "enum.responseCode.ok",
    "caption": "OK"
  },
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000001,
    "taskCount": 100,
    "failedTaskCount": 5,
    "doneTaskCount": 80,
    "inProgressTaskCount": 10,
    "cancelledTaskCount": 5,
    "errorMessage": "Failed to process transfer for contract ID 12345",
    "queueTime": "2024-01-15T10:30:00Z",
    "startTime": "2024-01-15T10:35:00Z",
    "endTime": "2024-01-15T12:00:00Z",
    "status": {
      "name": "PROCESSING",
      "captionKey": "enum.batchJobStatus.processing",
      "caption": "Processing"
    },
    "executor": {
      "name": "MANUAL",
      "captionKey": "enum.batchJobExecutor.manual",
      "caption": "Manual"
    },
    "scheduleJobId": 20000001,
    "batchSize": 1000,
    "totalObjectCount": 5000,
    "readOnly": false,
    "profileId": 30000001,
    "unauthorized": false,
    "reverting": false,
    "reverted": false,
    "revertible": true,
    "revertedCount": 0,
    "revertPercentage": 0,
    "stage": {
      "name": "PROCESSING_MASS_INTER_COMPANY_TRANSFER",
      "captionKey": "enum.massInterCompanyTransferStage.processingMassInterCompanyTransfer",
      "caption": "Processing Mass Inter-Company Transfer"
    },
    "inputFile": {
      "templateFileStorageId": "template-file-uuid-12345",
      "inputFileStorageId": "input-file-uuid-67890",
      "generatingTemplateFile": false,
      "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
      "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
      "inputFileName": "mass_transfer_input_2024.xlsx",
      "templateDocStoreId": 40000001,
      "inputDocStoreId": 40000002
    },
    "filter": {
      "id": 10000001,
      "profileId": 30000001,
      "jobId": 10000001,
      "skipItemsWithOpenDraft": true,
      "filterTypes": {
        "erpSystemFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "erpSystems": [],
        "leaseAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseAreas": [],
        "businessUnitFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "businessUnits": [],
        "companyFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "companies": [],
        "leaseDepartmentFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseDepartments": [],
        "leaseGroupFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseGroups": [],
        "costCenterFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "costCenters": [],
        "profitCenterFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "profitCenters": [],
        "wbsFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "wbses": [],
        "businessAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "businessAreas": [],
        "functionalAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "functionalAreas": []
      },
      "listObjectType": {
        "name": "CONTRACT",
        "captionKey": "enum.listObjectType.contract",
        "caption": "Contract"
      },
      "objectList": []
    },
    "input": {
      "id": 10000001,
      "name": "Q1 2024 Inter-Company Transfer",
      "transferDate": "2024-03-31",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "postingDate": "2019-08-24",
      "documentDate": "2019-08-24",
      "skipItemsWithOpenDraft": true
    },
    "tasks": []
  }
}

Update Mass Inter-Company Transfer Job¶

HTTP Request

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

📋 Description: Updates the status or details of a specific mass inter-company transfer job identified by its unique ID within the Nakisa Lease Accounting Suite, facilitating accurate management of lease contracts and financial obligations.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	MassInterCompanyTransferJobDto	false	Request body containing the details of the mass inter-company transfer job, including lease and contract information, financial obligations, and accounting entries associated with the specified job ID.

Example Values¶

Parameter	Example	Type
id	`10000001`	path

Body Parameters

{
  "id": 10000001,
  "taskCount": 100,
  "failedTaskCount": 5,
  "doneTaskCount": 80,
  "inProgressTaskCount": 10,
  "cancelledTaskCount": 5,
  "errorMessage": "Failed to process transfer for contract ID 12345",
  "queueTime": "2024-01-15T10:30:00Z",
  "startTime": "2024-01-15T10:35:00Z",
  "endTime": "2024-01-15T12:00:00Z",
  "status": {
    "name": "PROCESSING",
    "captionKey": "enum.batchJobStatus.processing",
    "caption": "Processing"
  },
  "executor": {
    "name": "MANUAL",
    "captionKey": "enum.batchJobExecutor.manual",
    "caption": "Manual"
  },
  "scheduleJobId": 20000001,
  "batchSize": 1000,
  "totalObjectCount": 5000,
  "readOnly": false,
  "profileId": 30000001,
  "unauthorized": false,
  "reverting": false,
  "reverted": false,
  "revertible": true,
  "revertedCount": 0,
  "revertPercentage": 0,
  "stage": {
    "name": "PROCESSING_MASS_INTER_COMPANY_TRANSFER",
    "captionKey": "enum.massInterCompanyTransferStage.processingMassInterCompanyTransfer",
    "caption": "Processing Mass Inter-Company Transfer"
  },
  "inputFile": {
    "templateFileStorageId": "template-file-uuid-12345",
    "inputFileStorageId": "input-file-uuid-67890",
    "generatingTemplateFile": false,
    "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
    "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
    "inputFileName": "mass_transfer_input_2024.xlsx",
    "templateDocStoreId": 40000001,
    "inputDocStoreId": 40000002
  },
  "filter": {
    "id": 10000001,
    "profileId": 30000001,
    "jobId": 10000001,
    "skipItemsWithOpenDraft": true,
    "filterTypes": {
      "erpSystemFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "erpSystems": [],
      "leaseAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseAreas": [],
      "businessUnitFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "businessUnits": [],
      "companyFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "companies": [],
      "leaseDepartmentFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseDepartments": [],
      "leaseGroupFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseGroups": [],
      "costCenterFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "costCenters": [],
      "profitCenterFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "profitCenters": [],
      "wbsFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "wbses": [],
      "businessAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "businessAreas": [],
      "functionalAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "functionalAreas": []
    },
    "listObjectType": {
      "name": "CONTRACT",
      "captionKey": "enum.listObjectType.contract",
      "caption": "Contract"
    },
    "objectList": []
  },
  "input": {
    "id": 10000001,
    "name": "Q1 2024 Inter-Company Transfer",
    "transferDate": "2024-03-31",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "postingDate": "2019-08-24",
    "documentDate": "2019-08-24",
    "skipItemsWithOpenDraft": true
  },
  "tasks": []
}

Responses

Status	Meaning	Description	Schema
200	OK	Mass inter-company transfer job updated successfully	ResponseMassInterCompanyTransferJobDto
400	Bad Request	Invalid request body or ID supplied	None
404	Not Found	Mass inter-company transfer job not found	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "code": {
    "name": "OK",
    "captionKey": "enum.responseCode.ok",
    "caption": "OK"
  },
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000001,
    "taskCount": 100,
    "failedTaskCount": 5,
    "doneTaskCount": 80,
    "inProgressTaskCount": 10,
    "cancelledTaskCount": 5,
    "errorMessage": "Failed to process transfer for contract ID 12345",
    "queueTime": "2024-01-15T10:30:00Z",
    "startTime": "2024-01-15T10:35:00Z",
    "endTime": "2024-01-15T12:00:00Z",
    "status": {
      "name": "PROCESSING",
      "captionKey": "enum.batchJobStatus.processing",
      "caption": "Processing"
    },
    "executor": {
      "name": "MANUAL",
      "captionKey": "enum.batchJobExecutor.manual",
      "caption": "Manual"
    },
    "scheduleJobId": 20000001,
    "batchSize": 1000,
    "totalObjectCount": 5000,
    "readOnly": false,
    "profileId": 30000001,
    "unauthorized": false,
    "reverting": false,
    "reverted": false,
    "revertible": true,
    "revertedCount": 0,
    "revertPercentage": 0,
    "stage": {
      "name": "PROCESSING_MASS_INTER_COMPANY_TRANSFER",
      "captionKey": "enum.massInterCompanyTransferStage.processingMassInterCompanyTransfer",
      "caption": "Processing Mass Inter-Company Transfer"
    },
    "inputFile": {
      "templateFileStorageId": "template-file-uuid-12345",
      "inputFileStorageId": "input-file-uuid-67890",
      "generatingTemplateFile": false,
      "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
      "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
      "inputFileName": "mass_transfer_input_2024.xlsx",
      "templateDocStoreId": 40000001,
      "inputDocStoreId": 40000002
    },
    "filter": {
      "id": 10000001,
      "profileId": 30000001,
      "jobId": 10000001,
      "skipItemsWithOpenDraft": true,
      "filterTypes": {
        "erpSystemFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "erpSystems": [],
        "leaseAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseAreas": [],
        "businessUnitFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "businessUnits": [],
        "companyFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "companies": [],
        "leaseDepartmentFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseDepartments": [],
        "leaseGroupFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseGroups": [],
        "costCenterFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "costCenters": [],
        "profitCenterFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "profitCenters": [],
        "wbsFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "wbses": [],
        "businessAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "businessAreas": [],
        "functionalAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "functionalAreas": []
      },
      "listObjectType": {
        "name": "CONTRACT",
        "captionKey": "enum.listObjectType.contract",
        "caption": "Contract"
      },
      "objectList": []
    },
    "input": {
      "id": 10000001,
      "name": "Q1 2024 Inter-Company Transfer",
      "transferDate": "2024-03-31",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "postingDate": "2019-08-24",
      "documentDate": "2019-08-24",
      "skipItemsWithOpenDraft": true
    },
    "tasks": []
  }
}

Bulk Upsert Mass Inter-Company Transfer Jobs¶

HTTP Request

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

📋 Description: Creates or updates multiple inter-company transfer jobs in bulk within the Nakisa Lease Accounting Suite, streamlining the management of leases, contracts, and financial obligations for efficient accounting entry processing.

Parameters

Name	In	Type	Required	Description
body	body	MassInterCompanyTransferJobDto	false	Request body containing bulk data for creating or updating inter-company transfer jobs, including lease details, contract information, financial obligations, and associated accounting entries.

Body Parameters

[
  {
    "id": 10000001,
    "taskCount": 100,
    "failedTaskCount": 5,
    "doneTaskCount": 80,
    "inProgressTaskCount": 10,
    "cancelledTaskCount": 5,
    "errorMessage": "Failed to process transfer for contract ID 12345",
    "queueTime": "2024-01-15T10:30:00Z",
    "startTime": "2024-01-15T10:35:00Z",
    "endTime": "2024-01-15T12:00:00Z",
    "status": {
      "name": "PROCESSING",
      "captionKey": "enum.batchJobStatus.processing",
      "caption": "Processing"
    },
    "executor": {
      "name": "MANUAL",
      "captionKey": "enum.batchJobExecutor.manual",
      "caption": "Manual"
    },
    "scheduleJobId": 20000001,
    "batchSize": 1000,
    "totalObjectCount": 5000,
    "readOnly": false,
    "profileId": 30000001,
    "unauthorized": false,
    "reverting": false,
    "reverted": false,
    "revertible": true,
    "revertedCount": 0,
    "revertPercentage": 0,
    "stage": {
      "name": "PROCESSING_MASS_INTER_COMPANY_TRANSFER",
      "captionKey": "enum.massInterCompanyTransferStage.processingMassInterCompanyTransfer",
      "caption": "Processing Mass Inter-Company Transfer"
    },
    "inputFile": {
      "templateFileStorageId": "template-file-uuid-12345",
      "inputFileStorageId": "input-file-uuid-67890",
      "generatingTemplateFile": false,
      "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
      "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
      "inputFileName": "mass_transfer_input_2024.xlsx",
      "templateDocStoreId": 40000001,
      "inputDocStoreId": 40000002
    },
    "filter": {
      "id": 10000001,
      "profileId": 30000001,
      "jobId": 10000001,
      "skipItemsWithOpenDraft": true,
      "filterTypes": {
        "erpSystemFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "erpSystems": [],
        "leaseAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseAreas": [],
        "businessUnitFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "businessUnits": [],
        "companyFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "companies": [],
        "leaseDepartmentFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseDepartments": [],
        "leaseGroupFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseGroups": [],
        "costCenterFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "costCenters": [],
        "profitCenterFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "profitCenters": [],
        "wbsFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "wbses": [],
        "businessAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "businessAreas": [],
        "functionalAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "functionalAreas": []
      },
      "listObjectType": {
        "name": "CONTRACT",
        "captionKey": "enum.listObjectType.contract",
        "caption": "Contract"
      },
      "objectList": []
    },
    "input": {
      "id": 10000001,
      "name": "Q1 2024 Inter-Company Transfer",
      "transferDate": "2024-03-31",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "postingDate": "2019-08-24",
      "documentDate": "2019-08-24",
      "skipItemsWithOpenDraft": true
    },
    "tasks": []
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Mass inter-company transfer jobs created or updated successfully	ResponseListMassInterCompanyTransferJobDto
400	Bad Request	Invalid request body supplied	None
500	Internal Server Error	Internal server error	None

Example Responses

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

Upsert Mass Inter-Company Transfer Job¶

HTTP Request

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

📋 Description: Creates or updates mass inter-company transfer jobs within the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, and financial obligations while ensuring accurate accounting entries.

Parameters

Name	In	Type	Required	Description
body	body	MassInterCompanyTransferJobDto	false	Request body containing the lease and contract details necessary for creating or updating financial obligations and accounting entries related to inter-company transfers.

Body Parameters

{
  "id": 10000001,
  "taskCount": 100,
  "failedTaskCount": 5,
  "doneTaskCount": 80,
  "inProgressTaskCount": 10,
  "cancelledTaskCount": 5,
  "errorMessage": "Failed to process transfer for contract ID 12345",
  "queueTime": "2024-01-15T10:30:00Z",
  "startTime": "2024-01-15T10:35:00Z",
  "endTime": "2024-01-15T12:00:00Z",
  "status": {
    "name": "PROCESSING",
    "captionKey": "enum.batchJobStatus.processing",
    "caption": "Processing"
  },
  "executor": {
    "name": "MANUAL",
    "captionKey": "enum.batchJobExecutor.manual",
    "caption": "Manual"
  },
  "scheduleJobId": 20000001,
  "batchSize": 1000,
  "totalObjectCount": 5000,
  "readOnly": false,
  "profileId": 30000001,
  "unauthorized": false,
  "reverting": false,
  "reverted": false,
  "revertible": true,
  "revertedCount": 0,
  "revertPercentage": 0,
  "stage": {
    "name": "PROCESSING_MASS_INTER_COMPANY_TRANSFER",
    "captionKey": "enum.massInterCompanyTransferStage.processingMassInterCompanyTransfer",
    "caption": "Processing Mass Inter-Company Transfer"
  },
  "inputFile": {
    "templateFileStorageId": "template-file-uuid-12345",
    "inputFileStorageId": "input-file-uuid-67890",
    "generatingTemplateFile": false,
    "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
    "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
    "inputFileName": "mass_transfer_input_2024.xlsx",
    "templateDocStoreId": 40000001,
    "inputDocStoreId": 40000002
  },
  "filter": {
    "id": 10000001,
    "profileId": 30000001,
    "jobId": 10000001,
    "skipItemsWithOpenDraft": true,
    "filterTypes": {
      "erpSystemFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "erpSystems": [],
      "leaseAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseAreas": [],
      "businessUnitFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "businessUnits": [],
      "companyFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "companies": [],
      "leaseDepartmentFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseDepartments": [],
      "leaseGroupFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseGroups": [],
      "costCenterFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "costCenters": [],
      "profitCenterFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "profitCenters": [],
      "wbsFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "wbses": [],
      "businessAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "businessAreas": [],
      "functionalAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "functionalAreas": []
    },
    "listObjectType": {
      "name": "CONTRACT",
      "captionKey": "enum.listObjectType.contract",
      "caption": "Contract"
    },
    "objectList": []
  },
  "input": {
    "id": 10000001,
    "name": "Q1 2024 Inter-Company Transfer",
    "transferDate": "2024-03-31",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "postingDate": "2019-08-24",
    "documentDate": "2019-08-24",
    "skipItemsWithOpenDraft": true
  },
  "tasks": []
}

Responses

Status	Meaning	Description	Schema
200	OK	Mass inter-company transfer job created or updated successfully	ResponseMassInterCompanyTransferJobDto
400	Bad Request	Invalid request body supplied	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "code": {
    "name": "OK",
    "captionKey": "enum.responseCode.ok",
    "caption": "OK"
  },
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000001,
    "taskCount": 100,
    "failedTaskCount": 5,
    "doneTaskCount": 80,
    "inProgressTaskCount": 10,
    "cancelledTaskCount": 5,
    "errorMessage": "Failed to process transfer for contract ID 12345",
    "queueTime": "2024-01-15T10:30:00Z",
    "startTime": "2024-01-15T10:35:00Z",
    "endTime": "2024-01-15T12:00:00Z",
    "status": {
      "name": "PROCESSING",
      "captionKey": "enum.batchJobStatus.processing",
      "caption": "Processing"
    },
    "executor": {
      "name": "MANUAL",
      "captionKey": "enum.batchJobExecutor.manual",
      "caption": "Manual"
    },
    "scheduleJobId": 20000001,
    "batchSize": 1000,
    "totalObjectCount": 5000,
    "readOnly": false,
    "profileId": 30000001,
    "unauthorized": false,
    "reverting": false,
    "reverted": false,
    "revertible": true,
    "revertedCount": 0,
    "revertPercentage": 0,
    "stage": {
      "name": "PROCESSING_MASS_INTER_COMPANY_TRANSFER",
      "captionKey": "enum.massInterCompanyTransferStage.processingMassInterCompanyTransfer",
      "caption": "Processing Mass Inter-Company Transfer"
    },
    "inputFile": {
      "templateFileStorageId": "template-file-uuid-12345",
      "inputFileStorageId": "input-file-uuid-67890",
      "generatingTemplateFile": false,
      "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
      "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
      "inputFileName": "mass_transfer_input_2024.xlsx",
      "templateDocStoreId": 40000001,
      "inputDocStoreId": 40000002
    },
    "filter": {
      "id": 10000001,
      "profileId": 30000001,
      "jobId": 10000001,
      "skipItemsWithOpenDraft": true,
      "filterTypes": {
        "erpSystemFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "erpSystems": [],
        "leaseAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseAreas": [],
        "businessUnitFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "businessUnits": [],
        "companyFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "companies": [],
        "leaseDepartmentFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseDepartments": [],
        "leaseGroupFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseGroups": [],
        "costCenterFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "costCenters": [],
        "profitCenterFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "profitCenters": [],
        "wbsFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "wbses": [],
        "businessAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "businessAreas": [],
        "functionalAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "functionalAreas": []
      },
      "listObjectType": {
        "name": "CONTRACT",
        "captionKey": "enum.listObjectType.contract",
        "caption": "Contract"
      },
      "objectList": []
    },
    "input": {
      "id": 10000001,
      "name": "Q1 2024 Inter-Company Transfer",
      "transferDate": "2024-03-31",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "postingDate": "2019-08-24",
      "documentDate": "2019-08-24",
      "skipItemsWithOpenDraft": true
    },
    "tasks": []
  }
}

Bulk Update Mass Inter-Company Transfer Jobs¶

HTTP Request

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

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

Parameters

Name	In	Type	Required	Description
body	body	MassInterCompanyTransferJobDto	false	Request body containing the bulk data for inter-company transfer jobs, including lease details, contract information, financial obligations, and associated accounting entries.

Body Parameters

[
  {
    "id": 10000001,
    "taskCount": 100,
    "failedTaskCount": 5,
    "doneTaskCount": 80,
    "inProgressTaskCount": 10,
    "cancelledTaskCount": 5,
    "errorMessage": "Failed to process transfer for contract ID 12345",
    "queueTime": "2024-01-15T10:30:00Z",
    "startTime": "2024-01-15T10:35:00Z",
    "endTime": "2024-01-15T12:00:00Z",
    "status": {
      "name": "PROCESSING",
      "captionKey": "enum.batchJobStatus.processing",
      "caption": "Processing"
    },
    "executor": {
      "name": "MANUAL",
      "captionKey": "enum.batchJobExecutor.manual",
      "caption": "Manual"
    },
    "scheduleJobId": 20000001,
    "batchSize": 1000,
    "totalObjectCount": 5000,
    "readOnly": false,
    "profileId": 30000001,
    "unauthorized": false,
    "reverting": false,
    "reverted": false,
    "revertible": true,
    "revertedCount": 0,
    "revertPercentage": 0,
    "stage": {
      "name": "PROCESSING_MASS_INTER_COMPANY_TRANSFER",
      "captionKey": "enum.massInterCompanyTransferStage.processingMassInterCompanyTransfer",
      "caption": "Processing Mass Inter-Company Transfer"
    },
    "inputFile": {
      "templateFileStorageId": "template-file-uuid-12345",
      "inputFileStorageId": "input-file-uuid-67890",
      "generatingTemplateFile": false,
      "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
      "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
      "inputFileName": "mass_transfer_input_2024.xlsx",
      "templateDocStoreId": 40000001,
      "inputDocStoreId": 40000002
    },
    "filter": {
      "id": 10000001,
      "profileId": 30000001,
      "jobId": 10000001,
      "skipItemsWithOpenDraft": true,
      "filterTypes": {
        "erpSystemFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "erpSystems": [],
        "leaseAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseAreas": [],
        "businessUnitFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "businessUnits": [],
        "companyFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "companies": [],
        "leaseDepartmentFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseDepartments": [],
        "leaseGroupFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseGroups": [],
        "costCenterFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "costCenters": [],
        "profitCenterFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "profitCenters": [],
        "wbsFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "wbses": [],
        "businessAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "businessAreas": [],
        "functionalAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "functionalAreas": []
      },
      "listObjectType": {
        "name": "CONTRACT",
        "captionKey": "enum.listObjectType.contract",
        "caption": "Contract"
      },
      "objectList": []
    },
    "input": {
      "id": 10000001,
      "name": "Q1 2024 Inter-Company Transfer",
      "transferDate": "2024-03-31",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "postingDate": "2019-08-24",
      "documentDate": "2019-08-24",
      "skipItemsWithOpenDraft": true
    },
    "tasks": []
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Mass inter-company transfer jobs updated successfully	ResponseListMassInterCompanyTransferJobDto
400	Bad Request	Invalid request body supplied	None
500	Internal Server Error	Internal server error	None

Example Responses

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

Upload Input File For Mass Inter-Company Transfer Job¶

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/jobs/upload-input-file/{id}

📋 Description: Uploads an input file for mass inter-company transfer jobs identified by the specified ID, facilitating the management of leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite. This operation streamlines the process of creating accounting entries related to inter-company transactions.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Body Parameters

1{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

Search Mass Inter-Company Transfer Jobs¶

HTTP Request

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

📋 Description: Submits a request to search for mass inter-company transfer jobs within the Nakisa Lease Accounting Suite, enabling users to efficiently locate relevant lease and contract financial obligations and associated 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	MassInterCompanyTransferJobDtoFilter	false	Request body containing the search criteria for mass inter-company transfer jobs, including relevant lease, contract, financial obligation, and accounting entry details.

Example Values¶

Parameter	Example	Type
page	`0`	query
size	`100`	query

Default Values¶

Parameter	Default	Type
page	`0`	query
size	`100`	query
sort	`["createdAt,ASC"]`	query

Body Parameters

{
  "idIn": [
    10000001,
    10000002,
    10000003
  ],
  "idEqual": 10000001,
  "idLike": "10000",
  "createdAtGreaterThanOrEqual": "2024-01-01T00:00:00Z",
  "createdAtLessThanOrEqual": "2024-12-31T23:59:59Z",
  "createdByLike": "john",
  "createdByEqual": "john.doe@example.com",
  "modifiedAtGreaterThanOrEqual": "2024-01-01T00:00:00Z",
  "modifiedAtLessThanOrEqual": "2024-12-31T23:59:59Z",
  "modifiedByLike": "jane",
  "modifiedByEqual": "jane.smith@example.com",
  "executorEqual": {
    "name": "MANUAL",
    "captionKey": "enum.batchJobExecutor.manual",
    "caption": "Manual"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved mass inter-company transfer jobs	PageMassInterCompanyTransferJobDto
400	Bad Request	Invalid filter criteria or parameters supplied	None
500	Internal Server Error	Internal server error	None

Example Responses

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

Intercompanytransfer Job - Search Revertible Contracts¶

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/jobs/revertible-contracts

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» request	body	MassInterCompanyTransferJobListFilterTypeRequest	false	Data transfer object representing a filter for retrieving a list of mass intercompany transfer jobs within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and financial obligations in accounting entries.
»» jobId	body	integer(int64)	false	none
»» searchTerm	body	string	false	Search term used to filter and retrieve specific lease, contract, or financial obligation entries within the Mass InterCompany Transfer Job List in the Nakisa Lease Accounting Suite.
»» principalPositionType	body	PrincipalPositionType	false	Represents the type of principal position with localized captions.
»»» name	body	string	false	Enum name representing the principal position type.
»»» captionKey	body	string	false	Localization key for the principal position type caption.
»»» caption	body	string	false	Localized caption of the principal position type.
»» erpSystemFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»»» name	body	string	false	Enum name representing the filter type.
»»» captionKey	body	string	false	Localization key for the filter type caption.
»»» caption	body	string	false	Localized caption of the filter type.
»» erpSystems	body	[ErpSystemLite]	false	List of erpSystems items
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»»» name	body	string	false	Enum name representing the object status.
»»»» captionKey	body	string	false	Localization key for the object status caption.
»»»» active	body	boolean	false	Indicates whether the status is active.
»»»» caption	body	string	false	Localized caption of the object status.
»»» name	body	string	false	Name of the resource
»»» type	body	ErpSystemType	false	Represents the type of ERP system.
»»»» name	body	string	false	Enum name representing the ERP system type.
»»»» captionKey	body	string	false	Localization key for the ERP system type caption.
»»»» caption	body	string	false	Localized caption of the ERP system type.
»»» sapVersion	body	SapVersion	false	Represents the version of SAP system.
»»»» name	body	string	false	Enum name representing the SAP version.
»»»» captionKey	body	string	false	Localization key for the SAP version caption.
»»»» caption	body	string	false	Localized caption of the SAP version.
»» leaseAreaFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» leaseAreas	body	[LeaseAreaLite]	false	List of leaseAreas items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» businessUnitFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» businessUnits	body	[BusinessUnitLite]	false	List of businessUnits items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» companyFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» companies	body	[CompanyLite]	false	List of companies items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» erpSystemId	body	integer(int64)	false	Unique identifier for the erp system
»»» erpSystemDisplayId	body	string	false	Unique identifier for the erp system display
»»» countryId	body	integer(int64)	false	Unique identifier for the country
»»» countryDisplayId	body	string	false	Unique identifier for the country display
»»» name	body	string	false	none
»»» postingPeriodVariantId	body	integer(int64)	false	Unique identifier for the posting period variant
»»» fiscalVariantId	body	integer(int64)	false	Unique identifier for the fiscal variant
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of lease-related records, including contracts, financial obligations, and accounting entries, facilitating efficient data retrieval and management within the Nakisa Lease Accounting Suite.
»» page	body	integer(int32)	true	Page number for pagination
»» size	body	integer(int32)	true	Number of items per page
»» sort	body	[string]	false	Sort order specification

Example Values¶

Parameter	Example	Type
»» searchTerm	`Lease Agreement`	body
»»» name	`LESSEE`	body
»»» captionKey	`enum.principalpositiontype.lessee`	body
»»» caption	`Lessee`	body
»»» name	`ALL`	body
»»» captionKey	`enum.filterType.all`	body
»»» caption	`All`	body
»» erpSystems	`[]`	body
»»» id	`10000001`	body
»»» displayId	`ERP-001`	body
»»»» name	`ACTIVE`	body
»»»» captionKey	`enum.objectStatus.active`	body
»»»» active	`true`	body
»»»» caption	`Active`	body
»»» name	`SAP Production System`	body
»»»» name	`NAKISA`	body
»»»» captionKey	`enum.erpSystemType.NAKISA`	body
»»»» caption	`NAKISA`	body
»»»» name	`ECC_EHP5`	body
»»»» captionKey	`enum.sapVersion.ECC_EHP5`	body
»»»» caption	`ECC_EHP5`	body
»» leaseAreas	`[]`	body
»»» id	`10000001`	body
»»» displayId	`0001`	body
»»» name	`Global Lease Area`	body
»» businessUnits	`[]`	body
»»» id	`10000001`	body
»»» displayId	`BU0001`	body
»»» name	`North America Business Unit`	body
»» companies	`[]`	body
»»» id	`10000006`	body
»»» displayId	`1005`	body
»»» erpSystemId	`10000001`	body
»»» erpSystemDisplayId	`FINQ8S-300`	body
»»» countryId	`10000095`	body
»»» countryDisplayId	`CA`	body
»» page	`0`	body
»» size	`10`	body
»» sort	`["id,asc","name,desc"]`	body

Enumerated Values

Attribute	Value
»»» name	ALL, LESSEE, LESSOR, LIST
»»»» name	ACTIVE, CREATED, DECOMMISSIONED, DISABLED, ECC_EHP5, ECC_EHP6, ECC_EHP7, ECC_EHP8, NAKISA, S4_1503, S4_1610, S4_1709, S4_1809, S4_1909, SAP

Parameter Constraints¶

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "request": {
    "jobId": 0,
    "searchTerm": "Lease Agreement",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "erpSystemFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "erpSystems": [],
    "leaseAreaFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "leaseAreas": [],
    "businessUnitFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "businessUnits": [],
    "companyFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "companies": []
  },
  "pageable": {
    "page": 0,
    "size": 10,
    "sort": [
      "id,asc",
      "name,desc"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageContractDto

Example Responses

{
  "totalElements": 76,
  "totalPages": 1,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 76,
  "size": 100,
  "content": [
    {
      "id": 10000018,
      "displayId": "CT-100001000",
      "name": "Testtt Contract",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "validFrom": "2019-08-24",
      "validTo": "2019-08-24",
      "amendmentDate": "2019-08-24",
      "approverComment": "string",
      "contractPhase": "INITIAL",
      "dataCreationInfo": {
        "id": 10000001,
        "idGenerationType": {
          "name": "AUTO",
          "captionKey": "enum.idGenerationType.auto",
          "caption": "Auto"
        },
        "source": "sample_source",
        "type": {
          "name": "MIGRATION",
          "captionKey": "enum.dataType.migration",
          "caption": "Migration"
        },
        "startDateTime": "2025-01-01T10:00:00Z",
        "endDateTime": "2025-01-01T10:00:00Z"
      },
      "leaseType": {
        "name": "LEASE_CONTRACT_FIX",
        "captionKey": "enum.leaseType.fix",
        "principalPositionType": "LESSEE",
        "caption": "Fixed Lease Contract"
      },
      "revision": {
        "id": 10000008,
        "displayId": "CR-0001",
        "name": "Initial Revision",
        "inception": "2019-08-24",
        "revisionType": "ACTIVE",
        "state": "LC_DEFINE",
        "approvedBy": "manager.user@company.com",
        "approvedAt": "2019-08-24T14:15:22Z",
        "parentRevisionId": 10000010,
        "approverComment": "Approved with changes.",
        "contractId": 20000001,
        "contractDisplayId": "C-0001",
        "contractName": "Office Lease Contract",
        "principalPositionType": {
          "name": "LESSEE",
          "captionKey": "enum.principalpositiontype.lessee",
          "caption": "Lessee"
        },
        "mlaId": 30000001,
        "companyId": 40000001,
        "description": "Revision to adjust payment terms.",
        "externalReference": "EXT-REF-001",
        "internalReference": "INT-REF-001",
        "formOfLease": "FULL",
        "jointVentureLeaseType": "GROSS_LEASE",
        "businessPlace": "New York Office",
        "tradingPartner": {
          "id": 50000001,
          "displayId": "TP-0001",
          "status": {
            "name": "ACTIVE",
            "captionKey": "enum.objectStatus.active",
            "active": true,
            "caption": "Active"
          },
          "name": "ABC Real Estate Partners",
          "erpSystemId": 60000001,
          "erpSystemDisplayId": "ERP-SYS-01"
        },
        "contractCategoryGroup": {
          "id": 10000001,
          "displayId": "sample_displayId",
          "status": {
            "name": "ACTIVE",
            "captionKey": "enum.objectStatus.active",
            "active": true,
            "caption": "Active"
          },
          "name": "Sample Name"
        },
        "contractGroup1": {
          "id": 400001,
          "displayId": "CG1-01",
          "status": {
            "name": "ACTIVE",
            "captionKey": "enum.objectStatus.active",
            "active": true,
            "caption": "Active"
          },
          "name": "Real Estate Contracts"
        },
        "contractGroup2": {
          "id": 500001,
          "displayId": "CG2-01",
          "status": {
            "name": "ACTIVE",
            "captionKey": "enum.objectStatus.active",
            "active": true,
            "caption": "Active"
          },
          "name": "Equipment Leasing Contracts"
        },
        "group3": "Group3-Value",
        "group4": "Group4-Value",
        "signingPerson": "John Doe",
        "placeOfSignature": "Montreal, Canada",
        "dateOfSignature": "2019-08-24T14:15:22Z",
        "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
        "numberRangeIdentifierValue": "0001",
        "numberRangeIdentifierType": {
          "name": "COMPANY_CODE"
        },
        "numberRangeType": {
          "name": "CONTRACT"
        },
        "allowsSystemGenerateNewId": true
      },
      "currency": {
        "id": 840,
        "displayId": "USD",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "United States Dollar",
        "decimalPoints": 2
      },
      "companyCurrency": {
        "id": 840,
        "displayId": "USD",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "United States Dollar",
        "decimalPoints": 2
      },
      "indexedCurrency": true,
      "assetValueCurrencyType": "CONTRACT_CURRENCY",
      "currencyLocked": true,
      "leaseArea": {
        "id": 10000001,
        "displayId": "0001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Global Lease Area"
      },
      "businessUnit": {
        "id": 10000001,
        "displayId": "BU0001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "North America Business Unit"
      },
      "businessUnitLocked": true,
      "companyCode": {
        "id": 10000006,
        "displayId": "1005",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "erpSystemId": 10000001,
        "erpSystemDisplayId": "FINQ8S-300",
        "countryId": 10000095,
        "countryDisplayId": "CA",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      },
      "companyCodeLocked": true,
      "department": {
        "id": 300001,
        "displayId": "DEP-01",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Finance Department"
      },
      "departmentLocked": true,
      "leaseGroup": {
        "id": 60000001,
        "displayId": "LG-001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Global Lease Group"
      },
      "leaseGroupLocked": true,
      "subleasingInternalAssetClass": {
        "id": 10000001,
        "displayId": "IAC-001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Machinery and Equipment",
        "assetClassType": "PROPERTY",
        "infiniteUsefulLife": false
      },
      "contractGroup1": {
        "id": 400001,
        "displayId": "CG1-01",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Real Estate Contracts"
      },
      "contractGroup2": {
        "id": 500001,
        "displayId": "CG2-01",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Equipment Leasing Contracts"
      },
      "subleasing": false,
      "subleasingContractRevisionInfo": {
        "id": 50000001,
        "contractId": 40000001,
        "contractDisplayId": "CTR-0001",
        "contractName": "Sublease Agreement for Office Space"
      },
      "subleasingLeaseComponentRevisionInfo": {
        "id": 61000001,
        "leaseComponentId": 80000001,
        "leaseComponentDisplayId": "LC-0001",
        "leaseComponentName": "Vehicle Lease Component"
      },
      "subleasingActivationGroupRevisionInfo": {
        "id": 60000001,
        "activationGroupId": 70000001,
        "activationGroupDisplayId": "AG-001",
        "activationGroupName": "Office Equipment Activation Group"
      },
      "notifications": [
        {
          "id": 10000001,
          "topic": {
            "enCaption": "Lease Component Updated",
            "frCaption": "Composant de bail mis à jour",
            "name": "LEASE_COMPONENT_UPDATED",
            "priority": "HIGH"
          },
          "username": "super.admin@nakisa.com",
          "contractId": 10000001,
          "contractDisplayId": "CT-100000000",
          "targetId": "CT-100000000",
          "targetType": "CONTRACT"
        }
      ],
      "masterAgreementId": 10000001,
      "masterAgreementDisplayId": "string",
      "allowsSystemGenerateNewId": true,
      "transferInfo": {
        "transferredFromDisplayId": "CTR-00012",
        "transferredFromRevisionId": 20000001,
        "transferredToDisplayId": "CTR-00015",
        "transferredToRevisionId": 20000005
      },
      "numberRangeIdentifierValue": "",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      }
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": true,
  "empty": false
}

Intercompanytransfer Job - Revert Job¶

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/jobs/revert

Parameters

Name	In	Type	Required	Description
body	body	MassInterCompanyTransferRevertRequest	true	none

Body Parameters

{
  "jobId": 0,
  "contracts": [
    {
      "id": "string",
      "displayId": "Euro"
    }
  ],
  "reversalReason": {
    "id": 50000001,
    "displayId": "REV-001",
    "status": {
      "name": "ACTIVE",
      "captionKey": "enum.objectStatus.active",
      "active": true,
      "caption": "Active"
    },
    "name": "Incorrect Indexation",
    "erpSystemId": 60000001,
    "erpSystemDisplayId": "SAP-PROD"
  },
  "postingDate": "2019-08-24",
  "documentDate": "2019-08-24"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

Create New Mass Inter-Company Transfer Job (With Number Of Filtered Entities)¶

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/jobs/number-of-filtered-entities

📋 Description: Submits a request to retrieve the count of filtered entities related to mass inter-company transfers within the Nakisa Lease Accounting Suite, facilitating efficient management of leases, contracts, and financial obligations.

Parameters

Name	In	Type	Required	Description
body	body	MassInterCompanyTransferJob	false	Request body containing the criteria for filtering entities related to lease contracts and financial obligations for the mass inter-company transfer process.

Body Parameters

{
  "persistable": true,
  "id": 10000001,
  "createdBy": "john.doe@example.com",
  "createdAt": "2024-01-15T10:30:00Z",
  "modifiedBy": "jane.smith@example.com",
  "modifiedAt": "2024-01-15T14:45:00Z",
  "taskCount": 100,
  "failedTaskCount": 5,
  "doneTaskCount": 80,
  "inProgressTaskCount": 10,
  "cancelledTaskCount": 5,
  "errorMessage": "Failed to process transfer for contract ID 12345",
  "executor": {
    "name": "MANUAL",
    "captionKey": "enum.batchJobExecutor.manual",
    "caption": "Manual"
  },
  "scheduleJobId": 20000001,
  "batchSize": 1000,
  "totalObjectCount": 5000,
  "reverting": false,
  "reverted": false,
  "inputFile": {
    "templateFileStorageId": "template-file-uuid-12345",
    "inputFileStorageId": "input-file-uuid-67890",
    "generatingTemplateFile": false,
    "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
    "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
    "inputFileName": "mass_transfer_input_2024.xlsx",
    "templateDocStoreId": 40000001,
    "inputDocStoreId": 40000002
  },
  "input": {
    "persistable": true,
    "id": 10000001,
    "createdBy": "john.doe@example.com",
    "createdAt": "2024-01-15T10:30:00Z",
    "modifiedBy": "jane.smith@example.com",
    "modifiedAt": "2024-01-15T14:45:00Z",
    "name": "Q1 2024 Inter-Company Transfer",
    "transferDate": "2024-03-31",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "postingDate": "2019-08-24",
    "documentDate": "2019-08-24",
    "new": false
  },
  "filter": {
    "persistable": true,
    "id": 10000001,
    "createdBy": "john.doe@example.com",
    "createdAt": "2024-01-15T10:30:00Z",
    "modifiedBy": "jane.smith@example.com",
    "modifiedAt": "2024-01-15T14:45:00Z",
    "skipItemsWithOpenDraft": true,
    "filterTypes": {
      "erpSystemFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "businessUnitFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "companyFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseDepartmentFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseGroupFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "costCenterFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "profitCenterFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "wbsFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "businessAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "functionalAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      }
    },
    "baseIdList": [],
    "listObjectType": {
      "name": "CONTRACT",
      "captionKey": "enum.listObjectType.contract",
      "caption": "Contract"
    },
    "objectList": [],
    "new": false
  },
  "tasks": [],
  "scheduledJob": false,
  "new": false
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved number of filtered entities	integer
400	Bad Request	Invalid request body supplied	None
500	Internal Server Error	Internal server error	None

Example Responses

Get Master Agreements For Mass Inter-Company Transfer Job¶

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/jobs/master-agreements

📋 Description: Creates master agreements for mass inter-company transfers within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and associated financial obligations.

Parameters

Name	In	Type	Required	Description
body	body	object	true	Request body containing the master agreement details for inter-company transfers, including lease and contract information essential for managing financial obligations and accounting entries.
» request	body	MassInterCompanyTransferJobListFilterTypeRequest	false	Data transfer object representing a filter for retrieving a list of mass intercompany transfer jobs within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and financial obligations in accounting entries.
»» jobId	body	integer(int64)	false	none
»» searchTerm	body	string	false	Search term used to filter and retrieve specific lease, contract, or financial obligation entries within the Mass InterCompany Transfer Job List in the Nakisa Lease Accounting Suite.
»» principalPositionType	body	PrincipalPositionType	false	Represents the type of principal position with localized captions.
»»» name	body	string	false	Enum name representing the principal position type.
»»» captionKey	body	string	false	Localization key for the principal position type caption.
»»» caption	body	string	false	Localized caption of the principal position type.
»» erpSystemFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»»» name	body	string	false	Enum name representing the filter type.
»»» captionKey	body	string	false	Localization key for the filter type caption.
»»» caption	body	string	false	Localized caption of the filter type.
»» erpSystems	body	[ErpSystemLite]	false	List of erpSystems items
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»»» name	body	string	false	Enum name representing the object status.
»»»» captionKey	body	string	false	Localization key for the object status caption.
»»»» active	body	boolean	false	Indicates whether the status is active.
»»»» caption	body	string	false	Localized caption of the object status.
»»» name	body	string	false	Name of the resource
»»» type	body	ErpSystemType	false	Represents the type of ERP system.
»»»» name	body	string	false	Enum name representing the ERP system type.
»»»» captionKey	body	string	false	Localization key for the ERP system type caption.
»»»» caption	body	string	false	Localized caption of the ERP system type.
»»» sapVersion	body	SapVersion	false	Represents the version of SAP system.
»»»» name	body	string	false	Enum name representing the SAP version.
»»»» captionKey	body	string	false	Localization key for the SAP version caption.
»»»» caption	body	string	false	Localized caption of the SAP version.
»» leaseAreaFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» leaseAreas	body	[LeaseAreaLite]	false	List of leaseAreas items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» businessUnitFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» businessUnits	body	[BusinessUnitLite]	false	List of businessUnits items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» companyFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» companies	body	[CompanyLite]	false	List of companies items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» erpSystemId	body	integer(int64)	false	Unique identifier for the erp system
»»» erpSystemDisplayId	body	string	false	Unique identifier for the erp system display
»»» countryId	body	integer(int64)	false	Unique identifier for the country
»»» countryDisplayId	body	string	false	Unique identifier for the country display
»»» name	body	string	false	none
»»» postingPeriodVariantId	body	integer(int64)	false	Unique identifier for the posting period variant
»»» fiscalVariantId	body	integer(int64)	false	Unique identifier for the fiscal variant
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of lease-related records, including contracts, financial obligations, and accounting entries, facilitating efficient data retrieval and management within the Nakisa Lease Accounting Suite.
»» page	body	integer(int32)	true	Page number for pagination
»» size	body	integer(int32)	true	Number of items per page
»» sort	body	[string]	false	Sort order specification

Example Values¶

Parameter	Example	Type
»» searchTerm	`Lease Agreement`	body
»»» name	`LESSEE`	body
»»» captionKey	`enum.principalpositiontype.lessee`	body
»»» caption	`Lessee`	body
»»» name	`ALL`	body
»»» captionKey	`enum.filterType.all`	body
»»» caption	`All`	body
»» erpSystems	`[]`	body
»»» id	`10000001`	body
»»» displayId	`ERP-001`	body
»»»» name	`ACTIVE`	body
»»»» captionKey	`enum.objectStatus.active`	body
»»»» active	`true`	body
»»»» caption	`Active`	body
»»» name	`SAP Production System`	body
»»»» name	`NAKISA`	body
»»»» captionKey	`enum.erpSystemType.NAKISA`	body
»»»» caption	`NAKISA`	body
»»»» name	`ECC_EHP5`	body
»»»» captionKey	`enum.sapVersion.ECC_EHP5`	body
»»»» caption	`ECC_EHP5`	body
»» leaseAreas	`[]`	body
»»» id	`10000001`	body
»»» displayId	`0001`	body
»»» name	`Global Lease Area`	body
»» businessUnits	`[]`	body
»»» id	`10000001`	body
»»» displayId	`BU0001`	body
»»» name	`North America Business Unit`	body
»» companies	`[]`	body
»»» id	`10000006`	body
»»» displayId	`1005`	body
»»» erpSystemId	`10000001`	body
»»» erpSystemDisplayId	`FINQ8S-300`	body
»»» countryId	`10000095`	body
»»» countryDisplayId	`CA`	body
»» page	`0`	body
»» size	`10`	body
»» sort	`["id,asc","name,desc"]`	body

Enumerated Values

Attribute	Value
»»» name	ALL, LESSEE, LESSOR, LIST
»»»» name	ACTIVE, CREATED, DECOMMISSIONED, DISABLED, ECC_EHP5, ECC_EHP6, ECC_EHP7, ECC_EHP8, NAKISA, S4_1503, S4_1610, S4_1709, S4_1809, S4_1909, SAP

Parameter Constraints¶

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "request": {
    "jobId": 0,
    "searchTerm": "Lease Agreement",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "erpSystemFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "erpSystems": [],
    "leaseAreaFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "leaseAreas": [],
    "businessUnitFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "businessUnits": [],
    "companyFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "companies": []
  },
  "pageable": {
    "page": 0,
    "size": 10,
    "sort": [
      "id,asc",
      "name,desc"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved master agreements	PageMasterAgreementDto
400	Bad Request	Invalid request body supplied	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "totalElements": 76,
  "totalPages": 1,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 76,
  "size": 100,
  "content": [
    {
      "id": 10000086,
      "displayId": "MA-2025-0001",
      "year": 2023,
      "name": "Global HQ Lease Agreement",
      "description": "Master lease agreement for HQ premises.",
      "validFrom": "2019-08-24",
      "validTo": "2019-08-24",
      "targetValue": 1000000,
      "legalJurisdiction": "Germany",
      "approverComment": "Reviewed and approved by legal team.",
      "signingPerson": "John Doe",
      "placeOfSignature": "Berlin, Germany",
      "dateOfSignature": "2019-08-24",
      "state": {
        "name": "MLA_ACTIVE",
        "captionKey": "enum.mlaStatus.mlaActive",
        "caption": "Active"
      },
      "dataCreationInfo": {
        "id": 10000001,
        "idGenerationType": {
          "name": "AUTO",
          "captionKey": "enum.idGenerationType.auto",
          "caption": "Auto"
        },
        "source": "sample_source",
        "type": {
          "name": "MIGRATION",
          "captionKey": "enum.dataType.migration",
          "caption": "Migration"
        },
        "startDateTime": "2025-01-01T10:00:00Z",
        "endDateTime": "2025-01-01T10:00:00Z"
      },
      "agreementGroup": {
        "id": 20000001,
        "displayId": "AG-001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Global Agreement Group"
      },
      "currency": {
        "id": 840,
        "displayId": "USD",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "United States Dollar",
        "decimalPoints": 2
      },
      "internalAssetClass": {
        "id": 10000001,
        "displayId": "IAC-001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Machinery and Equipment",
        "assetClassType": "PROPERTY",
        "infiniteUsefulLife": false
      },
      "leaseArea": {
        "id": 10000001,
        "displayId": "0001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Global Lease Area"
      },
      "businessUnit": {
        "id": 10000001,
        "displayId": "BU0001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "North America Business Unit"
      },
      "companyCode": {
        "id": 10000006,
        "displayId": "1005",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "erpSystemId": 10000001,
        "erpSystemDisplayId": "FINQ8S-300",
        "countryId": 10000095,
        "countryDisplayId": "CA",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      },
      "department": {
        "id": 300001,
        "displayId": "DEP-01",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Finance Department"
      },
      "leaseGroup": {
        "id": 60000001,
        "displayId": "LG-001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Global Lease Group"
      },
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "0001",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      }
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": true,
  "empty": false
}

Get Lease Components For Mass Inter-Company Transfer Job¶

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/jobs/lease-components

📋 Description: Creates new lease component records for mass inter-company transfers within the Nakisa Lease Accounting Suite, facilitating the management of financial obligations and accounting entries related to lease contracts.

Parameters

Name	In	Type	Required	Description
body	body	object	true	Request body containing the lease component data necessary for executing mass inter-company transfers, including details on contracts, financial obligations, and accounting entries.
» request	body	MassInterCompanyTransferJobListFilterTypeRequest	false	Data transfer object representing a filter for retrieving a list of mass intercompany transfer jobs within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and financial obligations in accounting entries.
»» jobId	body	integer(int64)	false	none
»» searchTerm	body	string	false	Search term used to filter and retrieve specific lease, contract, or financial obligation entries within the Mass InterCompany Transfer Job List in the Nakisa Lease Accounting Suite.
»» principalPositionType	body	PrincipalPositionType	false	Represents the type of principal position with localized captions.
»»» name	body	string	false	Enum name representing the principal position type.
»»» captionKey	body	string	false	Localization key for the principal position type caption.
»»» caption	body	string	false	Localized caption of the principal position type.
»» erpSystemFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»»» name	body	string	false	Enum name representing the filter type.
»»» captionKey	body	string	false	Localization key for the filter type caption.
»»» caption	body	string	false	Localized caption of the filter type.
»» erpSystems	body	[ErpSystemLite]	false	List of erpSystems items
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»»» name	body	string	false	Enum name representing the object status.
»»»» captionKey	body	string	false	Localization key for the object status caption.
»»»» active	body	boolean	false	Indicates whether the status is active.
»»»» caption	body	string	false	Localized caption of the object status.
»»» name	body	string	false	Name of the resource
»»» type	body	ErpSystemType	false	Represents the type of ERP system.
»»»» name	body	string	false	Enum name representing the ERP system type.
»»»» captionKey	body	string	false	Localization key for the ERP system type caption.
»»»» caption	body	string	false	Localized caption of the ERP system type.
»»» sapVersion	body	SapVersion	false	Represents the version of SAP system.
»»»» name	body	string	false	Enum name representing the SAP version.
»»»» captionKey	body	string	false	Localization key for the SAP version caption.
»»»» caption	body	string	false	Localized caption of the SAP version.
»» leaseAreaFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» leaseAreas	body	[LeaseAreaLite]	false	List of leaseAreas items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» businessUnitFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» businessUnits	body	[BusinessUnitLite]	false	List of businessUnits items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» companyFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» companies	body	[CompanyLite]	false	List of companies items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» erpSystemId	body	integer(int64)	false	Unique identifier for the erp system
»»» erpSystemDisplayId	body	string	false	Unique identifier for the erp system display
»»» countryId	body	integer(int64)	false	Unique identifier for the country
»»» countryDisplayId	body	string	false	Unique identifier for the country display
»»» name	body	string	false	none
»»» postingPeriodVariantId	body	integer(int64)	false	Unique identifier for the posting period variant
»»» fiscalVariantId	body	integer(int64)	false	Unique identifier for the fiscal variant
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of lease-related records, including contracts, financial obligations, and accounting entries, facilitating efficient data retrieval and management within the Nakisa Lease Accounting Suite.
»» page	body	integer(int32)	true	Page number for pagination
»» size	body	integer(int32)	true	Number of items per page
»» sort	body	[string]	false	Sort order specification

Example Values¶

Parameter	Example	Type
»» searchTerm	`Lease Agreement`	body
»»» name	`LESSEE`	body
»»» captionKey	`enum.principalpositiontype.lessee`	body
»»» caption	`Lessee`	body
»»» name	`ALL`	body
»»» captionKey	`enum.filterType.all`	body
»»» caption	`All`	body
»» erpSystems	`[]`	body
»»» id	`10000001`	body
»»» displayId	`ERP-001`	body
»»»» name	`ACTIVE`	body
»»»» captionKey	`enum.objectStatus.active`	body
»»»» active	`true`	body
»»»» caption	`Active`	body
»»» name	`SAP Production System`	body
»»»» name	`NAKISA`	body
»»»» captionKey	`enum.erpSystemType.NAKISA`	body
»»»» caption	`NAKISA`	body
»»»» name	`ECC_EHP5`	body
»»»» captionKey	`enum.sapVersion.ECC_EHP5`	body
»»»» caption	`ECC_EHP5`	body
»» leaseAreas	`[]`	body
»»» id	`10000001`	body
»»» displayId	`0001`	body
»»» name	`Global Lease Area`	body
»» businessUnits	`[]`	body
»»» id	`10000001`	body
»»» displayId	`BU0001`	body
»»» name	`North America Business Unit`	body
»» companies	`[]`	body
»»» id	`10000006`	body
»»» displayId	`1005`	body
»»» erpSystemId	`10000001`	body
»»» erpSystemDisplayId	`FINQ8S-300`	body
»»» countryId	`10000095`	body
»»» countryDisplayId	`CA`	body
»» page	`0`	body
»» size	`10`	body
»» sort	`["id,asc","name,desc"]`	body

Enumerated Values

Attribute	Value
»»» name	ALL, LESSEE, LESSOR, LIST
»»»» name	ACTIVE, CREATED, DECOMMISSIONED, DISABLED, ECC_EHP5, ECC_EHP6, ECC_EHP7, ECC_EHP8, NAKISA, S4_1503, S4_1610, S4_1709, S4_1809, S4_1909, SAP

Parameter Constraints¶

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "request": {
    "jobId": 0,
    "searchTerm": "Lease Agreement",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "erpSystemFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "erpSystems": [],
    "leaseAreaFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "leaseAreas": [],
    "businessUnitFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "businessUnits": [],
    "companyFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "companies": []
  },
  "pageable": {
    "page": 0,
    "size": 10,
    "sort": [
      "id,asc",
      "name,desc"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved lease components	PageLeaseComponentDto
400	Bad Request	Invalid request body supplied	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "totalElements": 76,
  "totalPages": 1,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 76,
  "size": 100,
  "content": [
    {
      "id": 10000003,
      "displayId": "LC-100000002",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "name": "patched lease component",
      "description": "string",
      "bulkAsset": false,
      "rouStartDate": "2019-08-24",
      "rouEndDate": "2019-08-24",
      "approverComment": "string",
      "fairMarketValue": 0,
      "allocationNumber": "string",
      "guaranteedResidualValue": 0,
      "unitDistributions": [],
      "revision": {
        "id": 10000003,
        "displayId": "0461332847-20250827-142605",
        "name": "Inception",
        "inception": true,
        "revisionType": "ACTIVE",
        "state": "LC_DEFINE",
        "approvedBy": "string",
        "approvedAt": "2019-08-24",
        "parentRevisionId": 0,
        "approverComment": "string",
        "leaseComponentId": 10000003,
        "leaseComponentDisplayId": "LC-100000002",
        "leaseComponentName": "Test2 lease component",
        "contractRevisionId": 10000001,
        "contractRevisionDisplayId": "1617141777-20250724-115809",
        "numberRangeIdentifierValue": "string",
        "numberRangeIdentifierType": {
          "name": "COMPANY_CODE"
        },
        "numberRangeType": {
          "name": "CONTRACT"
        },
        "allowsSystemGenerateNewId": false
      },
      "internalAssetClass": {
        "id": 10000001,
        "displayId": "IAC-001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Machinery and Equipment",
        "assetClassType": "PROPERTY",
        "infiniteUsefulLife": false
      },
      "unitOfMeasure": {
        "id": 10000198,
        "displayId": "MPA",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Megapascal",
        "erpSystemId": 10000001
      },
      "notifications": [],
      "spreadingFrequency": "NONE",
      "contractId": 10000001,
      "contractDisplayId": "CT-100000000",
      "companyCodeId": 10000002,
      "companyCodeDisplayId": "string",
      "userDeterminedLeaseType": {
        "name": "LEASE_CONTRACT_FIX",
        "captionKey": "enum.leaseType.fix",
        "principalPositionType": "LESSEE",
        "caption": "Fixed Lease Contract"
      },
      "endOfTermDate": "2019-08-24",
      "endOfTermPeriod": "string",
      "allowsSystemGenerateNewId": false,
      "transferInfo": {
        "transferredFromDisplayId": "CTR-00012",
        "transferredFromRevisionId": 20000001,
        "transferredToDisplayId": "CTR-00015",
        "transferredToRevisionId": 20000005
      },
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "type": "LESSEE"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": true,
  "empty": false
}

Get Contracts For Mass Inter-Company Transfer Job¶

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/jobs/contracts

📋 Description: Initiates a batch job for mass inter-company transfers by submitting contract data, facilitating streamlined management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
body	body	object	true	Request body containing the details of lease contracts for mass inter-company transfers, including associated financial obligations and accounting entries.
» request	body	MassInterCompanyTransferJobListFilterTypeRequest	false	Data transfer object representing a filter for retrieving a list of mass intercompany transfer jobs within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and financial obligations in accounting entries.
»» jobId	body	integer(int64)	false	none
»» searchTerm	body	string	false	Search term used to filter and retrieve specific lease, contract, or financial obligation entries within the Mass InterCompany Transfer Job List in the Nakisa Lease Accounting Suite.
»» principalPositionType	body	PrincipalPositionType	false	Represents the type of principal position with localized captions.
»»» name	body	string	false	Enum name representing the principal position type.
»»» captionKey	body	string	false	Localization key for the principal position type caption.
»»» caption	body	string	false	Localized caption of the principal position type.
»» erpSystemFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»»» name	body	string	false	Enum name representing the filter type.
»»» captionKey	body	string	false	Localization key for the filter type caption.
»»» caption	body	string	false	Localized caption of the filter type.
»» erpSystems	body	[ErpSystemLite]	false	List of erpSystems items
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»»» name	body	string	false	Enum name representing the object status.
»»»» captionKey	body	string	false	Localization key for the object status caption.
»»»» active	body	boolean	false	Indicates whether the status is active.
»»»» caption	body	string	false	Localized caption of the object status.
»»» name	body	string	false	Name of the resource
»»» type	body	ErpSystemType	false	Represents the type of ERP system.
»»»» name	body	string	false	Enum name representing the ERP system type.
»»»» captionKey	body	string	false	Localization key for the ERP system type caption.
»»»» caption	body	string	false	Localized caption of the ERP system type.
»»» sapVersion	body	SapVersion	false	Represents the version of SAP system.
»»»» name	body	string	false	Enum name representing the SAP version.
»»»» captionKey	body	string	false	Localization key for the SAP version caption.
»»»» caption	body	string	false	Localized caption of the SAP version.
»» leaseAreaFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» leaseAreas	body	[LeaseAreaLite]	false	List of leaseAreas items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» businessUnitFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» businessUnits	body	[BusinessUnitLite]	false	List of businessUnits items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» companyFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» companies	body	[CompanyLite]	false	List of companies items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» erpSystemId	body	integer(int64)	false	Unique identifier for the erp system
»»» erpSystemDisplayId	body	string	false	Unique identifier for the erp system display
»»» countryId	body	integer(int64)	false	Unique identifier for the country
»»» countryDisplayId	body	string	false	Unique identifier for the country display
»»» name	body	string	false	none
»»» postingPeriodVariantId	body	integer(int64)	false	Unique identifier for the posting period variant
»»» fiscalVariantId	body	integer(int64)	false	Unique identifier for the fiscal variant
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of lease-related records, including contracts, financial obligations, and accounting entries, facilitating efficient data retrieval and management within the Nakisa Lease Accounting Suite.
»» page	body	integer(int32)	true	Page number for pagination
»» size	body	integer(int32)	true	Number of items per page
»» sort	body	[string]	false	Sort order specification

Example Values¶

Parameter	Example	Type
»» searchTerm	`Lease Agreement`	body
»»» name	`LESSEE`	body
»»» captionKey	`enum.principalpositiontype.lessee`	body
»»» caption	`Lessee`	body
»»» name	`ALL`	body
»»» captionKey	`enum.filterType.all`	body
»»» caption	`All`	body
»» erpSystems	`[]`	body
»»» id	`10000001`	body
»»» displayId	`ERP-001`	body
»»»» name	`ACTIVE`	body
»»»» captionKey	`enum.objectStatus.active`	body
»»»» active	`true`	body
»»»» caption	`Active`	body
»»» name	`SAP Production System`	body
»»»» name	`NAKISA`	body
»»»» captionKey	`enum.erpSystemType.NAKISA`	body
»»»» caption	`NAKISA`	body
»»»» name	`ECC_EHP5`	body
»»»» captionKey	`enum.sapVersion.ECC_EHP5`	body
»»»» caption	`ECC_EHP5`	body
»» leaseAreas	`[]`	body
»»» id	`10000001`	body
»»» displayId	`0001`	body
»»» name	`Global Lease Area`	body
»» businessUnits	`[]`	body
»»» id	`10000001`	body
»»» displayId	`BU0001`	body
»»» name	`North America Business Unit`	body
»» companies	`[]`	body
»»» id	`10000006`	body
»»» displayId	`1005`	body
»»» erpSystemId	`10000001`	body
»»» erpSystemDisplayId	`FINQ8S-300`	body
»»» countryId	`10000095`	body
»»» countryDisplayId	`CA`	body
»» page	`0`	body
»» size	`10`	body
»» sort	`["id,asc","name,desc"]`	body

Enumerated Values

Attribute	Value
»»» name	ALL, LESSEE, LESSOR, LIST
»»»» name	ACTIVE, CREATED, DECOMMISSIONED, DISABLED, ECC_EHP5, ECC_EHP6, ECC_EHP7, ECC_EHP8, NAKISA, S4_1503, S4_1610, S4_1709, S4_1809, S4_1909, SAP

Parameter Constraints¶

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "request": {
    "jobId": 0,
    "searchTerm": "Lease Agreement",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "erpSystemFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "erpSystems": [],
    "leaseAreaFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "leaseAreas": [],
    "businessUnitFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "businessUnits": [],
    "companyFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "companies": []
  },
  "pageable": {
    "page": 0,
    "size": 10,
    "sort": [
      "id,asc",
      "name,desc"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved contracts	PageContractDto
400	Bad Request	Invalid request body supplied	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "totalElements": 76,
  "totalPages": 1,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 76,
  "size": 100,
  "content": [
    {
      "id": 10000018,
      "displayId": "CT-100001000",
      "name": "Testtt Contract",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "validFrom": "2019-08-24",
      "validTo": "2019-08-24",
      "amendmentDate": "2019-08-24",
      "approverComment": "string",
      "contractPhase": "INITIAL",
      "dataCreationInfo": {
        "id": 10000001,
        "idGenerationType": {
          "name": "AUTO",
          "captionKey": "enum.idGenerationType.auto",
          "caption": "Auto"
        },
        "source": "sample_source",
        "type": {
          "name": "MIGRATION",
          "captionKey": "enum.dataType.migration",
          "caption": "Migration"
        },
        "startDateTime": "2025-01-01T10:00:00Z",
        "endDateTime": "2025-01-01T10:00:00Z"
      },
      "leaseType": {
        "name": "LEASE_CONTRACT_FIX",
        "captionKey": "enum.leaseType.fix",
        "principalPositionType": "LESSEE",
        "caption": "Fixed Lease Contract"
      },
      "revision": {
        "id": 10000008,
        "displayId": "CR-0001",
        "name": "Initial Revision",
        "inception": "2019-08-24",
        "revisionType": "ACTIVE",
        "state": "LC_DEFINE",
        "approvedBy": "manager.user@company.com",
        "approvedAt": "2019-08-24T14:15:22Z",
        "parentRevisionId": 10000010,
        "approverComment": "Approved with changes.",
        "contractId": 20000001,
        "contractDisplayId": "C-0001",
        "contractName": "Office Lease Contract",
        "principalPositionType": {
          "name": "LESSEE",
          "captionKey": "enum.principalpositiontype.lessee",
          "caption": "Lessee"
        },
        "mlaId": 30000001,
        "companyId": 40000001,
        "description": "Revision to adjust payment terms.",
        "externalReference": "EXT-REF-001",
        "internalReference": "INT-REF-001",
        "formOfLease": "FULL",
        "jointVentureLeaseType": "GROSS_LEASE",
        "businessPlace": "New York Office",
        "tradingPartner": {
          "id": 50000001,
          "displayId": "TP-0001",
          "status": {
            "name": "ACTIVE",
            "captionKey": "enum.objectStatus.active",
            "active": true,
            "caption": "Active"
          },
          "name": "ABC Real Estate Partners",
          "erpSystemId": 60000001,
          "erpSystemDisplayId": "ERP-SYS-01"
        },
        "contractCategoryGroup": {
          "id": 10000001,
          "displayId": "sample_displayId",
          "status": {
            "name": "ACTIVE",
            "captionKey": "enum.objectStatus.active",
            "active": true,
            "caption": "Active"
          },
          "name": "Sample Name"
        },
        "contractGroup1": {
          "id": 400001,
          "displayId": "CG1-01",
          "status": {
            "name": "ACTIVE",
            "captionKey": "enum.objectStatus.active",
            "active": true,
            "caption": "Active"
          },
          "name": "Real Estate Contracts"
        },
        "contractGroup2": {
          "id": 500001,
          "displayId": "CG2-01",
          "status": {
            "name": "ACTIVE",
            "captionKey": "enum.objectStatus.active",
            "active": true,
            "caption": "Active"
          },
          "name": "Equipment Leasing Contracts"
        },
        "group3": "Group3-Value",
        "group4": "Group4-Value",
        "signingPerson": "John Doe",
        "placeOfSignature": "Montreal, Canada",
        "dateOfSignature": "2019-08-24T14:15:22Z",
        "leaseType": "LEASE_CONTRACT_FIXED_PART_A",
        "numberRangeIdentifierValue": "0001",
        "numberRangeIdentifierType": {
          "name": "COMPANY_CODE"
        },
        "numberRangeType": {
          "name": "CONTRACT"
        },
        "allowsSystemGenerateNewId": true
      },
      "currency": {
        "id": 840,
        "displayId": "USD",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "United States Dollar",
        "decimalPoints": 2
      },
      "companyCurrency": {
        "id": 840,
        "displayId": "USD",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "United States Dollar",
        "decimalPoints": 2
      },
      "indexedCurrency": true,
      "assetValueCurrencyType": "CONTRACT_CURRENCY",
      "currencyLocked": true,
      "leaseArea": {
        "id": 10000001,
        "displayId": "0001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Global Lease Area"
      },
      "businessUnit": {
        "id": 10000001,
        "displayId": "BU0001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "North America Business Unit"
      },
      "businessUnitLocked": true,
      "companyCode": {
        "id": 10000006,
        "displayId": "1005",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "erpSystemId": 10000001,
        "erpSystemDisplayId": "FINQ8S-300",
        "countryId": 10000095,
        "countryDisplayId": "CA",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      },
      "companyCodeLocked": true,
      "department": {
        "id": 300001,
        "displayId": "DEP-01",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Finance Department"
      },
      "departmentLocked": true,
      "leaseGroup": {
        "id": 60000001,
        "displayId": "LG-001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Global Lease Group"
      },
      "leaseGroupLocked": true,
      "subleasingInternalAssetClass": {
        "id": 10000001,
        "displayId": "IAC-001",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Machinery and Equipment",
        "assetClassType": "PROPERTY",
        "infiniteUsefulLife": false
      },
      "contractGroup1": {
        "id": 400001,
        "displayId": "CG1-01",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Real Estate Contracts"
      },
      "contractGroup2": {
        "id": 500001,
        "displayId": "CG2-01",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Equipment Leasing Contracts"
      },
      "subleasing": false,
      "subleasingContractRevisionInfo": {
        "id": 50000001,
        "contractId": 40000001,
        "contractDisplayId": "CTR-0001",
        "contractName": "Sublease Agreement for Office Space"
      },
      "subleasingLeaseComponentRevisionInfo": {
        "id": 61000001,
        "leaseComponentId": 80000001,
        "leaseComponentDisplayId": "LC-0001",
        "leaseComponentName": "Vehicle Lease Component"
      },
      "subleasingActivationGroupRevisionInfo": {
        "id": 60000001,
        "activationGroupId": 70000001,
        "activationGroupDisplayId": "AG-001",
        "activationGroupName": "Office Equipment Activation Group"
      },
      "notifications": [
        {
          "id": 10000001,
          "topic": {
            "enCaption": "Lease Component Updated",
            "frCaption": "Composant de bail mis à jour",
            "name": "LEASE_COMPONENT_UPDATED",
            "priority": "HIGH"
          },
          "username": "super.admin@nakisa.com",
          "contractId": 10000001,
          "contractDisplayId": "CT-100000000",
          "targetId": "CT-100000000",
          "targetType": "CONTRACT"
        }
      ],
      "masterAgreementId": 10000001,
      "masterAgreementDisplayId": "string",
      "allowsSystemGenerateNewId": true,
      "transferInfo": {
        "transferredFromDisplayId": "CTR-00012",
        "transferredFromRevisionId": 20000001,
        "transferredToDisplayId": "CTR-00015",
        "transferredToRevisionId": 20000005
      },
      "numberRangeIdentifierValue": "",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      }
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": true,
  "empty": false
}

Cancel Mass Inter-Company Transfer Job¶

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/jobs/cancel/{jobId}

📋 Description: Cancels a specified mass inter-company transfer job identified by the provided jobId, ensuring that any associated lease, contract, or financial obligation entries are appropriately managed within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
jobId	path	integer(int64)	true	Unique identifier for the job

Example Values¶

Parameter	Example	Type
jobId	`10000001`	path

Responses

Status	Meaning	Description	Schema
200	OK	Mass inter-company transfer job cancelled successfully	None
400	Bad Request	Invalid job ID supplied	None
404	Not Found	Mass inter-company transfer job not found	None
500	Internal Server Error	Internal server error	None

Get Activation Groups For Mass Inter-Company Transfer Job¶

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/jobs/activation-groups

📋 Description: Creates activation groups for mass inter-company transfer jobs within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and financial obligations related to accounting entries.

Parameters

Name	In	Type	Required	Description
body	body	object	true	Request body containing the activation group details for mass inter-company transfers, including lease and contract information essential for managing financial obligations and accounting entries.
» request	body	MassInterCompanyTransferJobListFilterTypeRequest	false	Data transfer object representing a filter for retrieving a list of mass intercompany transfer jobs within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and financial obligations in accounting entries.
»» jobId	body	integer(int64)	false	none
»» searchTerm	body	string	false	Search term used to filter and retrieve specific lease, contract, or financial obligation entries within the Mass InterCompany Transfer Job List in the Nakisa Lease Accounting Suite.
»» principalPositionType	body	PrincipalPositionType	false	Represents the type of principal position with localized captions.
»»» name	body	string	false	Enum name representing the principal position type.
»»» captionKey	body	string	false	Localization key for the principal position type caption.
»»» caption	body	string	false	Localized caption of the principal position type.
»» erpSystemFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»»» name	body	string	false	Enum name representing the filter type.
»»» captionKey	body	string	false	Localization key for the filter type caption.
»»» caption	body	string	false	Localized caption of the filter type.
»» erpSystems	body	[ErpSystemLite]	false	List of erpSystems items
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»»» name	body	string	false	Enum name representing the object status.
»»»» captionKey	body	string	false	Localization key for the object status caption.
»»»» active	body	boolean	false	Indicates whether the status is active.
»»»» caption	body	string	false	Localized caption of the object status.
»»» name	body	string	false	Name of the resource
»»» type	body	ErpSystemType	false	Represents the type of ERP system.
»»»» name	body	string	false	Enum name representing the ERP system type.
»»»» captionKey	body	string	false	Localization key for the ERP system type caption.
»»»» caption	body	string	false	Localized caption of the ERP system type.
»»» sapVersion	body	SapVersion	false	Represents the version of SAP system.
»»»» name	body	string	false	Enum name representing the SAP version.
»»»» captionKey	body	string	false	Localization key for the SAP version caption.
»»»» caption	body	string	false	Localized caption of the SAP version.
»» leaseAreaFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» leaseAreas	body	[LeaseAreaLite]	false	List of leaseAreas items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» businessUnitFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» businessUnits	body	[BusinessUnitLite]	false	List of businessUnits items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» companyFilterType	body	FilterType	false	Represents the filter type for including or excluding specific entities.
»» companies	body	[CompanyLite]	false	List of companies items
»»» id	body	integer(int64)	true	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» erpSystemId	body	integer(int64)	false	Unique identifier for the erp system
»»» erpSystemDisplayId	body	string	false	Unique identifier for the erp system display
»»» countryId	body	integer(int64)	false	Unique identifier for the country
»»» countryDisplayId	body	string	false	Unique identifier for the country display
»»» name	body	string	false	none
»»» postingPeriodVariantId	body	integer(int64)	false	Unique identifier for the posting period variant
»»» fiscalVariantId	body	integer(int64)	false	Unique identifier for the fiscal variant
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of lease-related records, including contracts, financial obligations, and accounting entries, facilitating efficient data retrieval and management within the Nakisa Lease Accounting Suite.
»» page	body	integer(int32)	true	Page number for pagination
»» size	body	integer(int32)	true	Number of items per page
»» sort	body	[string]	false	Sort order specification

Example Values¶

Parameter	Example	Type
»» searchTerm	`Lease Agreement`	body
»»» name	`LESSEE`	body
»»» captionKey	`enum.principalpositiontype.lessee`	body
»»» caption	`Lessee`	body
»»» name	`ALL`	body
»»» captionKey	`enum.filterType.all`	body
»»» caption	`All`	body
»» erpSystems	`[]`	body
»»» id	`10000001`	body
»»» displayId	`ERP-001`	body
»»»» name	`ACTIVE`	body
»»»» captionKey	`enum.objectStatus.active`	body
»»»» active	`true`	body
»»»» caption	`Active`	body
»»» name	`SAP Production System`	body
»»»» name	`NAKISA`	body
»»»» captionKey	`enum.erpSystemType.NAKISA`	body
»»»» caption	`NAKISA`	body
»»»» name	`ECC_EHP5`	body
»»»» captionKey	`enum.sapVersion.ECC_EHP5`	body
»»»» caption	`ECC_EHP5`	body
»» leaseAreas	`[]`	body
»»» id	`10000001`	body
»»» displayId	`0001`	body
»»» name	`Global Lease Area`	body
»» businessUnits	`[]`	body
»»» id	`10000001`	body
»»» displayId	`BU0001`	body
»»» name	`North America Business Unit`	body
»» companies	`[]`	body
»»» id	`10000006`	body
»»» displayId	`1005`	body
»»» erpSystemId	`10000001`	body
»»» erpSystemDisplayId	`FINQ8S-300`	body
»»» countryId	`10000095`	body
»»» countryDisplayId	`CA`	body
»» page	`0`	body
»» size	`10`	body
»» sort	`["id,asc","name,desc"]`	body

Enumerated Values

Attribute	Value
»»» name	ALL, LESSEE, LESSOR, LIST
»»»» name	ACTIVE, CREATED, DECOMMISSIONED, DISABLED, ECC_EHP5, ECC_EHP6, ECC_EHP7, ECC_EHP8, NAKISA, S4_1503, S4_1610, S4_1709, S4_1809, S4_1909, SAP

Parameter Constraints¶

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "request": {
    "jobId": 0,
    "searchTerm": "Lease Agreement",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "erpSystemFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "erpSystems": [],
    "leaseAreaFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "leaseAreas": [],
    "businessUnitFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "businessUnits": [],
    "companyFilterType": {
      "name": "ALL",
      "captionKey": "enum.filterType.all",
      "caption": "All"
    },
    "companies": []
  },
  "pageable": {
    "page": 0,
    "size": 10,
    "sort": [
      "id,asc",
      "name,desc"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved activation groups	PageActivationGroupDto
400	Bad Request	Invalid request body supplied	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "totalElements": 76,
  "totalPages": 1,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 76,
  "size": 100,
  "content": [
    {
      "id": 10000001,
      "displayId": "AG-100000000",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "name": "Test2",
      "description": "test2",
      "approverComment": "Approved after review",
      "snapshotData": {
        "isParallelCurrencyEnabled": true,
        "isCostCenterAllocationEnabled": false,
        "useSpotRateForGroupCurrency": true,
        "usePostingOrDocumentDateForCurrency": true,
        "exchangeRateTypes": [
          {
            "currencyDefinitionType": "CONTRACT_CURRENCY",
            "sourceCurrencyType": "COMPANY_CURRENCY",
            "translationDateType": "POSTING_DATE",
            "targetCurrency": {
              "id": "string",
              "displayId": "US Dollar",
              "decimalPoints": 2
            },
            "referenceCurrency": {
              "id": "string",
              "displayId": "Euro"
            },
            "currencyType": "GROUP_CURRENCY",
            "exchangeRateType": "STANDARD"
          }
        ]
      },
      "revision": {
        "id": 10000001,
        "displayId": "0374999413-20250903-161147",
        "name": "Inception",
        "inception": true,
        "revisionType": "REVISION",
        "state": "MLA_DEFINE",
        "approvedBy": "approver.admin@nakisa.com",
        "approvedAt": "2019-08-24T14:15:22Z",
        "parentRevisionId": 10000000,
        "approverComment": "Approved after financial validation.",
        "rouStartDate": "2025-08-01",
        "rouEndDate": "2025-08-20",
        "activationGroupModification": {
          "modificationDate": "2025-08-15",
          "terminationType": "CASUALTY",
          "terminationDate": {
            "timing": "START_OF_DAY",
            "year": 2025,
            "monthValue": 9,
            "dayOfMonth": 4,
            "leapYear": false,
            "month": "SEPTEMBER",
            "dayOfWeek": "THURSDAY",
            "dayOfYear": 247
          },
          "useManualFmvValue": true,
          "useManualAssetValues": false,
          "enforceNonLeaseOnIndexation": false,
          "applyIndexationLease": true,
          "applyIndexationNonLease": false,
          "indexationTreatmentType": "DEFAULT",
          "indexationStartDate": "2025-09-01",
          "indexationDateType": "USER_DEFINED",
          "indexationStartDateNonLease": "2025-09-10",
          "indexationDateTypeNonLease": "USER_DEFINED",
          "modificationReasons": [
            "CONTRACT_RATE_CHANGE",
            "INDEXATION"
          ],
          "modificationPerClassificationList": [
            {
              "accountingStandardId": 1001,
              "classificationType": "NON_LEASE",
              "accountingStandardType": "IFRS",
              "impairmentAmount": 2500.5,
              "recoverableAmount": 2000,
              "decreaseInAsset": 1500,
              "decreaseInTerm": 6
            }
          ],
          "massIndexationTaskId": 987654
        },
        "activationGroupId": 10000001,
        "activationGroupDisplayId": "AG-100000000",
        "activationGroupName": "Test2",
        "leaseComponentRevisionId": 10000007,
        "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
        "lastLeaseComponentRevisionId": 10000006,
        "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
        "clonedFromRevisionId": 10000002,
        "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
        "lockReason": "PENDING_TERMINATION",
        "infiniteUsefulLife": false,
        "transferOfOwnership": false,
        "specializedAsset": false,
        "fairMarketValue": 1,
        "residualValue": 1,
        "endOfTermIntention": "TO_BE_DETERMINED",
        "endOfTermDate": "2025-08-11",
        "endOfTermPeriod": 9,
        "activationDocumentDate": "2019-08-24",
        "activationPostingDate": "2019-08-24",
        "closingDocumentDate": "2019-08-24",
        "closingPostingDate": "2019-08-24",
        "numberRangeIdentifierValue": "1000",
        "numberRangeIdentifierType": {
          "name": "COMPANY_CODE"
        },
        "numberRangeType": {
          "name": "CONTRACT"
        },
        "allowsSystemGenerateNewId": false
      },
      "leaseComponentId": 10000007,
      "leaseComponentDisplayId": "LC-100000200",
      "companyCodeId": 10000002,
      "companyCodeDisplayId": "1000",
      "splittedFromActivationGroupRevisionId": {
        "id": 10000001,
        "displayId": "0374999413-20250903-161147",
        "name": "Inception",
        "inception": true,
        "revisionType": "REVISION",
        "state": "MLA_DEFINE",
        "approvedBy": "approver.admin@nakisa.com",
        "approvedAt": "2019-08-24T14:15:22Z",
        "parentRevisionId": 10000000,
        "approverComment": "Approved after financial validation.",
        "rouStartDate": "2025-08-01",
        "rouEndDate": "2025-08-20",
        "activationGroupModification": {
          "modificationDate": "2025-08-15",
          "terminationType": "CASUALTY",
          "terminationDate": {
            "timing": "START_OF_DAY",
            "year": 2025,
            "monthValue": 9,
            "dayOfMonth": 4,
            "leapYear": false,
            "month": "SEPTEMBER",
            "dayOfWeek": "THURSDAY",
            "dayOfYear": 247
          },
          "useManualFmvValue": true,
          "useManualAssetValues": false,
          "enforceNonLeaseOnIndexation": false,
          "applyIndexationLease": true,
          "applyIndexationNonLease": false,
          "indexationTreatmentType": "DEFAULT",
          "indexationStartDate": "2025-09-01",
          "indexationDateType": "USER_DEFINED",
          "indexationStartDateNonLease": "2025-09-10",
          "indexationDateTypeNonLease": "USER_DEFINED",
          "modificationReasons": [
            "CONTRACT_RATE_CHANGE",
            "INDEXATION"
          ],
          "modificationPerClassificationList": [
            {
              "accountingStandardId": 1001,
              "classificationType": "NON_LEASE",
              "accountingStandardType": "IFRS",
              "impairmentAmount": 2500.5,
              "recoverableAmount": 2000,
              "decreaseInAsset": 1500,
              "decreaseInTerm": 6
            }
          ],
          "massIndexationTaskId": 987654
        },
        "activationGroupId": 10000001,
        "activationGroupDisplayId": "AG-100000000",
        "activationGroupName": "Test2",
        "leaseComponentRevisionId": 10000007,
        "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
        "lastLeaseComponentRevisionId": 10000006,
        "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
        "clonedFromRevisionId": 10000002,
        "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
        "lockReason": "PENDING_TERMINATION",
        "infiniteUsefulLife": false,
        "transferOfOwnership": false,
        "specializedAsset": false,
        "fairMarketValue": 1,
        "residualValue": 1,
        "endOfTermIntention": "TO_BE_DETERMINED",
        "endOfTermDate": "2025-08-11",
        "endOfTermPeriod": 9,
        "activationDocumentDate": "2019-08-24",
        "activationPostingDate": "2019-08-24",
        "closingDocumentDate": "2019-08-24",
        "closingPostingDate": "2019-08-24",
        "numberRangeIdentifierValue": "1000",
        "numberRangeIdentifierType": {
          "name": "COMPANY_CODE"
        },
        "numberRangeType": {
          "name": "CONTRACT"
        },
        "allowsSystemGenerateNewId": false
      },
      "notifications": [
        {
          "id": 100045,
          "topic": {
            "enCaption": "Lease Component Updated",
            "frCaption": "Composant de bail mis à jour",
            "name": "LEASE_COMPONENT_UPDATED",
            "priority": "HIGH"
          },
          "username": "jdoe",
          "activationGroupId": 20000123,
          "activationGroupDisplayId": "AG-100045",
          "targetId": "jdoe@example.com",
          "targetType": "USER"
        }
      ],
      "transferInfo": {
        "transferredFromDisplayId": "CTR-00012",
        "transferredFromRevisionId": 20000001,
        "transferredToDisplayId": "CTR-00015",
        "transferredToRevisionId": 20000005
      },
      "numberRangeIdentifierValue": "1000",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "allowsSystemGenerateNewId": false
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": true,
  "empty": false
}

List All Mass Inter-Company Transfer Jobs¶

HTTP Request

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

📋 Description: Retrieves a list of mass inter-company transfer jobs within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and financial obligations associated with accounting entries.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	false	Indicates whether the results of the mass inter-company transfer job retrieval should be paginated, facilitating efficient management of lease and contract-related financial obligations within the Nakisa Lease Accounting Suite.

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved list of mass inter-company transfer jobs	PageMassInterCompanyTransferJobDto
400	Bad Request	Invalid pagination parameters supplied	None
500	Internal Server Error	Internal server error	None

Example Responses

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

Create New Mass Inter-Company Transfer Job¶

HTTP Request

POST /api/v1/batch/mass-inter-company-transfer/jobs

📋 Description: Initiates a batch process for mass inter-company transfers, enabling the efficient management of lease contracts and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
body	body	MassInterCompanyTransferJobDto	false	Request body containing the details of the mass inter-company transfer jobs, including lease and contract information, financial obligations, and associated accounting entries.

Body Parameters

{
  "id": 10000001,
  "taskCount": 100,
  "failedTaskCount": 5,
  "doneTaskCount": 80,
  "inProgressTaskCount": 10,
  "cancelledTaskCount": 5,
  "errorMessage": "Failed to process transfer for contract ID 12345",
  "queueTime": "2024-01-15T10:30:00Z",
  "startTime": "2024-01-15T10:35:00Z",
  "endTime": "2024-01-15T12:00:00Z",
  "status": {
    "name": "PROCESSING",
    "captionKey": "enum.batchJobStatus.processing",
    "caption": "Processing"
  },
  "executor": {
    "name": "MANUAL",
    "captionKey": "enum.batchJobExecutor.manual",
    "caption": "Manual"
  },
  "scheduleJobId": 20000001,
  "batchSize": 1000,
  "totalObjectCount": 5000,
  "readOnly": false,
  "profileId": 30000001,
  "unauthorized": false,
  "reverting": false,
  "reverted": false,
  "revertible": true,
  "revertedCount": 0,
  "revertPercentage": 0,
  "stage": {
    "name": "PROCESSING_MASS_INTER_COMPANY_TRANSFER",
    "captionKey": "enum.massInterCompanyTransferStage.processingMassInterCompanyTransfer",
    "caption": "Processing Mass Inter-Company Transfer"
  },
  "inputFile": {
    "templateFileStorageId": "template-file-uuid-12345",
    "inputFileStorageId": "input-file-uuid-67890",
    "generatingTemplateFile": false,
    "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
    "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
    "inputFileName": "mass_transfer_input_2024.xlsx",
    "templateDocStoreId": 40000001,
    "inputDocStoreId": 40000002
  },
  "filter": {
    "id": 10000001,
    "profileId": 30000001,
    "jobId": 10000001,
    "skipItemsWithOpenDraft": true,
    "filterTypes": {
      "erpSystemFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "erpSystems": [],
      "leaseAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseAreas": [],
      "businessUnitFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "businessUnits": [],
      "companyFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "companies": [],
      "leaseDepartmentFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseDepartments": [],
      "leaseGroupFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseGroups": [],
      "costCenterFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "costCenters": [],
      "profitCenterFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "profitCenters": [],
      "wbsFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "wbses": [],
      "businessAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "businessAreas": [],
      "functionalAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "functionalAreas": []
    },
    "listObjectType": {
      "name": "CONTRACT",
      "captionKey": "enum.listObjectType.contract",
      "caption": "Contract"
    },
    "objectList": []
  },
  "input": {
    "id": 10000001,
    "name": "Q1 2024 Inter-Company Transfer",
    "transferDate": "2024-03-31",
    "principalPositionType": {
      "name": "LESSEE",
      "captionKey": "enum.principalpositiontype.lessee",
      "caption": "Lessee"
    },
    "postingDate": "2019-08-24",
    "documentDate": "2019-08-24",
    "skipItemsWithOpenDraft": true
  },
  "tasks": []
}

Responses

Status	Meaning	Description	Schema
200	OK	Mass inter-company transfer job created successfully	ResponseMassInterCompanyTransferJobDto
400	Bad Request	Invalid request body supplied	None
500	Internal Server Error	Internal server error	None

Example Responses

{
  "code": {
    "name": "OK",
    "captionKey": "enum.responseCode.ok",
    "caption": "OK"
  },
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000001,
    "taskCount": 100,
    "failedTaskCount": 5,
    "doneTaskCount": 80,
    "inProgressTaskCount": 10,
    "cancelledTaskCount": 5,
    "errorMessage": "Failed to process transfer for contract ID 12345",
    "queueTime": "2024-01-15T10:30:00Z",
    "startTime": "2024-01-15T10:35:00Z",
    "endTime": "2024-01-15T12:00:00Z",
    "status": {
      "name": "PROCESSING",
      "captionKey": "enum.batchJobStatus.processing",
      "caption": "Processing"
    },
    "executor": {
      "name": "MANUAL",
      "captionKey": "enum.batchJobExecutor.manual",
      "caption": "Manual"
    },
    "scheduleJobId": 20000001,
    "batchSize": 1000,
    "totalObjectCount": 5000,
    "readOnly": false,
    "profileId": 30000001,
    "unauthorized": false,
    "reverting": false,
    "reverted": false,
    "revertible": true,
    "revertedCount": 0,
    "revertPercentage": 0,
    "stage": {
      "name": "PROCESSING_MASS_INTER_COMPANY_TRANSFER",
      "captionKey": "enum.massInterCompanyTransferStage.processingMassInterCompanyTransfer",
      "caption": "Processing Mass Inter-Company Transfer"
    },
    "inputFile": {
      "templateFileStorageId": "template-file-uuid-12345",
      "inputFileStorageId": "input-file-uuid-67890",
      "generatingTemplateFile": false,
      "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
      "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
      "inputFileName": "mass_transfer_input_2024.xlsx",
      "templateDocStoreId": 40000001,
      "inputDocStoreId": 40000002
    },
    "filter": {
      "id": 10000001,
      "profileId": 30000001,
      "jobId": 10000001,
      "skipItemsWithOpenDraft": true,
      "filterTypes": {
        "erpSystemFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "erpSystems": [],
        "leaseAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseAreas": [],
        "businessUnitFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "businessUnits": [],
        "companyFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "companies": [],
        "leaseDepartmentFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseDepartments": [],
        "leaseGroupFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "leaseGroups": [],
        "costCenterFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "costCenters": [],
        "profitCenterFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "profitCenters": [],
        "wbsFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "wbses": [],
        "businessAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "businessAreas": [],
        "functionalAreaFilterType": {
          "name": "ALL",
          "captionKey": "enum.filterType.all",
          "caption": "All"
        },
        "functionalAreas": []
      },
      "listObjectType": {
        "name": "CONTRACT",
        "captionKey": "enum.listObjectType.contract",
        "caption": "Contract"
      },
      "objectList": []
    },
    "input": {
      "id": 10000001,
      "name": "Q1 2024 Inter-Company Transfer",
      "transferDate": "2024-03-31",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "postingDate": "2019-08-24",
      "documentDate": "2019-08-24",
      "skipItemsWithOpenDraft": true
    },
    "tasks": []
  }
}

List Object Types For Mass Inter-Company Transfer Job¶

HTTP Request

GET /api/v1/batch/mass-inter-company-transfer/jobs/list-object-types

📋 Description: Retrieves a list of object types related to mass inter-company transfer jobs within the Nakisa Lease Accounting Suite, facilitating efficient management of leases, contracts, financial obligations, and accounting entries.

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved list of object types	Inline
500	Internal Server Error	Internal server error	None

Example Responses

[
  "string"
]

Response Schema

Generate Mass Inter-Company Transfer Job Template¶

HTTP Request

GET /api/v1/batch/mass-inter-company-transfer/jobs/generate-input-template/{id}

📋 Description: Generates an input template for mass inter-company transfer jobs based on the specified job ID, facilitating the management of lease contracts and financial obligations within the Nakisa Lease Accounting Suite. This operation supports users in preparing accounting entries efficiently.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Example Values¶

Parameter	Example	Type
id	`10000001`	path

Responses

Status	Meaning	Description	Schema
200	OK	Input template generated successfully	None
400	Bad Request	Invalid ID supplied	None
404	Not Found	Mass inter-company transfer job not found	None
500	Internal Server Error	Internal server error	None

Get Mass Inter-Company Transfer Job By ID (With Exists And Job ID)¶

HTTP Request

GET /api/v1/batch/mass-inter-company-transfer/jobs/exists/{jobId}

📋 Description: Checks the existence of a specific mass inter-company transfer job by its job ID within the Nakisa Lease Accounting Suite, ensuring accurate tracking of lease-related financial obligations and accounting entries.

Parameters

Name	In	Type	Required	Description
jobId	path	integer(int64)	true	Unique identifier for the job

Example Values¶

Parameter	Example	Type
jobId	`10000001`	path

Responses

Status	Meaning	Description	Schema
200	OK	Successfully checked job existence	boolean
400	Bad Request	Invalid job ID supplied	None
500	Internal Server Error	Internal server error	None

Example Responses

1true

Download Mass Inter-Company Transfer Job Input File¶

HTTP Request

GET /api/v1/batch/mass-inter-company-transfer/jobs/download-user-input/{id}

📋 Description: Downloads user input data for a specific mass inter-company transfer job identified by the provided ID, facilitating accurate lease and contract management within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Example Values¶

Parameter	Example	Type
id	`10000001`	path

Responses

Status	Meaning	Description	Schema
200	OK	User input file downloaded successfully	None
400	Bad Request	Invalid ID supplied	None
404	Not Found	Mass inter-company transfer job or user input file not found	None
500	Internal Server Error	Internal server error	None

Download Mass Inter-Company Transfer Job Template¶

HTTP Request

GET /api/v1/batch/mass-inter-company-transfer/jobs/download-input-template/{id}

📋 Description: Downloads the input template for a specified mass inter-company transfer job, facilitating the preparation of lease and contract data for accurate financial obligation and accounting entry management within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Example Values¶

Parameter	Example	Type
id	`10000001`	path

Responses

Status	Meaning	Description	Schema
200	OK	Input template file downloaded successfully	None
400	Bad Request	Invalid ID supplied	None
404	Not Found	Mass inter-company transfer job or input template file not found	None
500	Internal Server Error	Internal server error	None