Operational Posting Schedule Job

Get Operational Posting Schedule Job By ID

HTTP Request

GET /api/v1/batch/operational-posting/schedule-jobs/{id}

📋 Description: Retrieves the scheduled job details for operational postings associated with a specific lease or contract, enabling users to manage financial obligations and accounting entries effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseOperationalPostingScheduleJobDto

Example Responses

  1{
  2  "code": {
  3    "name": "OK",
  4    "captionKey": "enum.responseCode.ok",
  5    "caption": "OK"
  6  },
  7  "errors": {
  8    "all": []
  9  },
 10  "object": {
 11    "id": 10000001,
 12    "cronExpression": "sample_cronExpression",
 13    "cronReadable": "sample_cronReadable",
 14    "active": true,
 15    "unauthorized": false,
 16    "nextExecution": "2025-01-01T10:00:00Z",
 17    "previousSuccessfulExecution": "2025-01-01T10:00:00Z",
 18    "previousExecution": "2025-01-01T10:00:00Z",
 19    "previousExecutionMessage": "sample_previousExecutionMessage",
 20    "batchSize": 100,
 21    "name": "Sample Name",
 22    "profileId": 10000001,
 23    "input": {
 24      "id": 10000001,
 25      "jobPostingStatuses": {
 26        "name": "DONE",
 27        "captionKey": "enum.postingStatusType.done",
 28        "caption": "Done"
 29      },
 30      "journalTypes": {
 31        "name": "PAYMENT",
 32        "captionKey": "enum.journalPostingType.payment",
 33        "caption": "Payment"
 34      },
 35      "postingTransactionType": {
 36        "name": "POST",
 37        "captionKey": "enum.postingTransactionType.post",
 38        "caption": "Post"
 39      },
 40      "fromDate": {
 41        "timing": {
 42          "name": "START_OF_DAY",
 43          "captionKey": "enum.timingType.startOfDay",
 44          "caption": "Start Of Day"
 45        },
 46        "year": 100,
 47        "monthValue": 100,
 48        "dayOfMonth": 100,
 49        "leapYear": false,
 50        "month": {
 51          "name": "JANUARY",
 52          "captionKey": "enum.month.january",
 53          "caption": "January"
 54        },
 55        "dayOfWeek": {
 56          "name": "MONDAY",
 57          "captionKey": "enum.dayOfWeek.monday",
 58          "caption": "Monday"
 59        },
 60        "dayOfYear": 100
 61      },
 62      "toDate": {
 63        "timing": {
 64          "name": "START_OF_DAY",
 65          "captionKey": "enum.timingType.startOfDay",
 66          "caption": "Start Of Day"
 67        },
 68        "year": 100,
 69        "monthValue": 100,
 70        "dayOfMonth": 100,
 71        "leapYear": false,
 72        "month": {
 73          "name": "JANUARY",
 74          "captionKey": "enum.month.january",
 75          "caption": "January"
 76        },
 77        "dayOfWeek": {
 78          "name": "MONDAY",
 79          "captionKey": "enum.dayOfWeek.monday",
 80          "caption": "Monday"
 81        },
 82        "dayOfYear": 100
 83      },
 84      "fromDateType": {
 85        "name": "AG_ROU_START_DATE",
 86        "captionKey": "enum.fromDateType.agRouStartDate",
 87        "caption": "AG ROU Start Date"
 88      },
 89      "toDateType": {
 90        "name": "USER_DEFINED",
 91        "captionKey": "enum.toDateType.userDefined",
 92        "caption": "User Defined"
 93      },
 94      "internalPostingDateType": {
 95        "name": "SCHEDULE_PERIOD_DATES",
 96        "captionKey": "enum.internalPostingDateType.schedulePeriodDates",
 97        "caption": "Schedule Period Dates"
 98      },
 99      "postingDate": "2025-01-01",
100      "documentDate": "2025-01-01",
101      "translationDate": "2025-01-01",
102      "skipActivationGroupsWithOpenDraft": false,
103      "retryCount": 100,
104      "reversalReasonType": {
105        "name": "ERP_SYSTEM_DEFAULT",
106        "captionKey": "enum.reversalReasonType.erpSystemDefault",
107        "caption": "ERP System Default"
108      },
109      "reversalReason": {
110        "id": 50000001,
111        "displayId": "REV-001",
112        "status": {
113          "name": "ACTIVE",
114          "captionKey": "enum.objectStatus.active",
115          "active": true,
116          "caption": "Active"
117        },
118        "name": "Incorrect Indexation",
119        "erpSystemId": 60000001,
120        "erpSystemDisplayId": "SAP-PROD"
121      },
122      "migratedFilterType": {
123        "name": "ALL",
124        "captionKey": "enum.migratedFilterType.all",
125        "caption": "All"
126      },
127      "listObjectType": {
128        "name": "CONTRACT",
129        "captionKey": "enum.listObjectType.contract",
130        "caption": "Contract"
131      },
132      "objectList": []
133    },
134    "profile": {
135      "id": 10000001,
136      "profileId": 10000001,
137      "jobId": 10000001,
138      "name": "Sample Name",
139      "principalPositionType": {
140        "name": "LESSEE",
141        "captionKey": "enum.principalpositiontype.lessee",
142        "caption": "Lessee"
143      },
144      "filterObject": {
145        "erpSystemFilterType": {
146          "name": "ALL",
147          "captionKey": "enum.filterType.all",
148          "caption": "All"
149        },
150        "erpSystems": [],
151        "leaseAreaFilterType": {
152          "name": "ALL",
153          "captionKey": "enum.filterType.all",
154          "caption": "All"
155        },
156        "leaseAreas": [],
157        "businessUnitFilterType": {
158          "name": "ALL",
159          "captionKey": "enum.filterType.all",
160          "caption": "All"
161        },
162        "businessUnits": [],
163        "companyFilterType": {
164          "name": "ALL",
165          "captionKey": "enum.filterType.all",
166          "caption": "All"
167        },
168        "companies": [],
169        "leaseDepartmentFilterType": {
170          "name": "ALL",
171          "captionKey": "enum.filterType.all",
172          "caption": "All"
173        },
174        "leaseDepartments": [],
175        "leaseGroupFilterType": {
176          "name": "ALL",
177          "captionKey": "enum.filterType.all",
178          "caption": "All"
179        },
180        "leaseGroups": [],
181        "costCenterFilterType": {
182          "name": "ALL",
183          "captionKey": "enum.filterType.all",
184          "caption": "All"
185        },
186        "costCenters": [],
187        "profitCenterFilterType": {
188          "name": "ALL",
189          "captionKey": "enum.filterType.all",
190          "caption": "All"
191        },
192        "profitCenters": [],
193        "wbsFilterType": {
194          "name": "ALL",
195          "captionKey": "enum.filterType.all",
196          "caption": "All"
197        },
198        "wbses": [],
199        "businessAreaFilterType": {
200          "name": "ALL",
201          "captionKey": "enum.filterType.all",
202          "caption": "All"
203        },
204        "businessAreas": [],
205        "functionalAreaFilterType": {
206          "name": "ALL",
207          "captionKey": "enum.filterType.all",
208          "caption": "All"
209        },
210        "functionalAreas": []
211      }
212    }
213  }
214}

Update Operational Posting Schedule Job

HTTP Request

PUT /api/v1/batch/operational-posting/schedule-jobs/{id}

📋 Description: Updates the scheduling details of operational posting jobs within the Nakisa Lease Accounting Suite, enabling users to manage lease and contract-related financial obligations efficiently. This operation ensures that accounting entries are processed in alignment with updated job parameters.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

OperationalPostingScheduleJobDto

false

Request body containing the schedule job details, including lease and contract information, financial obligations, and accounting entry parameters for the specified job ID.

