MassModificationJobDto

Example Json Object

  1{
  2  "id": 10000001,
  3  "taskCount": 100,
  4  "failedTaskCount": 100,
  5  "doneTaskCount": 100,
  6  "inProgressTaskCount": 100,
  7  "cancelledTaskCount": 100,
  8  "errorMessage": "sample_errorMessage",
  9  "queueTime": "2025-01-01T10:00:00Z",
 10  "startTime": "2025-01-01T10:00:00Z",
 11  "endTime": "2025-01-01T10:00:00Z",
 12  "status": {
 13    "name": "PROCESSING",
 14    "captionKey": "enum.batchJobStatus.processing",
 15    "caption": "Processing"
 16  },
 17  "executor": {
 18    "name": "MANUAL",
 19    "captionKey": "enum.batchJobExecutor.manual",
 20    "caption": "Manual"
 21  },
 22  "scheduleJobId": 10000001,
 23  "batchSize": 100,
 24  "totalObjectCount": 100,
 25  "readOnly": false,
 26  "profileId": 10000001,
 27  "unauthorized": false,
 28  "stage": {
 29    "name": "PROCESSING_MASS_MODIFICATION",
 30    "captionKey": "enum.massModificationStage.processingMassModification",
 31    "caption": "Processing Mass Modification"
 32  },
 33  "inputFile": {
 34    "templateFileStorageId": "template-file-uuid-12345",
 35    "inputFileStorageId": "input-file-uuid-67890",
 36    "generatingTemplateFile": false,
 37    "startedGeneratingTemplateFileAt": "2024-01-15T10:30:00Z",
 38    "finishedGeneratingTemplateFileAt": "2024-01-15T10:35:00Z",
 39    "inputFileName": "mass_transfer_input_2024.xlsx",
 40    "templateDocStoreId": 40000001,
 41    "inputDocStoreId": 40000002
 42  },
 43  "filter": {
 44    "id": 10000001,
 45    "profileId": 10000001,
 46    "jobId": 10000001,
 47    "name": "Sample Name",
 48    "principalPositionType": {
 49      "name": "LESSEE",
 50      "captionKey": "enum.principalpositiontype.lessee",
 51      "caption": "Lessee"
 52    },
 53    "skipItemsWithOpenDraft": false,
 54    "filterTypes": {
 55      "erpSystemFilterType": {
 56        "name": "ALL",
 57        "captionKey": "enum.filterType.all",
 58        "caption": "All"
 59      },
 60      "erpSystems": [],
 61      "leaseAreaFilterType": {
 62        "name": "ALL",
 63        "captionKey": "enum.filterType.all",
 64        "caption": "All"
 65      },
 66      "leaseAreas": [],
 67      "businessUnitFilterType": {
 68        "name": "ALL",
 69        "captionKey": "enum.filterType.all",
 70        "caption": "All"
 71      },
 72      "businessUnits": [],
 73      "companyFilterType": {
 74        "name": "ALL",
 75        "captionKey": "enum.filterType.all",
 76        "caption": "All"
 77      },
 78      "companies": [],
 79      "leaseDepartmentFilterType": {
 80        "name": "ALL",
 81        "captionKey": "enum.filterType.all",
 82        "caption": "All"
 83      },
 84      "leaseDepartments": [],
 85      "leaseGroupFilterType": {
 86        "name": "ALL",
 87        "captionKey": "enum.filterType.all",
 88        "caption": "All"
 89      },
 90      "leaseGroups": [],
 91      "costCenterFilterType": {
 92        "name": "ALL",
 93        "captionKey": "enum.filterType.all",
 94        "caption": "All"
 95      },
 96      "costCenters": [],
 97      "profitCenterFilterType": {
 98        "name": "ALL",
 99        "captionKey": "enum.filterType.all",
100        "caption": "All"
101      },
102      "profitCenters": [],
103      "wbsFilterType": {
104        "name": "ALL",
105        "captionKey": "enum.filterType.all",
106        "caption": "All"
107      },
108      "wbses": [],
109      "businessAreaFilterType": {
110        "name": "ALL",
111        "captionKey": "enum.filterType.all",
112        "caption": "All"
113      },
114      "businessAreas": [],
115      "functionalAreaFilterType": {
116        "name": "ALL",
117        "captionKey": "enum.filterType.all",
118        "caption": "All"
119      },
120      "functionalAreas": []
121    },
122    "listObjectType": {
123      "name": "CONTRACT",
124      "captionKey": "enum.listObjectType.contract",
125      "caption": "Contract"
126    },
127    "objectList": []
128  },
129  "input": {
130    "id": 10000001,
131    "modificationTypes": {
132      "name": "LEASE_COMPONENT_MODIFICATION",
133      "captionKey": "enum.modificationType.leaseComponentModification",
134      "caption": "Lease Component Modification"
135    },
136    "applyGlobalOnEventName": false,
137    "leaseComponentEventName": "sample_leaseComponentEventName",
138    "activationGroupEventName": "sample_activationGroupEventName",
139    "applyGlobalOnEffectiveDates": false,
140    "effectiveDateType": {
141      "name": "JOB_DATE",
142      "captionKey": "enum.modificationDateType.jobDate",
143      "caption": "Job Date"
144    },
145    "effectiveDate": "2025-01-01",
146    "applyGlobalOnModificationDates": false,
147    "modificationDateType": {
148      "name": "JOB_DATE",
149      "captionKey": "enum.modificationDateType.jobDate",
150      "caption": "Job Date"
151    },
152    "modificationDate": "2025-01-01",
153    "activationDateType": {
154      "name": "JOB_DATE",
155      "captionKey": "enum.modificationDateType.jobDate",
156      "caption": "Job Date"
157    },
158    "postingDate": "2025-01-01",
159    "documentDate": "2025-01-01",
160    "translationDate": "2025-01-01",
161    "applyGlobalOnContractRate": false,
162    "useAutoRate": false,
163    "contractRate": 1000,
164    "applyGlobalOnTermFlags": false,
165    "exerciseTermType": {
166      "name": "APPLY_ON_ALL_TERMS",
167      "captionKey": "enum.termApplicationType.applyOnAllTerms",
168      "caption": "Apply On All Terms"
169    },
170    "applyIndexationTermType": {
171      "name": "APPLY_ON_ALL_TERMS",
172      "captionKey": "enum.termApplicationType.applyOnAllTerms",
173      "caption": "Apply On All Terms"
174    },
175    "migratedFilterType": {
176      "name": "ALL",
177      "captionKey": "enum.migratedFilterType.all",
178      "caption": "All"
179    }
180  },
181  "tasks": []
182}