Body Parameters

  1{
  2  "id": 10000001,
  3  "cronExpression": "sample_cronExpression",
  4  "cronReadable": "sample_cronReadable",
  5  "active": true,
  6  "unauthorized": false,
  7  "nextExecution": "2025-01-01T10:00:00Z",
  8  "previousSuccessfulExecution": "2025-01-01T10:00:00Z",
  9  "previousExecution": "2025-01-01T10:00:00Z",
 10  "previousExecutionMessage": "sample_previousExecutionMessage",
 11  "batchSize": 100,
 12  "name": "Sample Name",
 13  "profileId": 10000001,
 14  "input": {
 15    "id": 10000001,
 16    "jobPostingStatuses": {
 17      "name": "DONE",
 18      "captionKey": "enum.postingStatusType.done",
 19      "caption": "Done"
 20    },
 21    "journalTypes": {
 22      "name": "PAYMENT",
 23      "captionKey": "enum.journalPostingType.payment",
 24      "caption": "Payment"
 25    },
 26    "postingTransactionType": {
 27      "name": "POST",
 28      "captionKey": "enum.postingTransactionType.post",
 29      "caption": "Post"
 30    },
 31    "fromDate": {
 32      "timing": {
 33        "name": "START_OF_DAY",
 34        "captionKey": "enum.timingType.startOfDay",
 35        "caption": "Start Of Day"
 36      },
 37      "year": 100,
 38      "monthValue": 100,
 39      "dayOfMonth": 100,
 40      "leapYear": false,
 41      "month": {
 42        "name": "JANUARY",
 43        "captionKey": "enum.month.january",
 44        "caption": "January"
 45      },
 46      "dayOfWeek": {
 47        "name": "MONDAY",
 48        "captionKey": "enum.dayOfWeek.monday",
 49        "caption": "Monday"
 50      },
 51      "dayOfYear": 100
 52    },
 53    "toDate": {
 54      "timing": {
 55        "name": "START_OF_DAY",
 56        "captionKey": "enum.timingType.startOfDay",
 57        "caption": "Start Of Day"
 58      },
 59      "year": 100,
 60      "monthValue": 100,
 61      "dayOfMonth": 100,
 62      "leapYear": false,
 63      "month": {
 64        "name": "JANUARY",
 65        "captionKey": "enum.month.january",
 66        "caption": "January"
 67      },
 68      "dayOfWeek": {
 69        "name": "MONDAY",
 70        "captionKey": "enum.dayOfWeek.monday",
 71        "caption": "Monday"
 72      },
 73      "dayOfYear": 100
 74    },
 75    "fromDateType": {
 76      "name": "AG_ROU_START_DATE",
 77      "captionKey": "enum.fromDateType.agRouStartDate",
 78      "caption": "AG ROU Start Date"
 79    },
 80    "toDateType": {
 81      "name": "USER_DEFINED",
 82      "captionKey": "enum.toDateType.userDefined",
 83      "caption": "User Defined"
 84    },
 85    "internalPostingDateType": {
 86      "name": "SCHEDULE_PERIOD_DATES",
 87      "captionKey": "enum.internalPostingDateType.schedulePeriodDates",
 88      "caption": "Schedule Period Dates"
 89    },
 90    "postingDate": "2025-01-01",
 91    "documentDate": "2025-01-01",
 92    "translationDate": "2025-01-01",
 93    "skipActivationGroupsWithOpenDraft": false,
 94    "retryCount": 100,
 95    "reversalReasonType": {
 96      "name": "ERP_SYSTEM_DEFAULT",
 97      "captionKey": "enum.reversalReasonType.erpSystemDefault",
 98      "caption": "ERP System Default"
 99    },
100    "reversalReason": {
101      "id": 50000001,
102      "displayId": "REV-001",
103      "status": {
104        "name": "ACTIVE",
105        "captionKey": "enum.objectStatus.active",
106        "active": true,
107        "caption": "Active"
108      },
109      "name": "Incorrect Indexation",
110      "erpSystemId": 60000001,
111      "erpSystemDisplayId": "SAP-PROD"
112    },
113    "migratedFilterType": {
114      "name": "ALL",
115      "captionKey": "enum.migratedFilterType.all",
116      "caption": "All"
117    },
118    "listObjectType": {
119      "name": "CONTRACT",
120      "captionKey": "enum.listObjectType.contract",
121      "caption": "Contract"
122    },
123    "objectList": []
124  },
125  "profile": {
126    "id": 10000001,
127    "profileId": 10000001,
128    "jobId": 10000001,
129    "name": "Sample Name",
130    "principalPositionType": {
131      "name": "LESSEE",
132      "captionKey": "enum.principalpositiontype.lessee",
133      "caption": "Lessee"
134    },
135    "filterObject": {
136      "erpSystemFilterType": {
137        "name": "ALL",
138        "captionKey": "enum.filterType.all",
139        "caption": "All"
140      },
141      "erpSystems": [],
142      "leaseAreaFilterType": {
143        "name": "ALL",
144        "captionKey": "enum.filterType.all",
145        "caption": "All"
146      },
147      "leaseAreas": [],
148      "businessUnitFilterType": {
149        "name": "ALL",
150        "captionKey": "enum.filterType.all",
151        "caption": "All"
152      },
153      "businessUnits": [],
154      "companyFilterType": {
155        "name": "ALL",
156        "captionKey": "enum.filterType.all",
157        "caption": "All"
158      },
159      "companies": [],
160      "leaseDepartmentFilterType": {
161        "name": "ALL",
162        "captionKey": "enum.filterType.all",
163        "caption": "All"
164      },
165      "leaseDepartments": [],
166      "leaseGroupFilterType": {
167        "name": "ALL",
168        "captionKey": "enum.filterType.all",
169        "caption": "All"
170      },
171      "leaseGroups": [],
172      "costCenterFilterType": {
173        "name": "ALL",
174        "captionKey": "enum.filterType.all",
175        "caption": "All"
176      },
177      "costCenters": [],
178      "profitCenterFilterType": {
179        "name": "ALL",
180        "captionKey": "enum.filterType.all",
181        "caption": "All"
182      },
183      "profitCenters": [],
184      "wbsFilterType": {
185        "name": "ALL",
186        "captionKey": "enum.filterType.all",
187        "caption": "All"
188      },
189      "wbses": [],
190      "businessAreaFilterType": {
191        "name": "ALL",
192        "captionKey": "enum.filterType.all",
193        "caption": "All"
194      },
195      "businessAreas": [],
196      "functionalAreaFilterType": {
197        "name": "ALL",
198        "captionKey": "enum.filterType.all",
199        "caption": "All"
200      },
201      "functionalAreas": []
202    }
203  }
204}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseOperationalPostingScheduleJobDto

Example Responses

  1{
  2  "code": {
  3    "name": "OK",
  4    "captionKey": "enum.responseCode.ok",
  5    "caption": "OK"
  6  },
  7  "errors": {
  8    "all": []
  9  },
 10  "object": {
 11    "id": 10000001,
 12    "cronExpression": "sample_cronExpression",
 13    "cronReadable": "sample_cronReadable",
 14    "active": true,
 15    "unauthorized": false,
 16    "nextExecution": "2025-01-01T10:00:00Z",
 17    "previousSuccessfulExecution": "2025-01-01T10:00:00Z",
 18    "previousExecution": "2025-01-01T10:00:00Z",
 19    "previousExecutionMessage": "sample_previousExecutionMessage",
 20    "batchSize": 100,
 21    "name": "Sample Name",
 22    "profileId": 10000001,
 23    "input": {
 24      "id": 10000001,
 25      "jobPostingStatuses": {
 26        "name": "DONE",
 27        "captionKey": "enum.postingStatusType.done",
 28        "caption": "Done"
 29      },
 30      "journalTypes": {
 31        "name": "PAYMENT",
 32        "captionKey": "enum.journalPostingType.payment",
 33        "caption": "Payment"
 34      },
 35      "postingTransactionType": {
 36        "name": "POST",
 37        "captionKey": "enum.postingTransactionType.post",
 38        "caption": "Post"
 39      },
 40      "fromDate": {
 41        "timing": {
 42          "name": "START_OF_DAY",
 43          "captionKey": "enum.timingType.startOfDay",
 44          "caption": "Start Of Day"
 45        },
 46        "year": 100,
 47        "monthValue": 100,
 48        "dayOfMonth": 100,
 49        "leapYear": false,
 50        "month": {
 51          "name": "JANUARY",
 52          "captionKey": "enum.month.january",
 53          "caption": "January"
 54        },
 55        "dayOfWeek": {
 56          "name": "MONDAY",
 57          "captionKey": "enum.dayOfWeek.monday",
 58          "caption": "Monday"
 59        },
 60        "dayOfYear": 100
 61      },
 62      "toDate": {
 63        "timing": {
 64          "name": "START_OF_DAY",
 65          "captionKey": "enum.timingType.startOfDay",
 66          "caption": "Start Of Day"
 67        },
 68        "year": 100,
 69        "monthValue": 100,
 70        "dayOfMonth": 100,
 71        "leapYear": false,
 72        "month": {
 73          "name": "JANUARY",
 74          "captionKey": "enum.month.january",
 75          "caption": "January"
 76        },
 77        "dayOfWeek": {
 78          "name": "MONDAY",
 79          "captionKey": "enum.dayOfWeek.monday",
 80          "caption": "Monday"
 81        },
 82        "dayOfYear": 100
 83      },
 84      "fromDateType": {
 85        "name": "AG_ROU_START_DATE",
 86        "captionKey": "enum.fromDateType.agRouStartDate",
 87        "caption": "AG ROU Start Date"
 88      },
 89      "toDateType": {
 90        "name": "USER_DEFINED",
 91        "captionKey": "enum.toDateType.userDefined",
 92        "caption": "User Defined"
 93      },
 94      "internalPostingDateType": {
 95        "name": "SCHEDULE_PERIOD_DATES",
 96        "captionKey": "enum.internalPostingDateType.schedulePeriodDates",
 97        "caption": "Schedule Period Dates"
 98      },
 99      "postingDate": "2025-01-01",
100      "documentDate": "2025-01-01",
101      "translationDate": "2025-01-01",
102      "skipActivationGroupsWithOpenDraft": false,
103      "retryCount": 100,
104      "reversalReasonType": {
105        "name": "ERP_SYSTEM_DEFAULT",
106        "captionKey": "enum.reversalReasonType.erpSystemDefault",
107        "caption": "ERP System Default"
108      },
109      "reversalReason": {
110        "id": 50000001,
111        "displayId": "REV-001",
112        "status": {
113          "name": "ACTIVE",
114          "captionKey": "enum.objectStatus.active",
115          "active": true,
116          "caption": "Active"
117        },
118        "name": "Incorrect Indexation",
119        "erpSystemId": 60000001,
120        "erpSystemDisplayId": "SAP-PROD"
121      },
122      "migratedFilterType": {
123        "name": "ALL",
124        "captionKey": "enum.migratedFilterType.all",
125        "caption": "All"
126      },
127      "listObjectType": {
128        "name": "CONTRACT",
129        "captionKey": "enum.listObjectType.contract",
130        "caption": "Contract"
131      },
132      "objectList": []
133    },
134    "profile": {
135      "id": 10000001,
136      "profileId": 10000001,
137      "jobId": 10000001,
138      "name": "Sample Name",
139      "principalPositionType": {
140        "name": "LESSEE",
141        "captionKey": "enum.principalpositiontype.lessee",
142        "caption": "Lessee"
143      },
144      "filterObject": {
145        "erpSystemFilterType": {
146          "name": "ALL",
147          "captionKey": "enum.filterType.all",
148          "caption": "All"
149        },
150        "erpSystems": [],
151        "leaseAreaFilterType": {
152          "name": "ALL",
153          "captionKey": "enum.filterType.all",
154          "caption": "All"
155        },
156        "leaseAreas": [],
157        "businessUnitFilterType": {
158          "name": "ALL",
159          "captionKey": "enum.filterType.all",
160          "caption": "All"
161        },
162        "businessUnits": [],
163        "companyFilterType": {
164          "name": "ALL",
165          "captionKey": "enum.filterType.all",
166          "caption": "All"
167        },
168        "companies": [],
169        "leaseDepartmentFilterType": {
170          "name": "ALL",
171          "captionKey": "enum.filterType.all",
172          "caption": "All"
173        },
174        "leaseDepartments": [],
175        "leaseGroupFilterType": {
176          "name": "ALL",
177          "captionKey": "enum.filterType.all",
178          "caption": "All"
179        },
180        "leaseGroups": [],
181        "costCenterFilterType": {
182          "name": "ALL",
183          "captionKey": "enum.filterType.all",
184          "caption": "All"
185        },
186        "costCenters": [],
187        "profitCenterFilterType": {
188          "name": "ALL",
189          "captionKey": "enum.filterType.all",
190          "caption": "All"
191        },
192        "profitCenters": [],
193        "wbsFilterType": {
194          "name": "ALL",
195          "captionKey": "enum.filterType.all",
196          "caption": "All"
197        },
198        "wbses": [],
199        "businessAreaFilterType": {
200          "name": "ALL",
201          "captionKey": "enum.filterType.all",
202          "caption": "All"
203        },
204        "businessAreas": [],
205        "functionalAreaFilterType": {
206          "name": "ALL",
207          "captionKey": "enum.filterType.all",
208          "caption": "All"
209        },
210        "functionalAreas": []
211      }
212    }
213  }
214}

Delete Operational Posting Schedule Job

HTTP Request

DELETE /api/v1/batch/operational-posting/schedule-jobs/{id}

📋 Description: Deletes a scheduled job associated with operational postings in the Nakisa Lease Accounting Suite, ensuring the removal of any related lease, contract, or financial obligation entries from the system. This operation helps maintain accurate accounting records by eliminating unnecessary or outdated jobs.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Bulk Upsert Operational Posting Schedule Jobs

HTTP Request

PUT /api/v1/batch/operational-posting/schedule-jobs/createOrUpdate/bulk

📋 Description: Creates or updates multiple scheduled jobs for operational postings related to leases and contracts, ensuring accurate financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

OperationalPostingScheduleJobDto

false

Request body containing bulk data for creating or updating operational posting jobs, including lease, contract, financial obligation, and accounting entry details.

Body Parameters

  1[
  2  {
  3    "id": 10000001,
  4    "cronExpression": "sample_cronExpression",
  5    "cronReadable": "sample_cronReadable",
  6    "active": true,
  7    "unauthorized": false,
  8    "nextExecution": "2025-01-01T10:00:00Z",
  9    "previousSuccessfulExecution": "2025-01-01T10:00:00Z",
 10    "previousExecution": "2025-01-01T10:00:00Z",
 11    "previousExecutionMessage": "sample_previousExecutionMessage",
 12    "batchSize": 100,
 13    "name": "Sample Name",
 14    "profileId": 10000001,
 15    "input": {
 16      "id": 10000001,
 17      "jobPostingStatuses": {
 18        "name": "DONE",
 19        "captionKey": "enum.postingStatusType.done",
 20        "caption": "Done"
 21      },
 22      "journalTypes": {
 23        "name": "PAYMENT",
 24        "captionKey": "enum.journalPostingType.payment",
 25        "caption": "Payment"
 26      },
 27      "postingTransactionType": {
 28        "name": "POST",
 29        "captionKey": "enum.postingTransactionType.post",
 30        "caption": "Post"
 31      },
 32      "fromDate": {
 33        "timing": {
 34          "name": "START_OF_DAY",
 35          "captionKey": "enum.timingType.startOfDay",
 36          "caption": "Start Of Day"
 37        },
 38        "year": 100,
 39        "monthValue": 100,
 40        "dayOfMonth": 100,
 41        "leapYear": false,
 42        "month": {
 43          "name": "JANUARY",
 44          "captionKey": "enum.month.january",
 45          "caption": "January"
 46        },
 47        "dayOfWeek": {
 48          "name": "MONDAY",
 49          "captionKey": "enum.dayOfWeek.monday",
 50          "caption": "Monday"
 51        },
 52        "dayOfYear": 100
 53      },
 54      "toDate": {
 55        "timing": {
 56          "name": "START_OF_DAY",
 57          "captionKey": "enum.timingType.startOfDay",
 58          "caption": "Start Of Day"
 59        },
 60        "year": 100,
 61        "monthValue": 100,
 62        "dayOfMonth": 100,
 63        "leapYear": false,
 64        "month": {
 65          "name": "JANUARY",
 66          "captionKey": "enum.month.january",
 67          "caption": "January"
 68        },
 69        "dayOfWeek": {
 70          "name": "MONDAY",
 71          "captionKey": "enum.dayOfWeek.monday",
 72          "caption": "Monday"
 73        },
 74        "dayOfYear": 100
 75      },
 76      "fromDateType": {
 77        "name": "AG_ROU_START_DATE",
 78        "captionKey": "enum.fromDateType.agRouStartDate",
 79        "caption": "AG ROU Start Date"
 80      },
 81      "toDateType": {
 82        "name": "USER_DEFINED",
 83        "captionKey": "enum.toDateType.userDefined",
 84        "caption": "User Defined"
 85      },
 86      "internalPostingDateType": {
 87        "name": "SCHEDULE_PERIOD_DATES",
 88        "captionKey": "enum.internalPostingDateType.schedulePeriodDates",
 89        "caption": "Schedule Period Dates"
 90      },
 91      "postingDate": "2025-01-01",
 92      "documentDate": "2025-01-01",
 93      "translationDate": "2025-01-01",
 94      "skipActivationGroupsWithOpenDraft": false,
 95      "retryCount": 100,
 96      "reversalReasonType": {
 97        "name": "ERP_SYSTEM_DEFAULT",
 98        "captionKey": "enum.reversalReasonType.erpSystemDefault",
 99        "caption": "ERP System Default"
100      },
101      "reversalReason": {
102        "id": 50000001,
103        "displayId": "REV-001",
104        "status": {
105          "name": "ACTIVE",
106          "captionKey": "enum.objectStatus.active",
107          "active": true,
108          "caption": "Active"
109        },
110        "name": "Incorrect Indexation",
111        "erpSystemId": 60000001,
112        "erpSystemDisplayId": "SAP-PROD"
113      },
114      "migratedFilterType": {
115        "name": "ALL",
116        "captionKey": "enum.migratedFilterType.all",
117        "caption": "All"
118      },
119      "listObjectType": {
120        "name": "CONTRACT",
121        "captionKey": "enum.listObjectType.contract",
122        "caption": "Contract"
123      },
124      "objectList": []
125    },
126    "profile": {
127      "id": 10000001,
128      "profileId": 10000001,
129      "jobId": 10000001,
130      "name": "Sample Name",
131      "principalPositionType": {
132        "name": "LESSEE",
133        "captionKey": "enum.principalpositiontype.lessee",
134        "caption": "Lessee"
135      },
136      "filterObject": {
137        "erpSystemFilterType": {
138          "name": "ALL",
139          "captionKey": "enum.filterType.all",
140          "caption": "All"
141        },
142        "erpSystems": [],
143        "leaseAreaFilterType": {
144          "name": "ALL",
145          "captionKey": "enum.filterType.all",
146          "caption": "All"
147        },
148        "leaseAreas": [],
149        "businessUnitFilterType": {
150          "name": "ALL",
151          "captionKey": "enum.filterType.all",
152          "caption": "All"
153        },
154        "businessUnits": [],
155        "companyFilterType": {
156          "name": "ALL",
157          "captionKey": "enum.filterType.all",
158          "caption": "All"
159        },
160        "companies": [],
161        "leaseDepartmentFilterType": {
162          "name": "ALL",
163          "captionKey": "enum.filterType.all",
164          "caption": "All"
165        },
166        "leaseDepartments": [],
167        "leaseGroupFilterType": {
168          "name": "ALL",
169          "captionKey": "enum.filterType.all",
170          "caption": "All"
171        },
172        "leaseGroups": [],
173        "costCenterFilterType": {
174          "name": "ALL",
175          "captionKey": "enum.filterType.all",
176          "caption": "All"
177        },
178        "costCenters": [],
179        "profitCenterFilterType": {
180          "name": "ALL",
181          "captionKey": "enum.filterType.all",
182          "caption": "All"
183        },
184        "profitCenters": [],
185        "wbsFilterType": {
186          "name": "ALL",
187          "captionKey": "enum.filterType.all",
188          "caption": "All"
189        },
190        "wbses": [],
191        "businessAreaFilterType": {
192          "name": "ALL",
193          "captionKey": "enum.filterType.all",
194          "caption": "All"
195        },
196        "businessAreas": [],
197        "functionalAreaFilterType": {
198          "name": "ALL",
199          "captionKey": "enum.filterType.all",
200          "caption": "All"
201        },
202        "functionalAreas": []
203      }
204    }
205  }
206]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListOperationalPostingScheduleJobDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": []
11}