📄 Description: Data transfer object representing a mass modification job within the Nakisa Lease Accounting Suite, encompassing updates to leases, contracts, financial obligations, and accounting entries for streamlined financial management.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

taskCount

integer(int32)

false

none

Count of task

failedTaskCount

integer(int32)

false

none

Count of failed task

doneTaskCount

integer(int32)

false

none

Count of done task

inProgressTaskCount

integer(int32)

false

none

Count of in progress task

cancelledTaskCount

integer(int32)

false

none

Count of cancelled task

errorMessage

string

false

none

Descriptive message detailing any errors encountered during the mass modification of lease contracts or financial obligations within the Nakisa Lease Accounting Suite.

queueTime

string(date-time)

false

none

Time of the queue

startTime

string(date-time)

false

none

Time of the start

endTime

string(date-time)

false

none

Time of the end

status

BatchJobStatus

false

none

Status of the resource

executor

BatchJobExecutor

false

none

Identifier for the individual or system responsible for executing the mass modification job related to lease contracts and financial obligations within the Nakisa Lease Accounting Suite.

scheduleJobId

integer(int64)

false

none

Unique identifier for the schedule job

batchSize

integer(int32)

false

none

Numeric value representing batchSize

totalObjectCount

integer(int32)

false

none

Count of total object

readOnly

boolean

false

none

Boolean flag indicating readOnly status

profileId

integer(int64)

false

none

Unique identifier for the profile

unauthorized

boolean

false

none

Boolean flag indicating unauthorized status

stage

MassModificationStageE

false

none

Indicates the current stage of the mass modification job within the Nakisa Lease Accounting Suite, reflecting its progress in relation to lease, contract, financial obligation, and accounting entry processes.

inputFile

BatchJobInputFile

false

none

Value for inputFile field

filter

MassModificationJobFilterDto

false

none

Value for filter field

input

MassModificationJobInputDto

false

none

Value for input field

tasks

[MassModificationTaskDto]

false

none

List of tasks items