Upsert Operational Posting Schedule Job

HTTP Request

PUT /api/v1/batch/operational-posting/schedule-jobs/createOrUpdate

📋 Description: Creates or updates scheduled jobs for operational postings within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and associated financial obligations in the accounting process.

Parameters

Name

In

Type

Required

Description

body

body

OperationalPostingScheduleJobDto

false

Request body containing the lease and contract details, including financial obligations and accounting entries, for creating or updating scheduled jobs in the Nakisa Lease Accounting Suite.

Body Parameters

  1{
  2  "id": 10000001,
  3  "cronExpression": "sample_cronExpression",
  4  "cronReadable": "sample_cronReadable",
  5  "active": true,
  6  "unauthorized": false,
  7  "nextExecution": "2025-01-01T10:00:00Z",
  8  "previousSuccessfulExecution": "2025-01-01T10:00:00Z",
  9  "previousExecution": "2025-01-01T10:00:00Z",
 10  "previousExecutionMessage": "sample_previousExecutionMessage",
 11  "batchSize": 100,
 12  "name": "Sample Name",
 13  "profileId": 10000001,
 14  "input": {
 15    "id": 10000001,
 16    "jobPostingStatuses": {
 17      "name": "DONE",
 18      "captionKey": "enum.postingStatusType.done",
 19      "caption": "Done"
 20    },
 21    "journalTypes": {
 22      "name": "PAYMENT",
 23      "captionKey": "enum.journalPostingType.payment",
 24      "caption": "Payment"
 25    },
 26    "postingTransactionType": {
 27      "name": "POST",
 28      "captionKey": "enum.postingTransactionType.post",
 29      "caption": "Post"
 30    },
 31    "fromDate": {
 32      "timing": {
 33        "name": "START_OF_DAY",
 34        "captionKey": "enum.timingType.startOfDay",
 35        "caption": "Start Of Day"
 36      },
 37      "year": 100,
 38      "monthValue": 100,
 39      "dayOfMonth": 100,
 40      "leapYear": false,
 41      "month": {
 42        "name": "JANUARY",
 43        "captionKey": "enum.month.january",
 44        "caption": "January"
 45      },
 46      "dayOfWeek": {
 47        "name": "MONDAY",
 48        "captionKey": "enum.dayOfWeek.monday",
 49        "caption": "Monday"
 50      },
 51      "dayOfYear": 100
 52    },
 53    "toDate": {
 54      "timing": {
 55        "name": "START_OF_DAY",
 56        "captionKey": "enum.timingType.startOfDay",
 57        "caption": "Start Of Day"
 58      },
 59      "year": 100,
 60      "monthValue": 100,
 61      "dayOfMonth": 100,
 62      "leapYear": false,
 63      "month": {
 64        "name": "JANUARY",
 65        "captionKey": "enum.month.january",
 66        "caption": "January"
 67      },
 68      "dayOfWeek": {
 69        "name": "MONDAY",
 70        "captionKey": "enum.dayOfWeek.monday",
 71        "caption": "Monday"
 72      },
 73      "dayOfYear": 100
 74    },
 75    "fromDateType": {
 76      "name": "AG_ROU_START_DATE",
 77      "captionKey": "enum.fromDateType.agRouStartDate",
 78      "caption": "AG ROU Start Date"
 79    },
 80    "toDateType": {
 81      "name": "USER_DEFINED",
 82      "captionKey": "enum.toDateType.userDefined",
 83      "caption": "User Defined"
 84    },
 85    "internalPostingDateType": {
 86      "name": "SCHEDULE_PERIOD_DATES",
 87      "captionKey": "enum.internalPostingDateType.schedulePeriodDates",
 88      "caption": "Schedule Period Dates"
 89    },
 90    "postingDate": "2025-01-01",
 91    "documentDate": "2025-01-01",
 92    "translationDate": "2025-01-01",
 93    "skipActivationGroupsWithOpenDraft": false,
 94    "retryCount": 100,
 95    "reversalReasonType": {
 96      "name": "ERP_SYSTEM_DEFAULT",
 97      "captionKey": "enum.reversalReasonType.erpSystemDefault",
 98      "caption": "ERP System Default"
 99    },
100    "reversalReason": {
101      "id": 50000001,
102      "displayId": "REV-001",
103      "status": {
104        "name": "ACTIVE",
105        "captionKey": "enum.objectStatus.active",
106        "active": true,
107        "caption": "Active"
108      },
109      "name": "Incorrect Indexation",
110      "erpSystemId": 60000001,
111      "erpSystemDisplayId": "SAP-PROD"
112    },
113    "migratedFilterType": {
114      "name": "ALL",
115      "captionKey": "enum.migratedFilterType.all",
116      "caption": "All"
117    },
118    "listObjectType": {
119      "name": "CONTRACT",
120      "captionKey": "enum.listObjectType.contract",
121      "caption": "Contract"
122    },
123    "objectList": []
124  },
125  "profile": {
126    "id": 10000001,
127    "profileId": 10000001,
128    "jobId": 10000001,
129    "name": "Sample Name",
130    "principalPositionType": {
131      "name": "LESSEE",
132      "captionKey": "enum.principalpositiontype.lessee",
133      "caption": "Lessee"
134    },
135    "filterObject": {
136      "erpSystemFilterType": {
137        "name": "ALL",
138        "captionKey": "enum.filterType.all",
139        "caption": "All"
140      },
141      "erpSystems": [],
142      "leaseAreaFilterType": {
143        "name": "ALL",
144        "captionKey": "enum.filterType.all",
145        "caption": "All"
146      },
147      "leaseAreas": [],
148      "businessUnitFilterType": {
149        "name": "ALL",
150        "captionKey": "enum.filterType.all",
151        "caption": "All"
152      },
153      "businessUnits": [],
154      "companyFilterType": {
155        "name": "ALL",
156        "captionKey": "enum.filterType.all",
157        "caption": "All"
158      },
159      "companies": [],
160      "leaseDepartmentFilterType": {
161        "name": "ALL",
162        "captionKey": "enum.filterType.all",
163        "caption": "All"
164      },
165      "leaseDepartments": [],
166      "leaseGroupFilterType": {
167        "name": "ALL",
168        "captionKey": "enum.filterType.all",
169        "caption": "All"
170      },
171      "leaseGroups": [],
172      "costCenterFilterType": {
173        "name": "ALL",
174        "captionKey": "enum.filterType.all",
175        "caption": "All"
176      },
177      "costCenters": [],
178      "profitCenterFilterType": {
179        "name": "ALL",
180        "captionKey": "enum.filterType.all",
181        "caption": "All"
182      },
183      "profitCenters": [],
184      "wbsFilterType": {
185        "name": "ALL",
186        "captionKey": "enum.filterType.all",
187        "caption": "All"
188      },
189      "wbses": [],
190      "businessAreaFilterType": {
191        "name": "ALL",
192        "captionKey": "enum.filterType.all",
193        "caption": "All"
194      },
195      "businessAreas": [],
196      "functionalAreaFilterType": {
197        "name": "ALL",
198        "captionKey": "enum.filterType.all",
199        "caption": "All"
200      },
201      "functionalAreas": []
202    }
203  }
204}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseOperationalPostingScheduleJobDto

Example Responses

  1{
  2  "code": {
  3    "name": "OK",
  4    "captionKey": "enum.responseCode.ok",
  5    "caption": "OK"
  6  },
  7  "errors": {
  8    "all": []
  9  },
 10  "object": {
 11    "id": 10000001,
 12    "cronExpression": "sample_cronExpression",
 13    "cronReadable": "sample_cronReadable",
 14    "active": true,
 15    "unauthorized": false,
 16    "nextExecution": "2025-01-01T10:00:00Z",
 17    "previousSuccessfulExecution": "2025-01-01T10:00:00Z",
 18    "previousExecution": "2025-01-01T10:00:00Z",
 19    "previousExecutionMessage": "sample_previousExecutionMessage",
 20    "batchSize": 100,
 21    "name": "Sample Name",
 22    "profileId": 10000001,
 23    "input": {
 24      "id": 10000001,
 25      "jobPostingStatuses": {
 26        "name": "DONE",
 27        "captionKey": "enum.postingStatusType.done",
 28        "caption": "Done"
 29      },
 30      "journalTypes": {
 31        "name": "PAYMENT",
 32        "captionKey": "enum.journalPostingType.payment",
 33        "caption": "Payment"
 34      },
 35      "postingTransactionType": {
 36        "name": "POST",
 37        "captionKey": "enum.postingTransactionType.post",
 38        "caption": "Post"
 39      },
 40      "fromDate": {
 41        "timing": {
 42          "name": "START_OF_DAY",
 43          "captionKey": "enum.timingType.startOfDay",
 44          "caption": "Start Of Day"
 45        },
 46        "year": 100,
 47        "monthValue": 100,
 48        "dayOfMonth": 100,
 49        "leapYear": false,
 50        "month": {
 51          "name": "JANUARY",
 52          "captionKey": "enum.month.january",
 53          "caption": "January"
 54        },
 55        "dayOfWeek": {
 56          "name": "MONDAY",
 57          "captionKey": "enum.dayOfWeek.monday",
 58          "caption": "Monday"
 59        },
 60        "dayOfYear": 100
 61      },
 62      "toDate": {
 63        "timing": {
 64          "name": "START_OF_DAY",
 65          "captionKey": "enum.timingType.startOfDay",
 66          "caption": "Start Of Day"
 67        },
 68        "year": 100,
 69        "monthValue": 100,
 70        "dayOfMonth": 100,
 71        "leapYear": false,
 72        "month": {
 73          "name": "JANUARY",
 74          "captionKey": "enum.month.january",
 75          "caption": "January"
 76        },
 77        "dayOfWeek": {
 78          "name": "MONDAY",
 79          "captionKey": "enum.dayOfWeek.monday",
 80          "caption": "Monday"
 81        },
 82        "dayOfYear": 100
 83      },
 84      "fromDateType": {
 85        "name": "AG_ROU_START_DATE",
 86        "captionKey": "enum.fromDateType.agRouStartDate",
 87        "caption": "AG ROU Start Date"
 88      },
 89      "toDateType": {
 90        "name": "USER_DEFINED",
 91        "captionKey": "enum.toDateType.userDefined",
 92        "caption": "User Defined"
 93      },
 94      "internalPostingDateType": {
 95        "name": "SCHEDULE_PERIOD_DATES",
 96        "captionKey": "enum.internalPostingDateType.schedulePeriodDates",
 97        "caption": "Schedule Period Dates"
 98      },
 99      "postingDate": "2025-01-01",
100      "documentDate": "2025-01-01",
101      "translationDate": "2025-01-01",
102      "skipActivationGroupsWithOpenDraft": false,
103      "retryCount": 100,
104      "reversalReasonType": {
105        "name": "ERP_SYSTEM_DEFAULT",
106        "captionKey": "enum.reversalReasonType.erpSystemDefault",
107        "caption": "ERP System Default"
108      },
109      "reversalReason": {
110        "id": 50000001,
111        "displayId": "REV-001",
112        "status": {
113          "name": "ACTIVE",
114          "captionKey": "enum.objectStatus.active",
115          "active": true,
116          "caption": "Active"
117        },
118        "name": "Incorrect Indexation",
119        "erpSystemId": 60000001,
120        "erpSystemDisplayId": "SAP-PROD"
121      },
122      "migratedFilterType": {
123        "name": "ALL",
124        "captionKey": "enum.migratedFilterType.all",
125        "caption": "All"
126      },
127      "listObjectType": {
128        "name": "CONTRACT",
129        "captionKey": "enum.listObjectType.contract",
130        "caption": "Contract"
131      },
132      "objectList": []
133    },
134    "profile": {
135      "id": 10000001,
136      "profileId": 10000001,
137      "jobId": 10000001,
138      "name": "Sample Name",
139      "principalPositionType": {
140        "name": "LESSEE",
141        "captionKey": "enum.principalpositiontype.lessee",
142        "caption": "Lessee"
143      },
144      "filterObject": {
145        "erpSystemFilterType": {
146          "name": "ALL",
147          "captionKey": "enum.filterType.all",
148          "caption": "All"
149        },
150        "erpSystems": [],
151        "leaseAreaFilterType": {
152          "name": "ALL",
153          "captionKey": "enum.filterType.all",
154          "caption": "All"
155        },
156        "leaseAreas": [],
157        "businessUnitFilterType": {
158          "name": "ALL",
159          "captionKey": "enum.filterType.all",
160          "caption": "All"
161        },
162        "businessUnits": [],
163        "companyFilterType": {
164          "name": "ALL",
165          "captionKey": "enum.filterType.all",
166          "caption": "All"
167        },
168        "companies": [],
169        "leaseDepartmentFilterType": {
170          "name": "ALL",
171          "captionKey": "enum.filterType.all",
172          "caption": "All"
173        },
174        "leaseDepartments": [],
175        "leaseGroupFilterType": {
176          "name": "ALL",
177          "captionKey": "enum.filterType.all",
178          "caption": "All"
179        },
180        "leaseGroups": [],
181        "costCenterFilterType": {
182          "name": "ALL",
183          "captionKey": "enum.filterType.all",
184          "caption": "All"
185        },
186        "costCenters": [],
187        "profitCenterFilterType": {
188          "name": "ALL",
189          "captionKey": "enum.filterType.all",
190          "caption": "All"
191        },
192        "profitCenters": [],
193        "wbsFilterType": {
194          "name": "ALL",
195          "captionKey": "enum.filterType.all",
196          "caption": "All"
197        },
198        "wbses": [],
199        "businessAreaFilterType": {
200          "name": "ALL",
201          "captionKey": "enum.filterType.all",
202          "caption": "All"
203        },
204        "businessAreas": [],
205        "functionalAreaFilterType": {
206          "name": "ALL",
207          "captionKey": "enum.filterType.all",
208          "caption": "All"
209        },
210        "functionalAreas": []
211      }
212    }
213  }
214}

Create Or Update Operational Posting Schedule Job

HTTP Request

POST /api/v1/batch/operational-posting/schedule-jobs/createOrUpdate

📋 Description: Creates or updates scheduled jobs for operational postings within the Nakisa Lease Accounting Suite, facilitating efficient management of leases, contracts, and associated financial obligations. This operation ensures accurate accounting entries are processed in alignment with business requirements.

Parameters

Name

In

Type

Required

Description

body

body

OperationalPostingScheduleJobDto

false

Request body containing lease and contract details, including financial obligations and accounting entries, for creating or updating scheduled jobs in the Nakisa Lease Accounting Suite.

Body Parameters

  1{
  2  "id": 10000001,
  3  "cronExpression": "sample_cronExpression",
  4  "cronReadable": "sample_cronReadable",
  5  "active": true,
  6  "unauthorized": false,
  7  "nextExecution": "2025-01-01T10:00:00Z",
  8  "previousSuccessfulExecution": "2025-01-01T10:00:00Z",
  9  "previousExecution": "2025-01-01T10:00:00Z",
 10  "previousExecutionMessage": "sample_previousExecutionMessage",
 11  "batchSize": 100,
 12  "name": "Sample Name",
 13  "profileId": 10000001,
 14  "input": {
 15    "id": 10000001,
 16    "jobPostingStatuses": {
 17      "name": "DONE",
 18      "captionKey": "enum.postingStatusType.done",
 19      "caption": "Done"
 20    },
 21    "journalTypes": {
 22      "name": "PAYMENT",
 23      "captionKey": "enum.journalPostingType.payment",
 24      "caption": "Payment"
 25    },
 26    "postingTransactionType": {
 27      "name": "POST",
 28      "captionKey": "enum.postingTransactionType.post",
 29      "caption": "Post"
 30    },
 31    "fromDate": {
 32      "timing": {
 33        "name": "START_OF_DAY",
 34        "captionKey": "enum.timingType.startOfDay",
 35        "caption": "Start Of Day"
 36      },
 37      "year": 100,
 38      "monthValue": 100,
 39      "dayOfMonth": 100,
 40      "leapYear": false,
 41      "month": {
 42        "name": "JANUARY",
 43        "captionKey": "enum.month.january",
 44        "caption": "January"
 45      },
 46      "dayOfWeek": {
 47        "name": "MONDAY",
 48        "captionKey": "enum.dayOfWeek.monday",
 49        "caption": "Monday"
 50      },
 51      "dayOfYear": 100
 52    },
 53    "toDate": {
 54      "timing": {
 55        "name": "START_OF_DAY",
 56        "captionKey": "enum.timingType.startOfDay",
 57        "caption": "Start Of Day"
 58      },
 59      "year": 100,
 60      "monthValue": 100,
 61      "dayOfMonth": 100,
 62      "leapYear": false,
 63      "month": {
 64        "name": "JANUARY",
 65        "captionKey": "enum.month.january",
 66        "caption": "January"
 67      },
 68      "dayOfWeek": {
 69        "name": "MONDAY",
 70        "captionKey": "enum.dayOfWeek.monday",
 71        "caption": "Monday"
 72      },
 73      "dayOfYear": 100
 74    },
 75    "fromDateType": {
 76      "name": "AG_ROU_START_DATE",
 77      "captionKey": "enum.fromDateType.agRouStartDate",
 78      "caption": "AG ROU Start Date"
 79    },
 80    "toDateType": {
 81      "name": "USER_DEFINED",
 82      "captionKey": "enum.toDateType.userDefined",
 83      "caption": "User Defined"
 84    },
 85    "internalPostingDateType": {
 86      "name": "SCHEDULE_PERIOD_DATES",
 87      "captionKey": "enum.internalPostingDateType.schedulePeriodDates",
 88      "caption": "Schedule Period Dates"
 89    },
 90    "postingDate": "2025-01-01",
 91    "documentDate": "2025-01-01",
 92    "translationDate": "2025-01-01",
 93    "skipActivationGroupsWithOpenDraft": false,
 94    "retryCount": 100,
 95    "reversalReasonType": {
 96      "name": "ERP_SYSTEM_DEFAULT",
 97      "captionKey": "enum.reversalReasonType.erpSystemDefault",
 98      "caption": "ERP System Default"
 99    },
100    "reversalReason": {
101      "id": 50000001,
102      "displayId": "REV-001",
103      "status": {
104        "name": "ACTIVE",
105        "captionKey": "enum.objectStatus.active",
106        "active": true,
107        "caption": "Active"
108      },
109      "name": "Incorrect Indexation",
110      "erpSystemId": 60000001,
111      "erpSystemDisplayId": "SAP-PROD"
112    },
113    "migratedFilterType": {
114      "name": "ALL",
115      "captionKey": "enum.migratedFilterType.all",
116      "caption": "All"
117    },
118    "listObjectType": {
119      "name": "CONTRACT",
120      "captionKey": "enum.listObjectType.contract",
121      "caption": "Contract"
122    },
123    "objectList": []
124  },
125  "profile": {
126    "id": 10000001,
127    "profileId": 10000001,
128    "jobId": 10000001,
129    "name": "Sample Name",
130    "principalPositionType": {
131      "name": "LESSEE",
132      "captionKey": "enum.principalpositiontype.lessee",
133      "caption": "Lessee"
134    },
135    "filterObject": {
136      "erpSystemFilterType": {
137        "name": "ALL",
138        "captionKey": "enum.filterType.all",
139        "caption": "All"
140      },
141      "erpSystems": [],
142      "leaseAreaFilterType": {
143        "name": "ALL",
144        "captionKey": "enum.filterType.all",
145        "caption": "All"
146      },
147      "leaseAreas": [],
148      "businessUnitFilterType": {
149        "name": "ALL",
150        "captionKey": "enum.filterType.all",
151        "caption": "All"
152      },
153      "businessUnits": [],
154      "companyFilterType": {
155        "name": "ALL",
156        "captionKey": "enum.filterType.all",
157        "caption": "All"
158      },
159      "companies": [],
160      "leaseDepartmentFilterType": {
161        "name": "ALL",
162        "captionKey": "enum.filterType.all",
163        "caption": "All"
164      },
165      "leaseDepartments": [],
166      "leaseGroupFilterType": {
167        "name": "ALL",
168        "captionKey": "enum.filterType.all",
169        "caption": "All"
170      },
171      "leaseGroups": [],
172      "costCenterFilterType": {
173        "name": "ALL",
174        "captionKey": "enum.filterType.all",
175        "caption": "All"
176      },
177      "costCenters": [],
178      "profitCenterFilterType": {
179        "name": "ALL",
180        "captionKey": "enum.filterType.all",
181        "caption": "All"
182      },
183      "profitCenters": [],
184      "wbsFilterType": {
185        "name": "ALL",
186        "captionKey": "enum.filterType.all",
187        "caption": "All"
188      },
189      "wbses": [],
190      "businessAreaFilterType": {
191        "name": "ALL",
192        "captionKey": "enum.filterType.all",
193        "caption": "All"
194      },
195      "businessAreas": [],
196      "functionalAreaFilterType": {
197        "name": "ALL",
198        "captionKey": "enum.filterType.all",
199        "caption": "All"
200      },
201      "functionalAreas": []
202    }
203  }
204}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseOperationalPostingScheduleJobDto

Example Responses

  1{
  2  "code": {
  3    "name": "OK",
  4    "captionKey": "enum.responseCode.ok",
  5    "caption": "OK"
  6  },
  7  "errors": {
  8    "all": []
  9  },
 10  "object": {
 11    "id": 10000001,
 12    "cronExpression": "sample_cronExpression",
 13    "cronReadable": "sample_cronReadable",
 14    "active": true,
 15    "unauthorized": false,
 16    "nextExecution": "2025-01-01T10:00:00Z",
 17    "previousSuccessfulExecution": "2025-01-01T10:00:00Z",
 18    "previousExecution": "2025-01-01T10:00:00Z",
 19    "previousExecutionMessage": "sample_previousExecutionMessage",
 20    "batchSize": 100,
 21    "name": "Sample Name",
 22    "profileId": 10000001,
 23    "input": {
 24      "id": 10000001,
 25      "jobPostingStatuses": {
 26        "name": "DONE",
 27        "captionKey": "enum.postingStatusType.done",
 28        "caption": "Done"
 29      },
 30      "journalTypes": {
 31        "name": "PAYMENT",
 32        "captionKey": "enum.journalPostingType.payment",
 33        "caption": "Payment"
 34      },
 35      "postingTransactionType": {
 36        "name": "POST",
 37        "captionKey": "enum.postingTransactionType.post",
 38        "caption": "Post"
 39      },
 40      "fromDate": {
 41        "timing": {
 42          "name": "START_OF_DAY",
 43          "captionKey": "enum.timingType.startOfDay",
 44          "caption": "Start Of Day"
 45        },
 46        "year": 100,
 47        "monthValue": 100,
 48        "dayOfMonth": 100,
 49        "leapYear": false,
 50        "month": {
 51          "name": "JANUARY",
 52          "captionKey": "enum.month.january",
 53          "caption": "January"
 54        },
 55        "dayOfWeek": {
 56          "name": "MONDAY",
 57          "captionKey": "enum.dayOfWeek.monday",
 58          "caption": "Monday"
 59        },
 60        "dayOfYear": 100
 61      },
 62      "toDate": {
 63        "timing": {
 64          "name": "START_OF_DAY",
 65          "captionKey": "enum.timingType.startOfDay",
 66          "caption": "Start Of Day"
 67        },
 68        "year": 100,
 69        "monthValue": 100,
 70        "dayOfMonth": 100,
 71        "leapYear": false,
 72        "month": {
 73          "name": "JANUARY",
 74          "captionKey": "enum.month.january",
 75          "caption": "January"
 76        },
 77        "dayOfWeek": {
 78          "name": "MONDAY",
 79          "captionKey": "enum.dayOfWeek.monday",
 80          "caption": "Monday"
 81        },
 82        "dayOfYear": 100
 83      },
 84      "fromDateType": {
 85        "name": "AG_ROU_START_DATE",
 86        "captionKey": "enum.fromDateType.agRouStartDate",
 87        "caption": "AG ROU Start Date"
 88      },
 89      "toDateType": {
 90        "name": "USER_DEFINED",
 91        "captionKey": "enum.toDateType.userDefined",
 92        "caption": "User Defined"
 93      },
 94      "internalPostingDateType": {
 95        "name": "SCHEDULE_PERIOD_DATES",
 96        "captionKey": "enum.internalPostingDateType.schedulePeriodDates",
 97        "caption": "Schedule Period Dates"
 98      },
 99      "postingDate": "2025-01-01",
100      "documentDate": "2025-01-01",
101      "translationDate": "2025-01-01",
102      "skipActivationGroupsWithOpenDraft": false,
103      "retryCount": 100,
104      "reversalReasonType": {
105        "name": "ERP_SYSTEM_DEFAULT",
106        "captionKey": "enum.reversalReasonType.erpSystemDefault",
107        "caption": "ERP System Default"
108      },
109      "reversalReason": {
110        "id": 50000001,
111        "displayId": "REV-001",
112        "status": {
113          "name": "ACTIVE",
114          "captionKey": "enum.objectStatus.active",
115          "active": true,
116          "caption": "Active"
117        },
118        "name": "Incorrect Indexation",
119        "erpSystemId": 60000001,
120        "erpSystemDisplayId": "SAP-PROD"
121      },
122      "migratedFilterType": {
123        "name": "ALL",
124        "captionKey": "enum.migratedFilterType.all",
125        "caption": "All"
126      },
127      "listObjectType": {
128        "name": "CONTRACT",
129        "captionKey": "enum.listObjectType.contract",
130        "caption": "Contract"
131      },
132      "objectList": []
133    },
134    "profile": {
135      "id": 10000001,
136      "profileId": 10000001,
137      "jobId": 10000001,
138      "name": "Sample Name",
139      "principalPositionType": {
140        "name": "LESSEE",
141        "captionKey": "enum.principalpositiontype.lessee",
142        "caption": "Lessee"
143      },
144      "filterObject": {
145        "erpSystemFilterType": {
146          "name": "ALL",
147          "captionKey": "enum.filterType.all",
148          "caption": "All"
149        },
150        "erpSystems": [],
151        "leaseAreaFilterType": {
152          "name": "ALL",
153          "captionKey": "enum.filterType.all",
154          "caption": "All"
155        },
156        "leaseAreas": [],
157        "businessUnitFilterType": {
158          "name": "ALL",
159          "captionKey": "enum.filterType.all",
160          "caption": "All"
161        },
162        "businessUnits": [],
163        "companyFilterType": {
164          "name": "ALL",
165          "captionKey": "enum.filterType.all",
166          "caption": "All"
167        },
168        "companies": [],
169        "leaseDepartmentFilterType": {
170          "name": "ALL",
171          "captionKey": "enum.filterType.all",
172          "caption": "All"
173        },
174        "leaseDepartments": [],
175        "leaseGroupFilterType": {
176          "name": "ALL",
177          "captionKey": "enum.filterType.all",
178          "caption": "All"
179        },
180        "leaseGroups": [],
181        "costCenterFilterType": {
182          "name": "ALL",
183          "captionKey": "enum.filterType.all",
184          "caption": "All"
185        },
186        "costCenters": [],
187        "profitCenterFilterType": {
188          "name": "ALL",
189          "captionKey": "enum.filterType.all",
190          "caption": "All"
191        },
192        "profitCenters": [],
193        "wbsFilterType": {
194          "name": "ALL",
195          "captionKey": "enum.filterType.all",
196          "caption": "All"
197        },
198        "wbses": [],
199        "businessAreaFilterType": {
200          "name": "ALL",
201          "captionKey": "enum.filterType.all",
202          "caption": "All"
203        },
204        "businessAreas": [],
205        "functionalAreaFilterType": {
206          "name": "ALL",
207          "captionKey": "enum.filterType.all",
208          "caption": "All"
209        },
210        "functionalAreas": []
211      }
212    }
213  }
214}

Bulk Update Operational Posting Schedule Jobs

HTTP Request

PUT /api/v1/batch/operational-posting/schedule-jobs/bulk

📋 Description: Updates and schedules multiple operational posting jobs in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of lease contracts and associated financial obligations.

Parameters

Name

In

Type

Required

Description

body

body

OperationalPostingScheduleJobDto

false

Request body containing a collection of bulk scheduling job details related to lease and contract management, including financial obligations and accounting entries.

Body Parameters

  1[
  2  {
  3    "id": 10000001,
  4    "cronExpression": "sample_cronExpression",
  5    "cronReadable": "sample_cronReadable",
  6    "active": true,
  7    "unauthorized": false,
  8    "nextExecution": "2025-01-01T10:00:00Z",
  9    "previousSuccessfulExecution": "2025-01-01T10:00:00Z",
 10    "previousExecution": "2025-01-01T10:00:00Z",
 11    "previousExecutionMessage": "sample_previousExecutionMessage",
 12    "batchSize": 100,
 13    "name": "Sample Name",
 14    "profileId": 10000001,
 15    "input": {
 16      "id": 10000001,
 17      "jobPostingStatuses": {
 18        "name": "DONE",
 19        "captionKey": "enum.postingStatusType.done",
 20        "caption": "Done"
 21      },
 22      "journalTypes": {
 23        "name": "PAYMENT",
 24        "captionKey": "enum.journalPostingType.payment",
 25        "caption": "Payment"
 26      },
 27      "postingTransactionType": {
 28        "name": "POST",
 29        "captionKey": "enum.postingTransactionType.post",
 30        "caption": "Post"
 31      },
 32      "fromDate": {
 33        "timing": {
 34          "name": "START_OF_DAY",
 35          "captionKey": "enum.timingType.startOfDay",
 36          "caption": "Start Of Day"
 37        },
 38        "year": 100,
 39        "monthValue": 100,
 40        "dayOfMonth": 100,
 41        "leapYear": false,
 42        "month": {
 43          "name": "JANUARY",
 44          "captionKey": "enum.month.january",
 45          "caption": "January"
 46        },
 47        "dayOfWeek": {
 48          "name": "MONDAY",
 49          "captionKey": "enum.dayOfWeek.monday",
 50          "caption": "Monday"
 51        },
 52        "dayOfYear": 100
 53      },
 54      "toDate": {
 55        "timing": {
 56          "name": "START_OF_DAY",
 57          "captionKey": "enum.timingType.startOfDay",
 58          "caption": "Start Of Day"
 59        },
 60        "year": 100,
 61        "monthValue": 100,
 62        "dayOfMonth": 100,
 63        "leapYear": false,
 64        "month": {
 65          "name": "JANUARY",
 66          "captionKey": "enum.month.january",
 67          "caption": "January"
 68        },
 69        "dayOfWeek": {
 70          "name": "MONDAY",
 71          "captionKey": "enum.dayOfWeek.monday",
 72          "caption": "Monday"
 73        },
 74        "dayOfYear": 100
 75      },
 76      "fromDateType": {
 77        "name": "AG_ROU_START_DATE",
 78        "captionKey": "enum.fromDateType.agRouStartDate",
 79        "caption": "AG ROU Start Date"
 80      },
 81      "toDateType": {
 82        "name": "USER_DEFINED",
 83        "captionKey": "enum.toDateType.userDefined",
 84        "caption": "User Defined"
 85      },
 86      "internalPostingDateType": {
 87        "name": "SCHEDULE_PERIOD_DATES",
 88        "captionKey": "enum.internalPostingDateType.schedulePeriodDates",
 89        "caption": "Schedule Period Dates"
 90      },
 91      "postingDate": "2025-01-01",
 92      "documentDate": "2025-01-01",
 93      "translationDate": "2025-01-01",
 94      "skipActivationGroupsWithOpenDraft": false,
 95      "retryCount": 100,
 96      "reversalReasonType": {
 97        "name": "ERP_SYSTEM_DEFAULT",
 98        "captionKey": "enum.reversalReasonType.erpSystemDefault",
 99        "caption": "ERP System Default"
100      },
101      "reversalReason": {
102        "id": 50000001,
103        "displayId": "REV-001",
104        "status": {
105          "name": "ACTIVE",
106          "captionKey": "enum.objectStatus.active",
107          "active": true,
108          "caption": "Active"
109        },
110        "name": "Incorrect Indexation",
111        "erpSystemId": 60000001,
112        "erpSystemDisplayId": "SAP-PROD"
113      },
114      "migratedFilterType": {
115        "name": "ALL",
116        "captionKey": "enum.migratedFilterType.all",
117        "caption": "All"
118      },
119      "listObjectType": {
120        "name": "CONTRACT",
121        "captionKey": "enum.listObjectType.contract",
122        "caption": "Contract"
123      },
124      "objectList": []
125    },
126    "profile": {
127      "id": 10000001,
128      "profileId": 10000001,
129      "jobId": 10000001,
130      "name": "Sample Name",
131      "principalPositionType": {
132        "name": "LESSEE",
133        "captionKey": "enum.principalpositiontype.lessee",
134        "caption": "Lessee"
135      },
136      "filterObject": {
137        "erpSystemFilterType": {
138          "name": "ALL",
139          "captionKey": "enum.filterType.all",
140          "caption": "All"
141        },
142        "erpSystems": [],
143        "leaseAreaFilterType": {
144          "name": "ALL",
145          "captionKey": "enum.filterType.all",
146          "caption": "All"
147        },
148        "leaseAreas": [],
149        "businessUnitFilterType": {
150          "name": "ALL",
151          "captionKey": "enum.filterType.all",
152          "caption": "All"
153        },
154        "businessUnits": [],
155        "companyFilterType": {
156          "name": "ALL",
157          "captionKey": "enum.filterType.all",
158          "caption": "All"
159        },
160        "companies": [],
161        "leaseDepartmentFilterType": {
162          "name": "ALL",
163          "captionKey": "enum.filterType.all",
164          "caption": "All"
165        },
166        "leaseDepartments": [],
167        "leaseGroupFilterType": {
168          "name": "ALL",
169          "captionKey": "enum.filterType.all",
170          "caption": "All"
171        },
172        "leaseGroups": [],
173        "costCenterFilterType": {
174          "name": "ALL",
175          "captionKey": "enum.filterType.all",
176          "caption": "All"
177        },
178        "costCenters": [],
179        "profitCenterFilterType": {
180          "name": "ALL",
181          "captionKey": "enum.filterType.all",
182          "caption": "All"
183        },
184        "profitCenters": [],
185        "wbsFilterType": {
186          "name": "ALL",
187          "captionKey": "enum.filterType.all",
188          "caption": "All"
189        },
190        "wbses": [],
191        "businessAreaFilterType": {
192          "name": "ALL",
193          "captionKey": "enum.filterType.all",
194          "caption": "All"
195        },
196        "businessAreas": [],
197        "functionalAreaFilterType": {
198          "name": "ALL",
199          "captionKey": "enum.filterType.all",
200          "caption": "All"
201        },
202        "functionalAreas": []
203      }
204    }
205  }
206]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListOperationalPostingScheduleJobDto

Example Responses

 1{
 2  "code": {
 3    "name": "OK",
 4    "captionKey": "enum.responseCode.ok",
 5    "caption": "OK"
 6  },
 7  "errors": {
 8    "all": []
 9  },
10  "object": []
11}

Bulk Delete Operational Posting Schedule Jobs

HTTP Request

DELETE /api/v1/batch/operational-posting/schedule-jobs/bulk

📋 Description: Deletes multiple scheduled jobs related to operational postings in the Nakisa Lease Accounting Suite, streamlining the management of lease and contract-related financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

Request body containing a list of scheduled job identifiers for bulk deletion related to lease and contract financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Enable Or Disable Operational Posting Schedule Job

HTTP Request

POST /api/v1/batch/operational-posting/schedule-jobs/{id}/enable/{state}

📋 Description: Enables or disables scheduled jobs for operational postings within the Nakisa Lease Accounting Suite, allowing users to manage lease and contract-related financial obligations efficiently. This operation ensures accurate accounting entries by controlling job execution states.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

state

path

boolean

true

Indicates whether to enable or disable the scheduled jobs associated with the specified lease or contract, impacting the processing of financial obligations and accounting entries.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Search Operational Posting Schedule Jobs

HTTP Request

POST /api/v1/batch/operational-posting/schedule-jobs/search

📋 Description: Schedules and initiates batch operational posting jobs for lease and contract management, enabling efficient processing of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

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

OperationalPostingScheduleJobDtoFilter

false

Request body containing the search criteria for scheduling operational posting jobs, including lease, contract, and financial obligation details relevant to accounting entries.

Default Values

Parameter

Default

Type

sort

["createdAt,ASC"]

query

Body Parameters

 1{
 2  "idIn": [],
 3  "idEqual": 10000001,
 4  "idLike": "sample_idLike",
 5  "createdAtGreaterThanOrEqual": "2025-01-01T10:00:00Z",
 6  "createdAtLessThanOrEqual": "2025-01-01T10:00:00Z",
 7  "createdByLike": "sample_createdByLike",
 8  "createdByEqual": "sample_createdByEqual",
 9  "modifiedAtGreaterThanOrEqual": "2025-01-01T10:00:00Z",
10  "modifiedAtLessThanOrEqual": "2025-01-01T10:00:00Z",
11  "modifiedByLike": "sample_modifiedByLike",
12  "modifiedByEqual": "sample_modifiedByEqual",
13  "activeEqual": false,
14  "nameLike": "sample_nameLike",
15  "profileIdEqual": 10000001,
16  "postingTransactionTypeEqual": {
17    "name": "POST",
18    "captionKey": "enum.postingTransactionType.post",
19    "caption": "Post"
20  }
21}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageOperationalPostingScheduleJobDto

Example Responses

 1{
 2  "totalElements": 10000001,
 3  "totalPages": 100,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 100,
17  "size": 100,
18  "content": [],
19  "number": 100,
20  "sort": {
21    "unsorted": false,
22    "sorted": true,
23    "empty": false
24  },
25  "first": false,
26  "last": false,
27  "empty": false
28}

List All Posting Transaction Type Optionss

HTTP Request

GET /api/v1/batch/operational-posting/schedule-jobs/posting_transaction_type_options

📋 Description: Retrieves available posting transaction type options for scheduled jobs within the Nakisa Lease Accounting Suite, facilitating accurate lease and contract management related to financial obligations and accounting entries.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "string"
3]

Response Schema

List All Operational Posting Schedule Jobs (With Internal Posting Date Type)

HTTP Request

GET /api/v1/batch/operational-posting/schedule-jobs/internal_posting_date_type

📋 Description: Retrieves the scheduled jobs for internal posting date types within the Nakisa Lease Accounting Suite, facilitating effective management of lease contracts and financial obligations in accounting entries.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "string"
3]

Response Schema

List All Operational Posting Schedule Jobs

HTTP Request

GET /api/v1/batch/operational-posting/schedule-jobs

📋 Description: Fetches scheduled jobs for operational postings within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and associated financial obligations.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the scheduled jobs query should be returned in a paginated format, facilitating efficient data retrieval for lease and contract management within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageOperationalPostingScheduleJobDto

Example Responses

 1{
 2  "totalElements": 10000001,
 3  "totalPages": 100,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 100,
17  "size": 100,
18  "content": [],
19  "number": 100,
20  "sort": {
21    "unsorted": false,
22    "sorted": true,
23    "empty": false
24  },
25  "first": false,
26  "last": false,
27  "empty": false
28}