Periodic Posting Status Report Job Controller¶
Get Periodic Posting Status Report Job By ID¶
HTTP Request
GET /api/v1/periodic_posting_status_reports/jobs/{id}
📋 Description: Retrieves the status report for a specific periodic posting job identified by the provided job ID, facilitating oversight of lease and contract-related financial obligations within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "taskCount": 100,
13 "failedTaskCount": 100,
14 "doneTaskCount": 100,
15 "inProgressTaskCount": 100,
16 "cancelledTaskCount": 100,
17 "errorMessage": "sample_errorMessage",
18 "executor": {
19 "name": "MANUAL",
20 "captionKey": "enum.batchJobExecutor.manual",
21 "caption": "Manual"
22 },
23 "scheduleJobId": 10000001,
24 "batchSize": 1000,
25 "totalObjectCount": 100,
26 "profileId": 10000001,
27 "readOnly": false,
28 "status": {
29 "name": "PROCESSING",
30 "captionKey": "enum.batchJobStatus.processing",
31 "caption": "Processing"
32 },
33 "fileStorageId": "sample_fileStorageId",
34 "generatingExportFile": false,
35 "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
36 "finishedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
37 "input": {
38 "id": 10000001,
39 "accountingStandardType": {
40 "name": "GAAP",
41 "captionKey": "enum.accountingStandard.gaap",
42 "caption": "GAAP"
43 },
44 "classifications": {
45 "name": "FINANCE",
46 "captionKey": "enum.leaseClassificationType.finance",
47 "caption": "Finance Lease"
48 },
49 "fromYear": 100,
50 "fromPeriod": {
51 "id": 10000001,
52 "displayId": "FP-2024-Q1",
53 "status": {
54 "name": "ACTIVE",
55 "captionKey": "enum.objectStatus.active",
56 "active": true,
57 "caption": "Active"
58 },
59 "day": 15,
60 "year": 2024,
61 "month": 3,
62 "postingPeriod": 3,
63 "yearShift": 0
64 },
65 "toYear": 100,
66 "toPeriod": {
67 "id": 10000001,
68 "displayId": "FP-2024-Q1",
69 "status": {
70 "name": "ACTIVE",
71 "captionKey": "enum.objectStatus.active",
72 "active": true,
73 "caption": "Active"
74 },
75 "day": 15,
76 "year": 2024,
77 "month": 3,
78 "postingPeriod": 3,
79 "yearShift": 0
80 },
81 "fromDate": "2025-01-01",
82 "toDate": "2025-01-01",
83 "fromDateType": "USER_DEFINED",
84 "toDateType": "USER_DEFINED",
85 "postingType": {
86 "name": "ACCRUAL",
87 "captionKey": "enum.postingType.accrual",
88 "caption": "Accrual"
89 },
90 "externalStatusFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 },
95 "externalStatuses": {
96 "name": "PROCESSING",
97 "captionKey": "enum.taskStatus.processing",
98 "caption": "Processing"
99 },
100 "internalStatusFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "internalStatuses": {
106 "name": "PROCESSING",
107 "captionKey": "enum.taskStatus.processing",
108 "caption": "Processing"
109 },
110 "listObjectType": {
111 "name": "ACTIVATION_GROUP",
112 "captionKey": "enum.listObjectType.activationGroup",
113 "caption": "Activation Group"
114 },
115 "objectList": [],
116 "migratedFilterType": {
117 "name": "ALL",
118 "captionKey": "enum.migratedFilterType.all",
119 "caption": "All"
120 },
121 "internalAssetClassFilterType": {
122 "name": "ALL",
123 "captionKey": "enum.filterType.all",
124 "caption": "All"
125 },
126 "internalAssetClasses": [],
127 "businessAreaFilterType": {
128 "name": "ALL",
129 "captionKey": "enum.filterType.all",
130 "caption": "All"
131 },
132 "businessAreas": [],
133 "functionalAreaFilterType": {
134 "name": "ALL",
135 "captionKey": "enum.filterType.all",
136 "caption": "All"
137 },
138 "functionalAreas": []
139 },
140 "filter": {
141 "id": 10000001,
142 "name": "Sample Name",
143 "principalPositionType": {
144 "name": "LESSEE",
145 "captionKey": "enum.principalpositiontype.lessee",
146 "caption": "Lessee"
147 },
148 "calendarType": {
149 "name": "_360",
150 "captionKey": "enum.calendarType.360",
151 "caption": "360 Convention"
152 },
153 "fiscalYearVariant": {
154 "id": "string",
155 "displayId": "Euro"
156 },
157 "profileId": 10000001,
158 "jobId": 10000001,
159 "objectList": [],
160 "filterTypes": {
161 "erpSystemFilterType": {
162 "name": "ALL",
163 "captionKey": "enum.filterType.all",
164 "caption": "All"
165 },
166 "erpSystems": [],
167 "leaseAreaFilterType": {
168 "name": "ALL",
169 "captionKey": "enum.filterType.all",
170 "caption": "All"
171 },
172 "leaseAreas": [],
173 "businessUnitFilterType": {
174 "name": "ALL",
175 "captionKey": "enum.filterType.all",
176 "caption": "All"
177 },
178 "businessUnits": [],
179 "companyFilterType": {
180 "name": "ALL",
181 "captionKey": "enum.filterType.all",
182 "caption": "All"
183 },
184 "companies": [],
185 "leaseDepartmentFilterType": {
186 "name": "ALL",
187 "captionKey": "enum.filterType.all",
188 "caption": "All"
189 },
190 "leaseDepartments": [],
191 "leaseGroupFilterType": {
192 "name": "ALL",
193 "captionKey": "enum.filterType.all",
194 "caption": "All"
195 },
196 "leaseGroups": [],
197 "costCenterFilterType": {
198 "name": "ALL",
199 "captionKey": "enum.filterType.all",
200 "caption": "All"
201 },
202 "costCenters": [],
203 "profitCenterFilterType": {
204 "name": "ALL",
205 "captionKey": "enum.filterType.all",
206 "caption": "All"
207 },
208 "profitCenters": [],
209 "wbsFilterType": {
210 "name": "ALL",
211 "captionKey": "enum.filterType.all",
212 "caption": "All"
213 },
214 "wbses": [],
215 "businessAreaFilterType": {
216 "name": "ALL",
217 "captionKey": "enum.filterType.all",
218 "caption": "All"
219 },
220 "businessAreas": [],
221 "functionalAreaFilterType": {
222 "name": "ALL",
223 "captionKey": "enum.filterType.all",
224 "caption": "All"
225 },
226 "functionalAreas": []
227 }
228 },
229 "tasks": [],
230 "docStoreId": 10000001
231 }
232}
Update Periodic Posting Status Report Job¶
HTTP Request
PUT /api/v1/periodic_posting_status_reports/jobs/{id}
📋 Description: Updates the status of a specific periodic posting job identified by the provided ID within the Nakisa Lease Accounting Suite, ensuring accurate tracking of lease-related financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
body |
body |
false |
Request body containing the updated periodic posting status report data, including lease and contract details, financial obligations, and associated accounting entries. |
Body Parameters
1{
2 "id": 10000001,
3 "taskCount": 100,
4 "failedTaskCount": 100,
5 "doneTaskCount": 100,
6 "inProgressTaskCount": 100,
7 "cancelledTaskCount": 100,
8 "errorMessage": "sample_errorMessage",
9 "executor": {
10 "name": "MANUAL",
11 "captionKey": "enum.batchJobExecutor.manual",
12 "caption": "Manual"
13 },
14 "scheduleJobId": 10000001,
15 "batchSize": 1000,
16 "totalObjectCount": 100,
17 "profileId": 10000001,
18 "readOnly": false,
19 "status": {
20 "name": "PROCESSING",
21 "captionKey": "enum.batchJobStatus.processing",
22 "caption": "Processing"
23 },
24 "fileStorageId": "sample_fileStorageId",
25 "generatingExportFile": false,
26 "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
27 "finishedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
28 "input": {
29 "id": 10000001,
30 "accountingStandardType": {
31 "name": "GAAP",
32 "captionKey": "enum.accountingStandard.gaap",
33 "caption": "GAAP"
34 },
35 "classifications": {
36 "name": "FINANCE",
37 "captionKey": "enum.leaseClassificationType.finance",
38 "caption": "Finance Lease"
39 },
40 "fromYear": 100,
41 "fromPeriod": {
42 "id": 10000001,
43 "displayId": "FP-2024-Q1",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "day": 15,
51 "year": 2024,
52 "month": 3,
53 "postingPeriod": 3,
54 "yearShift": 0
55 },
56 "toYear": 100,
57 "toPeriod": {
58 "id": 10000001,
59 "displayId": "FP-2024-Q1",
60 "status": {
61 "name": "ACTIVE",
62 "captionKey": "enum.objectStatus.active",
63 "active": true,
64 "caption": "Active"
65 },
66 "day": 15,
67 "year": 2024,
68 "month": 3,
69 "postingPeriod": 3,
70 "yearShift": 0
71 },
72 "fromDate": "2025-01-01",
73 "toDate": "2025-01-01",
74 "fromDateType": "USER_DEFINED",
75 "toDateType": "USER_DEFINED",
76 "postingType": {
77 "name": "ACCRUAL",
78 "captionKey": "enum.postingType.accrual",
79 "caption": "Accrual"
80 },
81 "externalStatusFilterType": {
82 "name": "ALL",
83 "captionKey": "enum.filterType.all",
84 "caption": "All"
85 },
86 "externalStatuses": {
87 "name": "PROCESSING",
88 "captionKey": "enum.taskStatus.processing",
89 "caption": "Processing"
90 },
91 "internalStatusFilterType": {
92 "name": "ALL",
93 "captionKey": "enum.filterType.all",
94 "caption": "All"
95 },
96 "internalStatuses": {
97 "name": "PROCESSING",
98 "captionKey": "enum.taskStatus.processing",
99 "caption": "Processing"
100 },
101 "listObjectType": {
102 "name": "ACTIVATION_GROUP",
103 "captionKey": "enum.listObjectType.activationGroup",
104 "caption": "Activation Group"
105 },
106 "objectList": [],
107 "migratedFilterType": {
108 "name": "ALL",
109 "captionKey": "enum.migratedFilterType.all",
110 "caption": "All"
111 },
112 "internalAssetClassFilterType": {
113 "name": "ALL",
114 "captionKey": "enum.filterType.all",
115 "caption": "All"
116 },
117 "internalAssetClasses": [],
118 "businessAreaFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "businessAreas": [],
124 "functionalAreaFilterType": {
125 "name": "ALL",
126 "captionKey": "enum.filterType.all",
127 "caption": "All"
128 },
129 "functionalAreas": []
130 },
131 "filter": {
132 "id": 10000001,
133 "name": "Sample Name",
134 "principalPositionType": {
135 "name": "LESSEE",
136 "captionKey": "enum.principalpositiontype.lessee",
137 "caption": "Lessee"
138 },
139 "calendarType": {
140 "name": "_360",
141 "captionKey": "enum.calendarType.360",
142 "caption": "360 Convention"
143 },
144 "fiscalYearVariant": {
145 "id": "string",
146 "displayId": "Euro"
147 },
148 "profileId": 10000001,
149 "jobId": 10000001,
150 "objectList": [],
151 "filterTypes": {
152 "erpSystemFilterType": {
153 "name": "ALL",
154 "captionKey": "enum.filterType.all",
155 "caption": "All"
156 },
157 "erpSystems": [],
158 "leaseAreaFilterType": {
159 "name": "ALL",
160 "captionKey": "enum.filterType.all",
161 "caption": "All"
162 },
163 "leaseAreas": [],
164 "businessUnitFilterType": {
165 "name": "ALL",
166 "captionKey": "enum.filterType.all",
167 "caption": "All"
168 },
169 "businessUnits": [],
170 "companyFilterType": {
171 "name": "ALL",
172 "captionKey": "enum.filterType.all",
173 "caption": "All"
174 },
175 "companies": [],
176 "leaseDepartmentFilterType": {
177 "name": "ALL",
178 "captionKey": "enum.filterType.all",
179 "caption": "All"
180 },
181 "leaseDepartments": [],
182 "leaseGroupFilterType": {
183 "name": "ALL",
184 "captionKey": "enum.filterType.all",
185 "caption": "All"
186 },
187 "leaseGroups": [],
188 "costCenterFilterType": {
189 "name": "ALL",
190 "captionKey": "enum.filterType.all",
191 "caption": "All"
192 },
193 "costCenters": [],
194 "profitCenterFilterType": {
195 "name": "ALL",
196 "captionKey": "enum.filterType.all",
197 "caption": "All"
198 },
199 "profitCenters": [],
200 "wbsFilterType": {
201 "name": "ALL",
202 "captionKey": "enum.filterType.all",
203 "caption": "All"
204 },
205 "wbses": [],
206 "businessAreaFilterType": {
207 "name": "ALL",
208 "captionKey": "enum.filterType.all",
209 "caption": "All"
210 },
211 "businessAreas": [],
212 "functionalAreaFilterType": {
213 "name": "ALL",
214 "captionKey": "enum.filterType.all",
215 "caption": "All"
216 },
217 "functionalAreas": []
218 }
219 },
220 "tasks": [],
221 "docStoreId": 10000001
222}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "taskCount": 100,
13 "failedTaskCount": 100,
14 "doneTaskCount": 100,
15 "inProgressTaskCount": 100,
16 "cancelledTaskCount": 100,
17 "errorMessage": "sample_errorMessage",
18 "executor": {
19 "name": "MANUAL",
20 "captionKey": "enum.batchJobExecutor.manual",
21 "caption": "Manual"
22 },
23 "scheduleJobId": 10000001,
24 "batchSize": 1000,
25 "totalObjectCount": 100,
26 "profileId": 10000001,
27 "readOnly": false,
28 "status": {
29 "name": "PROCESSING",
30 "captionKey": "enum.batchJobStatus.processing",
31 "caption": "Processing"
32 },
33 "fileStorageId": "sample_fileStorageId",
34 "generatingExportFile": false,
35 "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
36 "finishedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
37 "input": {
38 "id": 10000001,
39 "accountingStandardType": {
40 "name": "GAAP",
41 "captionKey": "enum.accountingStandard.gaap",
42 "caption": "GAAP"
43 },
44 "classifications": {
45 "name": "FINANCE",
46 "captionKey": "enum.leaseClassificationType.finance",
47 "caption": "Finance Lease"
48 },
49 "fromYear": 100,
50 "fromPeriod": {
51 "id": 10000001,
52 "displayId": "FP-2024-Q1",
53 "status": {
54 "name": "ACTIVE",
55 "captionKey": "enum.objectStatus.active",
56 "active": true,
57 "caption": "Active"
58 },
59 "day": 15,
60 "year": 2024,
61 "month": 3,
62 "postingPeriod": 3,
63 "yearShift": 0
64 },
65 "toYear": 100,
66 "toPeriod": {
67 "id": 10000001,
68 "displayId": "FP-2024-Q1",
69 "status": {
70 "name": "ACTIVE",
71 "captionKey": "enum.objectStatus.active",
72 "active": true,
73 "caption": "Active"
74 },
75 "day": 15,
76 "year": 2024,
77 "month": 3,
78 "postingPeriod": 3,
79 "yearShift": 0
80 },
81 "fromDate": "2025-01-01",
82 "toDate": "2025-01-01",
83 "fromDateType": "USER_DEFINED",
84 "toDateType": "USER_DEFINED",
85 "postingType": {
86 "name": "ACCRUAL",
87 "captionKey": "enum.postingType.accrual",
88 "caption": "Accrual"
89 },
90 "externalStatusFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 },
95 "externalStatuses": {
96 "name": "PROCESSING",
97 "captionKey": "enum.taskStatus.processing",
98 "caption": "Processing"
99 },
100 "internalStatusFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "internalStatuses": {
106 "name": "PROCESSING",
107 "captionKey": "enum.taskStatus.processing",
108 "caption": "Processing"
109 },
110 "listObjectType": {
111 "name": "ACTIVATION_GROUP",
112 "captionKey": "enum.listObjectType.activationGroup",
113 "caption": "Activation Group"
114 },
115 "objectList": [],
116 "migratedFilterType": {
117 "name": "ALL",
118 "captionKey": "enum.migratedFilterType.all",
119 "caption": "All"
120 },
121 "internalAssetClassFilterType": {
122 "name": "ALL",
123 "captionKey": "enum.filterType.all",
124 "caption": "All"
125 },
126 "internalAssetClasses": [],
127 "businessAreaFilterType": {
128 "name": "ALL",
129 "captionKey": "enum.filterType.all",
130 "caption": "All"
131 },
132 "businessAreas": [],
133 "functionalAreaFilterType": {
134 "name": "ALL",
135 "captionKey": "enum.filterType.all",
136 "caption": "All"
137 },
138 "functionalAreas": []
139 },
140 "filter": {
141 "id": 10000001,
142 "name": "Sample Name",
143 "principalPositionType": {
144 "name": "LESSEE",
145 "captionKey": "enum.principalpositiontype.lessee",
146 "caption": "Lessee"
147 },
148 "calendarType": {
149 "name": "_360",
150 "captionKey": "enum.calendarType.360",
151 "caption": "360 Convention"
152 },
153 "fiscalYearVariant": {
154 "id": "string",
155 "displayId": "Euro"
156 },
157 "profileId": 10000001,
158 "jobId": 10000001,
159 "objectList": [],
160 "filterTypes": {
161 "erpSystemFilterType": {
162 "name": "ALL",
163 "captionKey": "enum.filterType.all",
164 "caption": "All"
165 },
166 "erpSystems": [],
167 "leaseAreaFilterType": {
168 "name": "ALL",
169 "captionKey": "enum.filterType.all",
170 "caption": "All"
171 },
172 "leaseAreas": [],
173 "businessUnitFilterType": {
174 "name": "ALL",
175 "captionKey": "enum.filterType.all",
176 "caption": "All"
177 },
178 "businessUnits": [],
179 "companyFilterType": {
180 "name": "ALL",
181 "captionKey": "enum.filterType.all",
182 "caption": "All"
183 },
184 "companies": [],
185 "leaseDepartmentFilterType": {
186 "name": "ALL",
187 "captionKey": "enum.filterType.all",
188 "caption": "All"
189 },
190 "leaseDepartments": [],
191 "leaseGroupFilterType": {
192 "name": "ALL",
193 "captionKey": "enum.filterType.all",
194 "caption": "All"
195 },
196 "leaseGroups": [],
197 "costCenterFilterType": {
198 "name": "ALL",
199 "captionKey": "enum.filterType.all",
200 "caption": "All"
201 },
202 "costCenters": [],
203 "profitCenterFilterType": {
204 "name": "ALL",
205 "captionKey": "enum.filterType.all",
206 "caption": "All"
207 },
208 "profitCenters": [],
209 "wbsFilterType": {
210 "name": "ALL",
211 "captionKey": "enum.filterType.all",
212 "caption": "All"
213 },
214 "wbses": [],
215 "businessAreaFilterType": {
216 "name": "ALL",
217 "captionKey": "enum.filterType.all",
218 "caption": "All"
219 },
220 "businessAreas": [],
221 "functionalAreaFilterType": {
222 "name": "ALL",
223 "captionKey": "enum.filterType.all",
224 "caption": "All"
225 },
226 "functionalAreas": []
227 }
228 },
229 "tasks": [],
230 "docStoreId": 10000001
231 }
232}
Delete Periodic Posting Status Report Job (With ID)¶
HTTP Request
DELETE /api/v1/periodic_posting_status_reports/jobs/{id}
📋 Description: Deletes a specified periodic posting status report job, facilitating the management of lease and contract-related financial obligations within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {}
7}
Partially Update A Job¶
HTTP Request
PATCH /api/v1/periodic_posting_status_reports/jobs/{id}
📋 Description: Updates the status of a specific periodic posting job within the Nakisa Lease Accounting Suite, allowing users to manage lease-related financial obligations and ensure accurate accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
body |
body |
false |
Request body containing the updated periodic posting status report data, including lease and contract details, financial obligations, and associated accounting entries. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
body |
|
body |
Body Parameters
1{
2 "op": "replace",
3 "path": "/name",
4 "value": "patched contract"
5}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "taskCount": 100,
13 "failedTaskCount": 100,
14 "doneTaskCount": 100,
15 "inProgressTaskCount": 100,
16 "cancelledTaskCount": 100,
17 "errorMessage": "sample_errorMessage",
18 "executor": {
19 "name": "MANUAL",
20 "captionKey": "enum.batchJobExecutor.manual",
21 "caption": "Manual"
22 },
23 "scheduleJobId": 10000001,
24 "batchSize": 1000,
25 "totalObjectCount": 100,
26 "profileId": 10000001,
27 "readOnly": false,
28 "status": {
29 "name": "PROCESSING",
30 "captionKey": "enum.batchJobStatus.processing",
31 "caption": "Processing"
32 },
33 "fileStorageId": "sample_fileStorageId",
34 "generatingExportFile": false,
35 "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
36 "finishedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
37 "input": {
38 "id": 10000001,
39 "accountingStandardType": {
40 "name": "GAAP",
41 "captionKey": "enum.accountingStandard.gaap",
42 "caption": "GAAP"
43 },
44 "classifications": {
45 "name": "FINANCE",
46 "captionKey": "enum.leaseClassificationType.finance",
47 "caption": "Finance Lease"
48 },
49 "fromYear": 100,
50 "fromPeriod": {
51 "id": 10000001,
52 "displayId": "FP-2024-Q1",
53 "status": {
54 "name": "ACTIVE",
55 "captionKey": "enum.objectStatus.active",
56 "active": true,
57 "caption": "Active"
58 },
59 "day": 15,
60 "year": 2024,
61 "month": 3,
62 "postingPeriod": 3,
63 "yearShift": 0
64 },
65 "toYear": 100,
66 "toPeriod": {
67 "id": 10000001,
68 "displayId": "FP-2024-Q1",
69 "status": {
70 "name": "ACTIVE",
71 "captionKey": "enum.objectStatus.active",
72 "active": true,
73 "caption": "Active"
74 },
75 "day": 15,
76 "year": 2024,
77 "month": 3,
78 "postingPeriod": 3,
79 "yearShift": 0
80 },
81 "fromDate": "2025-01-01",
82 "toDate": "2025-01-01",
83 "fromDateType": "USER_DEFINED",
84 "toDateType": "USER_DEFINED",
85 "postingType": {
86 "name": "ACCRUAL",
87 "captionKey": "enum.postingType.accrual",
88 "caption": "Accrual"
89 },
90 "externalStatusFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 },
95 "externalStatuses": {
96 "name": "PROCESSING",
97 "captionKey": "enum.taskStatus.processing",
98 "caption": "Processing"
99 },
100 "internalStatusFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "internalStatuses": {
106 "name": "PROCESSING",
107 "captionKey": "enum.taskStatus.processing",
108 "caption": "Processing"
109 },
110 "listObjectType": {
111 "name": "ACTIVATION_GROUP",
112 "captionKey": "enum.listObjectType.activationGroup",
113 "caption": "Activation Group"
114 },
115 "objectList": [],
116 "migratedFilterType": {
117 "name": "ALL",
118 "captionKey": "enum.migratedFilterType.all",
119 "caption": "All"
120 },
121 "internalAssetClassFilterType": {
122 "name": "ALL",
123 "captionKey": "enum.filterType.all",
124 "caption": "All"
125 },
126 "internalAssetClasses": [],
127 "businessAreaFilterType": {
128 "name": "ALL",
129 "captionKey": "enum.filterType.all",
130 "caption": "All"
131 },
132 "businessAreas": [],
133 "functionalAreaFilterType": {
134 "name": "ALL",
135 "captionKey": "enum.filterType.all",
136 "caption": "All"
137 },
138 "functionalAreas": []
139 },
140 "filter": {
141 "id": 10000001,
142 "name": "Sample Name",
143 "principalPositionType": {
144 "name": "LESSEE",
145 "captionKey": "enum.principalpositiontype.lessee",
146 "caption": "Lessee"
147 },
148 "calendarType": {
149 "name": "_360",
150 "captionKey": "enum.calendarType.360",
151 "caption": "360 Convention"
152 },
153 "fiscalYearVariant": {
154 "id": "string",
155 "displayId": "Euro"
156 },
157 "profileId": 10000001,
158 "jobId": 10000001,
159 "objectList": [],
160 "filterTypes": {
161 "erpSystemFilterType": {
162 "name": "ALL",
163 "captionKey": "enum.filterType.all",
164 "caption": "All"
165 },
166 "erpSystems": [],
167 "leaseAreaFilterType": {
168 "name": "ALL",
169 "captionKey": "enum.filterType.all",
170 "caption": "All"
171 },
172 "leaseAreas": [],
173 "businessUnitFilterType": {
174 "name": "ALL",
175 "captionKey": "enum.filterType.all",
176 "caption": "All"
177 },
178 "businessUnits": [],
179 "companyFilterType": {
180 "name": "ALL",
181 "captionKey": "enum.filterType.all",
182 "caption": "All"
183 },
184 "companies": [],
185 "leaseDepartmentFilterType": {
186 "name": "ALL",
187 "captionKey": "enum.filterType.all",
188 "caption": "All"
189 },
190 "leaseDepartments": [],
191 "leaseGroupFilterType": {
192 "name": "ALL",
193 "captionKey": "enum.filterType.all",
194 "caption": "All"
195 },
196 "leaseGroups": [],
197 "costCenterFilterType": {
198 "name": "ALL",
199 "captionKey": "enum.filterType.all",
200 "caption": "All"
201 },
202 "costCenters": [],
203 "profitCenterFilterType": {
204 "name": "ALL",
205 "captionKey": "enum.filterType.all",
206 "caption": "All"
207 },
208 "profitCenters": [],
209 "wbsFilterType": {
210 "name": "ALL",
211 "captionKey": "enum.filterType.all",
212 "caption": "All"
213 },
214 "wbses": [],
215 "businessAreaFilterType": {
216 "name": "ALL",
217 "captionKey": "enum.filterType.all",
218 "caption": "All"
219 },
220 "businessAreas": [],
221 "functionalAreaFilterType": {
222 "name": "ALL",
223 "captionKey": "enum.filterType.all",
224 "caption": "All"
225 },
226 "functionalAreas": []
227 }
228 },
229 "tasks": [],
230 "docStoreId": 10000001
231 }
232}
Bulk Upsert Periodic Posting Status Report Jobs¶
HTTP Request
PUT /api/v1/periodic_posting_status_reports/jobs/createOrUpdate/bulk
📋 Description: Creates or updates multiple periodic posting status reports in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of lease and contract-related financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing bulk data for creating or updating periodic posting status reports related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite. |
Body Parameters
1[
2 {
3 "id": 10000001,
4 "taskCount": 100,
5 "failedTaskCount": 100,
6 "doneTaskCount": 100,
7 "inProgressTaskCount": 100,
8 "cancelledTaskCount": 100,
9 "errorMessage": "sample_errorMessage",
10 "executor": {
11 "name": "MANUAL",
12 "captionKey": "enum.batchJobExecutor.manual",
13 "caption": "Manual"
14 },
15 "scheduleJobId": 10000001,
16 "batchSize": 1000,
17 "totalObjectCount": 100,
18 "profileId": 10000001,
19 "readOnly": false,
20 "status": {
21 "name": "PROCESSING",
22 "captionKey": "enum.batchJobStatus.processing",
23 "caption": "Processing"
24 },
25 "fileStorageId": "sample_fileStorageId",
26 "generatingExportFile": false,
27 "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
28 "finishedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
29 "input": {
30 "id": 10000001,
31 "accountingStandardType": {
32 "name": "GAAP",
33 "captionKey": "enum.accountingStandard.gaap",
34 "caption": "GAAP"
35 },
36 "classifications": {
37 "name": "FINANCE",
38 "captionKey": "enum.leaseClassificationType.finance",
39 "caption": "Finance Lease"
40 },
41 "fromYear": 100,
42 "fromPeriod": {
43 "id": 10000001,
44 "displayId": "FP-2024-Q1",
45 "status": {
46 "name": "ACTIVE",
47 "captionKey": "enum.objectStatus.active",
48 "active": true,
49 "caption": "Active"
50 },
51 "day": 15,
52 "year": 2024,
53 "month": 3,
54 "postingPeriod": 3,
55 "yearShift": 0
56 },
57 "toYear": 100,
58 "toPeriod": {
59 "id": 10000001,
60 "displayId": "FP-2024-Q1",
61 "status": {
62 "name": "ACTIVE",
63 "captionKey": "enum.objectStatus.active",
64 "active": true,
65 "caption": "Active"
66 },
67 "day": 15,
68 "year": 2024,
69 "month": 3,
70 "postingPeriod": 3,
71 "yearShift": 0
72 },
73 "fromDate": "2025-01-01",
74 "toDate": "2025-01-01",
75 "fromDateType": "USER_DEFINED",
76 "toDateType": "USER_DEFINED",
77 "postingType": {
78 "name": "ACCRUAL",
79 "captionKey": "enum.postingType.accrual",
80 "caption": "Accrual"
81 },
82 "externalStatusFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.filterType.all",
85 "caption": "All"
86 },
87 "externalStatuses": {
88 "name": "PROCESSING",
89 "captionKey": "enum.taskStatus.processing",
90 "caption": "Processing"
91 },
92 "internalStatusFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.filterType.all",
95 "caption": "All"
96 },
97 "internalStatuses": {
98 "name": "PROCESSING",
99 "captionKey": "enum.taskStatus.processing",
100 "caption": "Processing"
101 },
102 "listObjectType": {
103 "name": "ACTIVATION_GROUP",
104 "captionKey": "enum.listObjectType.activationGroup",
105 "caption": "Activation Group"
106 },
107 "objectList": [],
108 "migratedFilterType": {
109 "name": "ALL",
110 "captionKey": "enum.migratedFilterType.all",
111 "caption": "All"
112 },
113 "internalAssetClassFilterType": {
114 "name": "ALL",
115 "captionKey": "enum.filterType.all",
116 "caption": "All"
117 },
118 "internalAssetClasses": [],
119 "businessAreaFilterType": {
120 "name": "ALL",
121 "captionKey": "enum.filterType.all",
122 "caption": "All"
123 },
124 "businessAreas": [],
125 "functionalAreaFilterType": {
126 "name": "ALL",
127 "captionKey": "enum.filterType.all",
128 "caption": "All"
129 },
130 "functionalAreas": []
131 },
132 "filter": {
133 "id": 10000001,
134 "name": "Sample Name",
135 "principalPositionType": {
136 "name": "LESSEE",
137 "captionKey": "enum.principalpositiontype.lessee",
138 "caption": "Lessee"
139 },
140 "calendarType": {
141 "name": "_360",
142 "captionKey": "enum.calendarType.360",
143 "caption": "360 Convention"
144 },
145 "fiscalYearVariant": {
146 "id": "string",
147 "displayId": "Euro"
148 },
149 "profileId": 10000001,
150 "jobId": 10000001,
151 "objectList": [],
152 "filterTypes": {
153 "erpSystemFilterType": {
154 "name": "ALL",
155 "captionKey": "enum.filterType.all",
156 "caption": "All"
157 },
158 "erpSystems": [],
159 "leaseAreaFilterType": {
160 "name": "ALL",
161 "captionKey": "enum.filterType.all",
162 "caption": "All"
163 },
164 "leaseAreas": [],
165 "businessUnitFilterType": {
166 "name": "ALL",
167 "captionKey": "enum.filterType.all",
168 "caption": "All"
169 },
170 "businessUnits": [],
171 "companyFilterType": {
172 "name": "ALL",
173 "captionKey": "enum.filterType.all",
174 "caption": "All"
175 },
176 "companies": [],
177 "leaseDepartmentFilterType": {
178 "name": "ALL",
179 "captionKey": "enum.filterType.all",
180 "caption": "All"
181 },
182 "leaseDepartments": [],
183 "leaseGroupFilterType": {
184 "name": "ALL",
185 "captionKey": "enum.filterType.all",
186 "caption": "All"
187 },
188 "leaseGroups": [],
189 "costCenterFilterType": {
190 "name": "ALL",
191 "captionKey": "enum.filterType.all",
192 "caption": "All"
193 },
194 "costCenters": [],
195 "profitCenterFilterType": {
196 "name": "ALL",
197 "captionKey": "enum.filterType.all",
198 "caption": "All"
199 },
200 "profitCenters": [],
201 "wbsFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "wbses": [],
207 "businessAreaFilterType": {
208 "name": "ALL",
209 "captionKey": "enum.filterType.all",
210 "caption": "All"
211 },
212 "businessAreas": [],
213 "functionalAreaFilterType": {
214 "name": "ALL",
215 "captionKey": "enum.filterType.all",
216 "caption": "All"
217 },
218 "functionalAreas": []
219 }
220 },
221 "tasks": [],
222 "docStoreId": 10000001
223 }
224]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 Periodic Posting Status Report Job¶
HTTP Request
PUT /api/v1/periodic_posting_status_reports/jobs/createOrUpdate
📋 Description: Updates or creates periodic posting status reports for leases and contracts within the Nakisa Lease Accounting Suite, ensuring accurate tracking of financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the lease and contract-related data necessary for creating or updating financial obligation and accounting entry records in the Nakisa Lease Accounting Suite. |
Body Parameters
1{
2 "id": 10000001,
3 "taskCount": 100,
4 "failedTaskCount": 100,
5 "doneTaskCount": 100,
6 "inProgressTaskCount": 100,
7 "cancelledTaskCount": 100,
8 "errorMessage": "sample_errorMessage",
9 "executor": {
10 "name": "MANUAL",
11 "captionKey": "enum.batchJobExecutor.manual",
12 "caption": "Manual"
13 },
14 "scheduleJobId": 10000001,
15 "batchSize": 1000,
16 "totalObjectCount": 100,
17 "profileId": 10000001,
18 "readOnly": false,
19 "status": {
20 "name": "PROCESSING",
21 "captionKey": "enum.batchJobStatus.processing",
22 "caption": "Processing"
23 },
24 "fileStorageId": "sample_fileStorageId",
25 "generatingExportFile": false,
26 "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
27 "finishedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
28 "input": {
29 "id": 10000001,
30 "accountingStandardType": {
31 "name": "GAAP",
32 "captionKey": "enum.accountingStandard.gaap",
33 "caption": "GAAP"
34 },
35 "classifications": {
36 "name": "FINANCE",
37 "captionKey": "enum.leaseClassificationType.finance",
38 "caption": "Finance Lease"
39 },
40 "fromYear": 100,
41 "fromPeriod": {
42 "id": 10000001,
43 "displayId": "FP-2024-Q1",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "day": 15,
51 "year": 2024,
52 "month": 3,
53 "postingPeriod": 3,
54 "yearShift": 0
55 },
56 "toYear": 100,
57 "toPeriod": {
58 "id": 10000001,
59 "displayId": "FP-2024-Q1",
60 "status": {
61 "name": "ACTIVE",
62 "captionKey": "enum.objectStatus.active",
63 "active": true,
64 "caption": "Active"
65 },
66 "day": 15,
67 "year": 2024,
68 "month": 3,
69 "postingPeriod": 3,
70 "yearShift": 0
71 },
72 "fromDate": "2025-01-01",
73 "toDate": "2025-01-01",
74 "fromDateType": "USER_DEFINED",
75 "toDateType": "USER_DEFINED",
76 "postingType": {
77 "name": "ACCRUAL",
78 "captionKey": "enum.postingType.accrual",
79 "caption": "Accrual"
80 },
81 "externalStatusFilterType": {
82 "name": "ALL",
83 "captionKey": "enum.filterType.all",
84 "caption": "All"
85 },
86 "externalStatuses": {
87 "name": "PROCESSING",
88 "captionKey": "enum.taskStatus.processing",
89 "caption": "Processing"
90 },
91 "internalStatusFilterType": {
92 "name": "ALL",
93 "captionKey": "enum.filterType.all",
94 "caption": "All"
95 },
96 "internalStatuses": {
97 "name": "PROCESSING",
98 "captionKey": "enum.taskStatus.processing",
99 "caption": "Processing"
100 },
101 "listObjectType": {
102 "name": "ACTIVATION_GROUP",
103 "captionKey": "enum.listObjectType.activationGroup",
104 "caption": "Activation Group"
105 },
106 "objectList": [],
107 "migratedFilterType": {
108 "name": "ALL",
109 "captionKey": "enum.migratedFilterType.all",
110 "caption": "All"
111 },
112 "internalAssetClassFilterType": {
113 "name": "ALL",
114 "captionKey": "enum.filterType.all",
115 "caption": "All"
116 },
117 "internalAssetClasses": [],
118 "businessAreaFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "businessAreas": [],
124 "functionalAreaFilterType": {
125 "name": "ALL",
126 "captionKey": "enum.filterType.all",
127 "caption": "All"
128 },
129 "functionalAreas": []
130 },
131 "filter": {
132 "id": 10000001,
133 "name": "Sample Name",
134 "principalPositionType": {
135 "name": "LESSEE",
136 "captionKey": "enum.principalpositiontype.lessee",
137 "caption": "Lessee"
138 },
139 "calendarType": {
140 "name": "_360",
141 "captionKey": "enum.calendarType.360",
142 "caption": "360 Convention"
143 },
144 "fiscalYearVariant": {
145 "id": "string",
146 "displayId": "Euro"
147 },
148 "profileId": 10000001,
149 "jobId": 10000001,
150 "objectList": [],
151 "filterTypes": {
152 "erpSystemFilterType": {
153 "name": "ALL",
154 "captionKey": "enum.filterType.all",
155 "caption": "All"
156 },
157 "erpSystems": [],
158 "leaseAreaFilterType": {
159 "name": "ALL",
160 "captionKey": "enum.filterType.all",
161 "caption": "All"
162 },
163 "leaseAreas": [],
164 "businessUnitFilterType": {
165 "name": "ALL",
166 "captionKey": "enum.filterType.all",
167 "caption": "All"
168 },
169 "businessUnits": [],
170 "companyFilterType": {
171 "name": "ALL",
172 "captionKey": "enum.filterType.all",
173 "caption": "All"
174 },
175 "companies": [],
176 "leaseDepartmentFilterType": {
177 "name": "ALL",
178 "captionKey": "enum.filterType.all",
179 "caption": "All"
180 },
181 "leaseDepartments": [],
182 "leaseGroupFilterType": {
183 "name": "ALL",
184 "captionKey": "enum.filterType.all",
185 "caption": "All"
186 },
187 "leaseGroups": [],
188 "costCenterFilterType": {
189 "name": "ALL",
190 "captionKey": "enum.filterType.all",
191 "caption": "All"
192 },
193 "costCenters": [],
194 "profitCenterFilterType": {
195 "name": "ALL",
196 "captionKey": "enum.filterType.all",
197 "caption": "All"
198 },
199 "profitCenters": [],
200 "wbsFilterType": {
201 "name": "ALL",
202 "captionKey": "enum.filterType.all",
203 "caption": "All"
204 },
205 "wbses": [],
206 "businessAreaFilterType": {
207 "name": "ALL",
208 "captionKey": "enum.filterType.all",
209 "caption": "All"
210 },
211 "businessAreas": [],
212 "functionalAreaFilterType": {
213 "name": "ALL",
214 "captionKey": "enum.filterType.all",
215 "caption": "All"
216 },
217 "functionalAreas": []
218 }
219 },
220 "tasks": [],
221 "docStoreId": 10000001
222}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "taskCount": 100,
13 "failedTaskCount": 100,
14 "doneTaskCount": 100,
15 "inProgressTaskCount": 100,
16 "cancelledTaskCount": 100,
17 "errorMessage": "sample_errorMessage",
18 "executor": {
19 "name": "MANUAL",
20 "captionKey": "enum.batchJobExecutor.manual",
21 "caption": "Manual"
22 },
23 "scheduleJobId": 10000001,
24 "batchSize": 1000,
25 "totalObjectCount": 100,
26 "profileId": 10000001,
27 "readOnly": false,
28 "status": {
29 "name": "PROCESSING",
30 "captionKey": "enum.batchJobStatus.processing",
31 "caption": "Processing"
32 },
33 "fileStorageId": "sample_fileStorageId",
34 "generatingExportFile": false,
35 "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
36 "finishedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
37 "input": {
38 "id": 10000001,
39 "accountingStandardType": {
40 "name": "GAAP",
41 "captionKey": "enum.accountingStandard.gaap",
42 "caption": "GAAP"
43 },
44 "classifications": {
45 "name": "FINANCE",
46 "captionKey": "enum.leaseClassificationType.finance",
47 "caption": "Finance Lease"
48 },
49 "fromYear": 100,
50 "fromPeriod": {
51 "id": 10000001,
52 "displayId": "FP-2024-Q1",
53 "status": {
54 "name": "ACTIVE",
55 "captionKey": "enum.objectStatus.active",
56 "active": true,
57 "caption": "Active"
58 },
59 "day": 15,
60 "year": 2024,
61 "month": 3,
62 "postingPeriod": 3,
63 "yearShift": 0
64 },
65 "toYear": 100,
66 "toPeriod": {
67 "id": 10000001,
68 "displayId": "FP-2024-Q1",
69 "status": {
70 "name": "ACTIVE",
71 "captionKey": "enum.objectStatus.active",
72 "active": true,
73 "caption": "Active"
74 },
75 "day": 15,
76 "year": 2024,
77 "month": 3,
78 "postingPeriod": 3,
79 "yearShift": 0
80 },
81 "fromDate": "2025-01-01",
82 "toDate": "2025-01-01",
83 "fromDateType": "USER_DEFINED",
84 "toDateType": "USER_DEFINED",
85 "postingType": {
86 "name": "ACCRUAL",
87 "captionKey": "enum.postingType.accrual",
88 "caption": "Accrual"
89 },
90 "externalStatusFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 },
95 "externalStatuses": {
96 "name": "PROCESSING",
97 "captionKey": "enum.taskStatus.processing",
98 "caption": "Processing"
99 },
100 "internalStatusFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "internalStatuses": {
106 "name": "PROCESSING",
107 "captionKey": "enum.taskStatus.processing",
108 "caption": "Processing"
109 },
110 "listObjectType": {
111 "name": "ACTIVATION_GROUP",
112 "captionKey": "enum.listObjectType.activationGroup",
113 "caption": "Activation Group"
114 },
115 "objectList": [],
116 "migratedFilterType": {
117 "name": "ALL",
118 "captionKey": "enum.migratedFilterType.all",
119 "caption": "All"
120 },
121 "internalAssetClassFilterType": {
122 "name": "ALL",
123 "captionKey": "enum.filterType.all",
124 "caption": "All"
125 },
126 "internalAssetClasses": [],
127 "businessAreaFilterType": {
128 "name": "ALL",
129 "captionKey": "enum.filterType.all",
130 "caption": "All"
131 },
132 "businessAreas": [],
133 "functionalAreaFilterType": {
134 "name": "ALL",
135 "captionKey": "enum.filterType.all",
136 "caption": "All"
137 },
138 "functionalAreas": []
139 },
140 "filter": {
141 "id": 10000001,
142 "name": "Sample Name",
143 "principalPositionType": {
144 "name": "LESSEE",
145 "captionKey": "enum.principalpositiontype.lessee",
146 "caption": "Lessee"
147 },
148 "calendarType": {
149 "name": "_360",
150 "captionKey": "enum.calendarType.360",
151 "caption": "360 Convention"
152 },
153 "fiscalYearVariant": {
154 "id": "string",
155 "displayId": "Euro"
156 },
157 "profileId": 10000001,
158 "jobId": 10000001,
159 "objectList": [],
160 "filterTypes": {
161 "erpSystemFilterType": {
162 "name": "ALL",
163 "captionKey": "enum.filterType.all",
164 "caption": "All"
165 },
166 "erpSystems": [],
167 "leaseAreaFilterType": {
168 "name": "ALL",
169 "captionKey": "enum.filterType.all",
170 "caption": "All"
171 },
172 "leaseAreas": [],
173 "businessUnitFilterType": {
174 "name": "ALL",
175 "captionKey": "enum.filterType.all",
176 "caption": "All"
177 },
178 "businessUnits": [],
179 "companyFilterType": {
180 "name": "ALL",
181 "captionKey": "enum.filterType.all",
182 "caption": "All"
183 },
184 "companies": [],
185 "leaseDepartmentFilterType": {
186 "name": "ALL",
187 "captionKey": "enum.filterType.all",
188 "caption": "All"
189 },
190 "leaseDepartments": [],
191 "leaseGroupFilterType": {
192 "name": "ALL",
193 "captionKey": "enum.filterType.all",
194 "caption": "All"
195 },
196 "leaseGroups": [],
197 "costCenterFilterType": {
198 "name": "ALL",
199 "captionKey": "enum.filterType.all",
200 "caption": "All"
201 },
202 "costCenters": [],
203 "profitCenterFilterType": {
204 "name": "ALL",
205 "captionKey": "enum.filterType.all",
206 "caption": "All"
207 },
208 "profitCenters": [],
209 "wbsFilterType": {
210 "name": "ALL",
211 "captionKey": "enum.filterType.all",
212 "caption": "All"
213 },
214 "wbses": [],
215 "businessAreaFilterType": {
216 "name": "ALL",
217 "captionKey": "enum.filterType.all",
218 "caption": "All"
219 },
220 "businessAreas": [],
221 "functionalAreaFilterType": {
222 "name": "ALL",
223 "captionKey": "enum.filterType.all",
224 "caption": "All"
225 },
226 "functionalAreas": []
227 }
228 },
229 "tasks": [],
230 "docStoreId": 10000001
231 }
232}
Bulk Update Periodic Posting Status Report Jobs¶
HTTP Request
PUT /api/v1/periodic_posting_status_reports/jobs/bulk
📋 Description: Updates the status of multiple periodic posting jobs in the Nakisa Lease Accounting Suite, facilitating efficient management of lease contracts and financial obligations within accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing a collection of periodic posting status report job details, including lease and contract information relevant to financial obligations and accounting entries. |
Body Parameters
1[
2 {
3 "id": 10000001,
4 "taskCount": 100,
5 "failedTaskCount": 100,
6 "doneTaskCount": 100,
7 "inProgressTaskCount": 100,
8 "cancelledTaskCount": 100,
9 "errorMessage": "sample_errorMessage",
10 "executor": {
11 "name": "MANUAL",
12 "captionKey": "enum.batchJobExecutor.manual",
13 "caption": "Manual"
14 },
15 "scheduleJobId": 10000001,
16 "batchSize": 1000,
17 "totalObjectCount": 100,
18 "profileId": 10000001,
19 "readOnly": false,
20 "status": {
21 "name": "PROCESSING",
22 "captionKey": "enum.batchJobStatus.processing",
23 "caption": "Processing"
24 },
25 "fileStorageId": "sample_fileStorageId",
26 "generatingExportFile": false,
27 "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
28 "finishedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
29 "input": {
30 "id": 10000001,
31 "accountingStandardType": {
32 "name": "GAAP",
33 "captionKey": "enum.accountingStandard.gaap",
34 "caption": "GAAP"
35 },
36 "classifications": {
37 "name": "FINANCE",
38 "captionKey": "enum.leaseClassificationType.finance",
39 "caption": "Finance Lease"
40 },
41 "fromYear": 100,
42 "fromPeriod": {
43 "id": 10000001,
44 "displayId": "FP-2024-Q1",
45 "status": {
46 "name": "ACTIVE",
47 "captionKey": "enum.objectStatus.active",
48 "active": true,
49 "caption": "Active"
50 },
51 "day": 15,
52 "year": 2024,
53 "month": 3,
54 "postingPeriod": 3,
55 "yearShift": 0
56 },
57 "toYear": 100,
58 "toPeriod": {
59 "id": 10000001,
60 "displayId": "FP-2024-Q1",
61 "status": {
62 "name": "ACTIVE",
63 "captionKey": "enum.objectStatus.active",
64 "active": true,
65 "caption": "Active"
66 },
67 "day": 15,
68 "year": 2024,
69 "month": 3,
70 "postingPeriod": 3,
71 "yearShift": 0
72 },
73 "fromDate": "2025-01-01",
74 "toDate": "2025-01-01",
75 "fromDateType": "USER_DEFINED",
76 "toDateType": "USER_DEFINED",
77 "postingType": {
78 "name": "ACCRUAL",
79 "captionKey": "enum.postingType.accrual",
80 "caption": "Accrual"
81 },
82 "externalStatusFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.filterType.all",
85 "caption": "All"
86 },
87 "externalStatuses": {
88 "name": "PROCESSING",
89 "captionKey": "enum.taskStatus.processing",
90 "caption": "Processing"
91 },
92 "internalStatusFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.filterType.all",
95 "caption": "All"
96 },
97 "internalStatuses": {
98 "name": "PROCESSING",
99 "captionKey": "enum.taskStatus.processing",
100 "caption": "Processing"
101 },
102 "listObjectType": {
103 "name": "ACTIVATION_GROUP",
104 "captionKey": "enum.listObjectType.activationGroup",
105 "caption": "Activation Group"
106 },
107 "objectList": [],
108 "migratedFilterType": {
109 "name": "ALL",
110 "captionKey": "enum.migratedFilterType.all",
111 "caption": "All"
112 },
113 "internalAssetClassFilterType": {
114 "name": "ALL",
115 "captionKey": "enum.filterType.all",
116 "caption": "All"
117 },
118 "internalAssetClasses": [],
119 "businessAreaFilterType": {
120 "name": "ALL",
121 "captionKey": "enum.filterType.all",
122 "caption": "All"
123 },
124 "businessAreas": [],
125 "functionalAreaFilterType": {
126 "name": "ALL",
127 "captionKey": "enum.filterType.all",
128 "caption": "All"
129 },
130 "functionalAreas": []
131 },
132 "filter": {
133 "id": 10000001,
134 "name": "Sample Name",
135 "principalPositionType": {
136 "name": "LESSEE",
137 "captionKey": "enum.principalpositiontype.lessee",
138 "caption": "Lessee"
139 },
140 "calendarType": {
141 "name": "_360",
142 "captionKey": "enum.calendarType.360",
143 "caption": "360 Convention"
144 },
145 "fiscalYearVariant": {
146 "id": "string",
147 "displayId": "Euro"
148 },
149 "profileId": 10000001,
150 "jobId": 10000001,
151 "objectList": [],
152 "filterTypes": {
153 "erpSystemFilterType": {
154 "name": "ALL",
155 "captionKey": "enum.filterType.all",
156 "caption": "All"
157 },
158 "erpSystems": [],
159 "leaseAreaFilterType": {
160 "name": "ALL",
161 "captionKey": "enum.filterType.all",
162 "caption": "All"
163 },
164 "leaseAreas": [],
165 "businessUnitFilterType": {
166 "name": "ALL",
167 "captionKey": "enum.filterType.all",
168 "caption": "All"
169 },
170 "businessUnits": [],
171 "companyFilterType": {
172 "name": "ALL",
173 "captionKey": "enum.filterType.all",
174 "caption": "All"
175 },
176 "companies": [],
177 "leaseDepartmentFilterType": {
178 "name": "ALL",
179 "captionKey": "enum.filterType.all",
180 "caption": "All"
181 },
182 "leaseDepartments": [],
183 "leaseGroupFilterType": {
184 "name": "ALL",
185 "captionKey": "enum.filterType.all",
186 "caption": "All"
187 },
188 "leaseGroups": [],
189 "costCenterFilterType": {
190 "name": "ALL",
191 "captionKey": "enum.filterType.all",
192 "caption": "All"
193 },
194 "costCenters": [],
195 "profitCenterFilterType": {
196 "name": "ALL",
197 "captionKey": "enum.filterType.all",
198 "caption": "All"
199 },
200 "profitCenters": [],
201 "wbsFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "wbses": [],
207 "businessAreaFilterType": {
208 "name": "ALL",
209 "captionKey": "enum.filterType.all",
210 "caption": "All"
211 },
212 "businessAreas": [],
213 "functionalAreaFilterType": {
214 "name": "ALL",
215 "captionKey": "enum.filterType.all",
216 "caption": "All"
217 },
218 "functionalAreas": []
219 }
220 },
221 "tasks": [],
222 "docStoreId": 10000001
223 }
224]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 Create Periodic Posting Status Report Jobs¶
HTTP Request
POST /api/v1/periodic_posting_status_reports/jobs/bulk
📋 Description: Submits bulk requests for periodic posting status reports related to leases and contracts, facilitating the management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing a collection of periodic posting status report job details, including lease and contract information, to facilitate the management of financial obligations and accounting entries. |
Body Parameters
1[
2 {
3 "id": 10000001,
4 "taskCount": 100,
5 "failedTaskCount": 100,
6 "doneTaskCount": 100,
7 "inProgressTaskCount": 100,
8 "cancelledTaskCount": 100,
9 "errorMessage": "sample_errorMessage",
10 "executor": {
11 "name": "MANUAL",
12 "captionKey": "enum.batchJobExecutor.manual",
13 "caption": "Manual"
14 },
15 "scheduleJobId": 10000001,
16 "batchSize": 1000,
17 "totalObjectCount": 100,
18 "profileId": 10000001,
19 "readOnly": false,
20 "status": {
21 "name": "PROCESSING",
22 "captionKey": "enum.batchJobStatus.processing",
23 "caption": "Processing"
24 },
25 "fileStorageId": "sample_fileStorageId",
26 "generatingExportFile": false,
27 "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
28 "finishedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
29 "input": {
30 "id": 10000001,
31 "accountingStandardType": {
32 "name": "GAAP",
33 "captionKey": "enum.accountingStandard.gaap",
34 "caption": "GAAP"
35 },
36 "classifications": {
37 "name": "FINANCE",
38 "captionKey": "enum.leaseClassificationType.finance",
39 "caption": "Finance Lease"
40 },
41 "fromYear": 100,
42 "fromPeriod": {
43 "id": 10000001,
44 "displayId": "FP-2024-Q1",
45 "status": {
46 "name": "ACTIVE",
47 "captionKey": "enum.objectStatus.active",
48 "active": true,
49 "caption": "Active"
50 },
51 "day": 15,
52 "year": 2024,
53 "month": 3,
54 "postingPeriod": 3,
55 "yearShift": 0
56 },
57 "toYear": 100,
58 "toPeriod": {
59 "id": 10000001,
60 "displayId": "FP-2024-Q1",
61 "status": {
62 "name": "ACTIVE",
63 "captionKey": "enum.objectStatus.active",
64 "active": true,
65 "caption": "Active"
66 },
67 "day": 15,
68 "year": 2024,
69 "month": 3,
70 "postingPeriod": 3,
71 "yearShift": 0
72 },
73 "fromDate": "2025-01-01",
74 "toDate": "2025-01-01",
75 "fromDateType": "USER_DEFINED",
76 "toDateType": "USER_DEFINED",
77 "postingType": {
78 "name": "ACCRUAL",
79 "captionKey": "enum.postingType.accrual",
80 "caption": "Accrual"
81 },
82 "externalStatusFilterType": {
83 "name": "ALL",
84 "captionKey": "enum.filterType.all",
85 "caption": "All"
86 },
87 "externalStatuses": {
88 "name": "PROCESSING",
89 "captionKey": "enum.taskStatus.processing",
90 "caption": "Processing"
91 },
92 "internalStatusFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.filterType.all",
95 "caption": "All"
96 },
97 "internalStatuses": {
98 "name": "PROCESSING",
99 "captionKey": "enum.taskStatus.processing",
100 "caption": "Processing"
101 },
102 "listObjectType": {
103 "name": "ACTIVATION_GROUP",
104 "captionKey": "enum.listObjectType.activationGroup",
105 "caption": "Activation Group"
106 },
107 "objectList": [],
108 "migratedFilterType": {
109 "name": "ALL",
110 "captionKey": "enum.migratedFilterType.all",
111 "caption": "All"
112 },
113 "internalAssetClassFilterType": {
114 "name": "ALL",
115 "captionKey": "enum.filterType.all",
116 "caption": "All"
117 },
118 "internalAssetClasses": [],
119 "businessAreaFilterType": {
120 "name": "ALL",
121 "captionKey": "enum.filterType.all",
122 "caption": "All"
123 },
124 "businessAreas": [],
125 "functionalAreaFilterType": {
126 "name": "ALL",
127 "captionKey": "enum.filterType.all",
128 "caption": "All"
129 },
130 "functionalAreas": []
131 },
132 "filter": {
133 "id": 10000001,
134 "name": "Sample Name",
135 "principalPositionType": {
136 "name": "LESSEE",
137 "captionKey": "enum.principalpositiontype.lessee",
138 "caption": "Lessee"
139 },
140 "calendarType": {
141 "name": "_360",
142 "captionKey": "enum.calendarType.360",
143 "caption": "360 Convention"
144 },
145 "fiscalYearVariant": {
146 "id": "string",
147 "displayId": "Euro"
148 },
149 "profileId": 10000001,
150 "jobId": 10000001,
151 "objectList": [],
152 "filterTypes": {
153 "erpSystemFilterType": {
154 "name": "ALL",
155 "captionKey": "enum.filterType.all",
156 "caption": "All"
157 },
158 "erpSystems": [],
159 "leaseAreaFilterType": {
160 "name": "ALL",
161 "captionKey": "enum.filterType.all",
162 "caption": "All"
163 },
164 "leaseAreas": [],
165 "businessUnitFilterType": {
166 "name": "ALL",
167 "captionKey": "enum.filterType.all",
168 "caption": "All"
169 },
170 "businessUnits": [],
171 "companyFilterType": {
172 "name": "ALL",
173 "captionKey": "enum.filterType.all",
174 "caption": "All"
175 },
176 "companies": [],
177 "leaseDepartmentFilterType": {
178 "name": "ALL",
179 "captionKey": "enum.filterType.all",
180 "caption": "All"
181 },
182 "leaseDepartments": [],
183 "leaseGroupFilterType": {
184 "name": "ALL",
185 "captionKey": "enum.filterType.all",
186 "caption": "All"
187 },
188 "leaseGroups": [],
189 "costCenterFilterType": {
190 "name": "ALL",
191 "captionKey": "enum.filterType.all",
192 "caption": "All"
193 },
194 "costCenters": [],
195 "profitCenterFilterType": {
196 "name": "ALL",
197 "captionKey": "enum.filterType.all",
198 "caption": "All"
199 },
200 "profitCenters": [],
201 "wbsFilterType": {
202 "name": "ALL",
203 "captionKey": "enum.filterType.all",
204 "caption": "All"
205 },
206 "wbses": [],
207 "businessAreaFilterType": {
208 "name": "ALL",
209 "captionKey": "enum.filterType.all",
210 "caption": "All"
211 },
212 "businessAreas": [],
213 "functionalAreaFilterType": {
214 "name": "ALL",
215 "captionKey": "enum.filterType.all",
216 "caption": "All"
217 },
218 "functionalAreas": []
219 }
220 },
221 "tasks": [],
222 "docStoreId": 10000001
223 }
224]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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}
Get Units For Periodic Posting Status Report Job¶
HTTP Request
POST /api/v1/periodic_posting_status_reports/jobs/units
📋 Description: Creates new units for periodic posting status reports within the Nakisa Lease Accounting Suite, enabling users to manage lease contracts and financial obligations effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
unitDisplayIdLike |
query |
string |
true |
Filter by partial match of unit display id |
body |
body |
false |
Request body containing the unit details for periodic posting status reports, including relevant lease and contract information necessary for accurate financial obligation tracking and accounting entry management. |
Body Parameters
1{
2 "page": 0,
3 "size": 10,
4 "sort": [
5 "id,asc",
6 "name,desc"
7 ]
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 10000001,
3 "totalPages": 15,
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": 10,
17 "size": 10,
18 "content": [
19 {
20 "id": 10000001,
21 "displayId": "UNIT-000123",
22 "name": "Office Printer",
23 "description": "High-speed color printer for main office.",
24 "assetNumber": "A-1001",
25 "referenceId": "REF-2024-001",
26 "serialNumber": "SN12345678",
27 "licenseNumber": "LIC-98765",
28 "inventoryNumber": "INV-55555",
29 "room": "Room 101",
30 "location": "Head Office",
31 "evaluationGroup1": "Group A",
32 "evaluationGroup2": "Group B",
33 "evaluationGroup3": "Group C",
34 "investmentReason": "Replacement of outdated equipment",
35 "typeName": "Printer",
36 "calculateGrossTax": true,
37 "bulkAsset": true,
38 "bulkAssetQuantity": 0,
39 "shippingDate": "2024-01-15",
40 "deliveryDate": "2024-01-20",
41 "receptionDate": "2024-01-21",
42 "activationDate": "2024-01-22",
43 "rouEndDate": "2026-01-22",
44 "erpAssetRetirementDate": "2028-01-01",
45 "state": "UNIT_ACTIVE",
46 "taxCalculationType": "NET",
47 "internalAssetClass": {
48 "id": 10000001,
49 "displayId": "IAC-001",
50 "status": {
51 "name": "ACTIVE",
52 "captionKey": "enum.objectStatus.active",
53 "active": true,
54 "caption": "Active"
55 },
56 "name": "Machinery and Equipment",
57 "assetClassType": "PROPERTY",
58 "infiniteUsefulLife": false
59 },
60 "profitCenter": {
61 "id": 9001,
62 "displayId": "PC-001",
63 "status": {
64 "name": "ACTIVE",
65 "captionKey": "enum.objectStatus.active",
66 "active": true,
67 "caption": "Active"
68 },
69 "name": "North Region Profit Center",
70 "validTo": "2025-12-31",
71 "erpSystemId": 101,
72 "erpSystemDisplayId": "SAP-01"
73 },
74 "workBreakdownStructure": {
75 "id": 1001,
76 "displayId": "WBS-2025-001",
77 "status": {
78 "name": "ACTIVE",
79 "captionKey": "enum.objectStatus.active",
80 "active": true,
81 "caption": "Active"
82 },
83 "name": "Main Project WBS",
84 "erpSystemId": 0
85 },
86 "functionalArea": {
87 "id": 2001,
88 "displayId": "FA-2025-001",
89 "status": {
90 "name": "ACTIVE",
91 "captionKey": "enum.objectStatus.active",
92 "active": true,
93 "caption": "Active"
94 },
95 "name": "Accounting Department",
96 "erpSystemId": 0
97 },
98 "businessArea": {
99 "id": 3001,
100 "displayId": "BA-2025-001",
101 "status": {
102 "name": "ACTIVE",
103 "captionKey": "enum.objectStatus.active",
104 "active": true,
105 "caption": "Active"
106 },
107 "name": "North America Operations",
108 "erpSystemId": 0
109 },
110 "network": {
111 "id": 10001,
112 "displayId": "NET-001",
113 "status": {
114 "name": "ACTIVE",
115 "captionKey": "enum.objectStatus.active",
116 "active": true,
117 "caption": "Active"
118 },
119 "name": "Global Network",
120 "erpSystemId": 0
121 },
122 "segment": {
123 "id": 11001,
124 "displayId": "SEG-001",
125 "status": {
126 "name": "ACTIVE",
127 "captionKey": "enum.objectStatus.active",
128 "active": true,
129 "caption": "Active"
130 },
131 "name": "Segment Alpha",
132 "erpSystemId": 0
133 },
134 "internalOrder": {
135 "id": 10000001,
136 "status": {
137 "name": "ACTIVE",
138 "captionKey": "enum.objectStatus.active",
139 "active": true,
140 "caption": "Active"
141 },
142 "displayId": "IO-2024-001",
143 "erpSystemId": 1001,
144 "erpSystemDisplayId": "SAP-001",
145 "name": "Office Renovation Order",
146 "internalOrderTypeId": 3001,
147 "internalOrderTypeDisplayId": "CAPEX",
148 "controllingAreaId": 4001,
149 "controllingAreaDisplayId": "CA-1001"
150 },
151 "internalOrderType": {
152 "id": 10000001,
153 "status": {
154 "name": "ACTIVE",
155 "captionKey": "enum.objectStatus.active",
156 "active": true,
157 "caption": "Active"
158 },
159 "displayId": "CAPEX",
160 "erpSystemId": 1001,
161 "erpSystemDisplayId": "SAP-001",
162 "name": "Capital Expenditure Orders",
163 "internalOrderId": 20004567
164 },
165 "currency": {
166 "id": 840,
167 "displayId": "USD",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "United States Dollar",
175 "decimalPoints": 2
176 },
177 "taxCodeForPrincipalPayment": {
178 "id": 5001,
179 "displayId": "TC-001",
180 "status": {
181 "name": "ACTIVE",
182 "captionKey": "enum.objectStatus.active",
183 "active": true,
184 "caption": "Active"
185 },
186 "name": "VAT Standard Rate",
187 "erpSystemId": 0
188 },
189 "taxJurisdictionForPrincipalPayment": {
190 "id": 4001,
191 "displayId": "TJ-2025-001",
192 "status": {
193 "name": "ACTIVE",
194 "captionKey": "enum.objectStatus.active",
195 "active": true,
196 "caption": "Active"
197 },
198 "name": "California Tax Authority",
199 "erpSystemId": 0,
200 "schema": "string",
201 "countryDisplayId": "string"
202 },
203 "taxCodeForInterestPayment": {
204 "id": 5001,
205 "displayId": "TC-001",
206 "status": {
207 "name": "ACTIVE",
208 "captionKey": "enum.objectStatus.active",
209 "active": true,
210 "caption": "Active"
211 },
212 "name": "VAT Standard Rate",
213 "erpSystemId": 0
214 },
215 "taxJurisdictionForInterestPayment": {
216 "id": 4001,
217 "displayId": "TJ-2025-001",
218 "status": {
219 "name": "ACTIVE",
220 "captionKey": "enum.objectStatus.active",
221 "active": true,
222 "caption": "Active"
223 },
224 "name": "California Tax Authority",
225 "erpSystemId": 0,
226 "schema": "string",
227 "countryDisplayId": "string"
228 },
229 "taxCodeForNonLeasePayment": {
230 "id": 5001,
231 "displayId": "TC-001",
232 "status": {
233 "name": "ACTIVE",
234 "captionKey": "enum.objectStatus.active",
235 "active": true,
236 "caption": "Active"
237 },
238 "name": "VAT Standard Rate",
239 "erpSystemId": 0
240 },
241 "taxJurisdictionForNonLeasePayment": {
242 "id": 4001,
243 "displayId": "TJ-2025-001",
244 "status": {
245 "name": "ACTIVE",
246 "captionKey": "enum.objectStatus.active",
247 "active": true,
248 "caption": "Active"
249 },
250 "name": "California Tax Authority",
251 "erpSystemId": 0,
252 "schema": "string",
253 "countryDisplayId": "string"
254 },
255 "costCenter": {
256 "id": 14001,
257 "displayId": "CC-001",
258 "status": {
259 "name": "ACTIVE",
260 "captionKey": "enum.objectStatus.active",
261 "active": true,
262 "caption": "Active"
263 },
264 "name": "Cost Center A",
265 "erpSystemId": 0
266 },
267 "company": {
268 "id": 10000006,
269 "displayId": "1005",
270 "status": {
271 "name": "ACTIVE",
272 "captionKey": "enum.objectStatus.active",
273 "active": true,
274 "caption": "Active"
275 },
276 "erpSystemId": 10000001,
277 "erpSystemDisplayId": "FINQ8S-300",
278 "countryId": 10000095,
279 "countryDisplayId": "CA",
280 "name": "string",
281 "postingPeriodVariantId": 0,
282 "fiscalVariantId": 0
283 },
284 "taxJurisdiction": {
285 "id": 4001,
286 "displayId": "TJ-2025-001",
287 "status": {
288 "name": "ACTIVE",
289 "captionKey": "enum.objectStatus.active",
290 "active": true,
291 "caption": "Active"
292 },
293 "name": "California Tax Authority",
294 "erpSystemId": 0,
295 "schema": "string",
296 "countryDisplayId": "string"
297 },
298 "taxCode": {
299 "id": 5001,
300 "displayId": "TC-001",
301 "status": {
302 "name": "ACTIVE",
303 "captionKey": "enum.objectStatus.active",
304 "active": true,
305 "caption": "Active"
306 },
307 "name": "VAT Standard Rate",
308 "erpSystemId": 0
309 },
310 "responsibleCostCenter": {
311 "id": 14001,
312 "displayId": "CC-001",
313 "status": {
314 "name": "ACTIVE",
315 "captionKey": "enum.objectStatus.active",
316 "active": true,
317 "caption": "Active"
318 },
319 "name": "Cost Center A",
320 "erpSystemId": 0
321 },
322 "plant": {
323 "id": 10000001,
324 "displayId": "PLANT-001",
325 "status": {
326 "name": "ACTIVE",
327 "captionKey": "enum.objectStatus.active",
328 "active": true,
329 "caption": "Active"
330 },
331 "name": "Berlin Manufacturing Plant",
332 "companyId": 7001
333 },
334 "assetCostCenter": {
335 "id": 14001,
336 "displayId": "CC-001",
337 "status": {
338 "name": "ACTIVE",
339 "captionKey": "enum.objectStatus.active",
340 "active": true,
341 "caption": "Active"
342 },
343 "name": "Cost Center A",
344 "erpSystemId": 0
345 },
346 "assetProfitCenter": {
347 "id": 9001,
348 "displayId": "PC-001",
349 "status": {
350 "name": "ACTIVE",
351 "captionKey": "enum.objectStatus.active",
352 "active": true,
353 "caption": "Active"
354 },
355 "name": "North Region Profit Center",
356 "validTo": "2025-12-31",
357 "erpSystemId": 101,
358 "erpSystemDisplayId": "SAP-01"
359 },
360 "assetWorkBreakdownStructure": {
361 "id": 1001,
362 "displayId": "WBS-2025-001",
363 "status": {
364 "name": "ACTIVE",
365 "captionKey": "enum.objectStatus.active",
366 "active": true,
367 "caption": "Active"
368 },
369 "name": "Main Project WBS",
370 "erpSystemId": 0
371 },
372 "assetTaxJurisdiction": {
373 "id": 4001,
374 "displayId": "TJ-2025-001",
375 "status": {
376 "name": "ACTIVE",
377 "captionKey": "enum.objectStatus.active",
378 "active": true,
379 "caption": "Active"
380 },
381 "name": "California Tax Authority",
382 "erpSystemId": 0,
383 "schema": "string",
384 "countryDisplayId": "string"
385 },
386 "assetBusinessArea": {
387 "id": 3001,
388 "displayId": "BA-2025-001",
389 "status": {
390 "name": "ACTIVE",
391 "captionKey": "enum.objectStatus.active",
392 "active": true,
393 "caption": "Active"
394 },
395 "name": "North America Operations",
396 "erpSystemId": 0
397 },
398 "assetSegment": {
399 "id": 11001,
400 "displayId": "SEG-001",
401 "status": {
402 "name": "ACTIVE",
403 "captionKey": "enum.objectStatus.active",
404 "active": true,
405 "caption": "Active"
406 },
407 "name": "Segment Alpha",
408 "erpSystemId": 0
409 },
410 "activationGroupId": 101,
411 "activationGroupDisplayId": "AG-001",
412 "principalPositionType": {
413 "name": "LESSEE",
414 "captionKey": "enum.principalpositiontype.lessee",
415 "caption": "Lessee"
416 },
417 "effectiveDate": "2024-01-01",
418 "costCenterAllocations": [
419 {
420 "id": 10001,
421 "mainCostCenter": true,
422 "allocationPercentage": 75,
423 "costCenter": {
424 "id": 14001,
425 "displayId": "CC-001",
426 "status": {
427 "name": "ACTIVE",
428 "captionKey": "enum.objectStatus.active",
429 "active": true,
430 "caption": "Active"
431 },
432 "name": "Cost Center A",
433 "erpSystemId": 0
434 },
435 "profitCenter": {
436 "id": 9001,
437 "displayId": "PC-001",
438 "status": {
439 "name": "ACTIVE",
440 "captionKey": "enum.objectStatus.active",
441 "active": true,
442 "caption": "Active"
443 },
444 "name": "North Region Profit Center",
445 "validTo": "2025-12-31",
446 "erpSystemId": 101,
447 "erpSystemDisplayId": "SAP-01"
448 }
449 }
450 ],
451 "numberRangeIdentifierValue": "NR-0001",
452 "numberRangeIdentifierType": {
453 "name": "COMPANY_CODE"
454 },
455 "numberRangeType": {
456 "name": "CONTRACT"
457 },
458 "allowsSystemGenerateNewId": true
459 }
460 ],
461 "number": 0,
462 "sort": {
463 "unsorted": false,
464 "sorted": true,
465 "empty": false
466 },
467 "first": true,
468 "last": false,
469 "empty": false
470}
Create New Periodic Posting Status Report Job (With Search Units)¶
HTTP Request
POST /api/v1/periodic_posting_status_reports/jobs/search-units
📋 Description: Submits a request to search for specific job units related to periodic posting status reports within the Nakisa Lease Accounting Suite, facilitating efficient tracking of lease and contract financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Page number (0-indexed) |
size |
query |
integer |
false |
Number of items per page |
sort |
query |
array[string] |
false |
Sorting criteria in format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing the search criteria and filters for retrieving periodic posting status reports related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1, Max: 100 |
Body Parameters
1{
2 "searchTerm": "sample_searchTerm",
3 "profile": {
4 "id": 10000001,
5 "name": "Sample Name",
6 "principalPositionType": {
7 "name": "LESSEE",
8 "captionKey": "enum.principalpositiontype.lessee",
9 "caption": "Lessee"
10 },
11 "calendarType": {
12 "name": "_360",
13 "captionKey": "enum.calendarType.360",
14 "caption": "360 Convention"
15 },
16 "fiscalYearVariant": {
17 "id": "string",
18 "displayId": "Euro"
19 },
20 "profileId": 10000001,
21 "jobId": 10000001,
22 "objectList": [],
23 "filterTypes": {
24 "erpSystemFilterType": {
25 "name": "ALL",
26 "captionKey": "enum.filterType.all",
27 "caption": "All"
28 },
29 "erpSystems": [],
30 "leaseAreaFilterType": {
31 "name": "ALL",
32 "captionKey": "enum.filterType.all",
33 "caption": "All"
34 },
35 "leaseAreas": [],
36 "businessUnitFilterType": {
37 "name": "ALL",
38 "captionKey": "enum.filterType.all",
39 "caption": "All"
40 },
41 "businessUnits": [],
42 "companyFilterType": {
43 "name": "ALL",
44 "captionKey": "enum.filterType.all",
45 "caption": "All"
46 },
47 "companies": [],
48 "leaseDepartmentFilterType": {
49 "name": "ALL",
50 "captionKey": "enum.filterType.all",
51 "caption": "All"
52 },
53 "leaseDepartments": [],
54 "leaseGroupFilterType": {
55 "name": "ALL",
56 "captionKey": "enum.filterType.all",
57 "caption": "All"
58 },
59 "leaseGroups": [],
60 "costCenterFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "costCenters": [],
66 "profitCenterFilterType": {
67 "name": "ALL",
68 "captionKey": "enum.filterType.all",
69 "caption": "All"
70 },
71 "profitCenters": [],
72 "wbsFilterType": {
73 "name": "ALL",
74 "captionKey": "enum.filterType.all",
75 "caption": "All"
76 },
77 "wbses": [],
78 "businessAreaFilterType": {
79 "name": "ALL",
80 "captionKey": "enum.filterType.all",
81 "caption": "All"
82 },
83 "businessAreas": [],
84 "functionalAreaFilterType": {
85 "name": "ALL",
86 "captionKey": "enum.filterType.all",
87 "caption": "All"
88 },
89 "functionalAreas": []
90 }
91 },
92 "migratedFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.migratedFilterType.all",
95 "caption": "All"
96 }
97}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 10000001,
3 "totalPages": 15,
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": 10,
17 "size": 10,
18 "content": [
19 {
20 "id": 10000001,
21 "displayId": "UNIT-000123",
22 "name": "Office Printer",
23 "description": "High-speed color printer for main office.",
24 "assetNumber": "A-1001",
25 "referenceId": "REF-2024-001",
26 "serialNumber": "SN12345678",
27 "licenseNumber": "LIC-98765",
28 "inventoryNumber": "INV-55555",
29 "room": "Room 101",
30 "location": "Head Office",
31 "evaluationGroup1": "Group A",
32 "evaluationGroup2": "Group B",
33 "evaluationGroup3": "Group C",
34 "investmentReason": "Replacement of outdated equipment",
35 "typeName": "Printer",
36 "calculateGrossTax": true,
37 "bulkAsset": true,
38 "bulkAssetQuantity": 0,
39 "shippingDate": "2024-01-15",
40 "deliveryDate": "2024-01-20",
41 "receptionDate": "2024-01-21",
42 "activationDate": "2024-01-22",
43 "rouEndDate": "2026-01-22",
44 "erpAssetRetirementDate": "2028-01-01",
45 "state": "UNIT_ACTIVE",
46 "taxCalculationType": "NET",
47 "internalAssetClass": {
48 "id": 10000001,
49 "displayId": "IAC-001",
50 "status": {
51 "name": "ACTIVE",
52 "captionKey": "enum.objectStatus.active",
53 "active": true,
54 "caption": "Active"
55 },
56 "name": "Machinery and Equipment",
57 "assetClassType": "PROPERTY",
58 "infiniteUsefulLife": false
59 },
60 "profitCenter": {
61 "id": 9001,
62 "displayId": "PC-001",
63 "status": {
64 "name": "ACTIVE",
65 "captionKey": "enum.objectStatus.active",
66 "active": true,
67 "caption": "Active"
68 },
69 "name": "North Region Profit Center",
70 "validTo": "2025-12-31",
71 "erpSystemId": 101,
72 "erpSystemDisplayId": "SAP-01"
73 },
74 "workBreakdownStructure": {
75 "id": 1001,
76 "displayId": "WBS-2025-001",
77 "status": {
78 "name": "ACTIVE",
79 "captionKey": "enum.objectStatus.active",
80 "active": true,
81 "caption": "Active"
82 },
83 "name": "Main Project WBS",
84 "erpSystemId": 0
85 },
86 "functionalArea": {
87 "id": 2001,
88 "displayId": "FA-2025-001",
89 "status": {
90 "name": "ACTIVE",
91 "captionKey": "enum.objectStatus.active",
92 "active": true,
93 "caption": "Active"
94 },
95 "name": "Accounting Department",
96 "erpSystemId": 0
97 },
98 "businessArea": {
99 "id": 3001,
100 "displayId": "BA-2025-001",
101 "status": {
102 "name": "ACTIVE",
103 "captionKey": "enum.objectStatus.active",
104 "active": true,
105 "caption": "Active"
106 },
107 "name": "North America Operations",
108 "erpSystemId": 0
109 },
110 "network": {
111 "id": 10001,
112 "displayId": "NET-001",
113 "status": {
114 "name": "ACTIVE",
115 "captionKey": "enum.objectStatus.active",
116 "active": true,
117 "caption": "Active"
118 },
119 "name": "Global Network",
120 "erpSystemId": 0
121 },
122 "segment": {
123 "id": 11001,
124 "displayId": "SEG-001",
125 "status": {
126 "name": "ACTIVE",
127 "captionKey": "enum.objectStatus.active",
128 "active": true,
129 "caption": "Active"
130 },
131 "name": "Segment Alpha",
132 "erpSystemId": 0
133 },
134 "internalOrder": {
135 "id": 10000001,
136 "status": {
137 "name": "ACTIVE",
138 "captionKey": "enum.objectStatus.active",
139 "active": true,
140 "caption": "Active"
141 },
142 "displayId": "IO-2024-001",
143 "erpSystemId": 1001,
144 "erpSystemDisplayId": "SAP-001",
145 "name": "Office Renovation Order",
146 "internalOrderTypeId": 3001,
147 "internalOrderTypeDisplayId": "CAPEX",
148 "controllingAreaId": 4001,
149 "controllingAreaDisplayId": "CA-1001"
150 },
151 "internalOrderType": {
152 "id": 10000001,
153 "status": {
154 "name": "ACTIVE",
155 "captionKey": "enum.objectStatus.active",
156 "active": true,
157 "caption": "Active"
158 },
159 "displayId": "CAPEX",
160 "erpSystemId": 1001,
161 "erpSystemDisplayId": "SAP-001",
162 "name": "Capital Expenditure Orders",
163 "internalOrderId": 20004567
164 },
165 "currency": {
166 "id": 840,
167 "displayId": "USD",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "United States Dollar",
175 "decimalPoints": 2
176 },
177 "taxCodeForPrincipalPayment": {
178 "id": 5001,
179 "displayId": "TC-001",
180 "status": {
181 "name": "ACTIVE",
182 "captionKey": "enum.objectStatus.active",
183 "active": true,
184 "caption": "Active"
185 },
186 "name": "VAT Standard Rate",
187 "erpSystemId": 0
188 },
189 "taxJurisdictionForPrincipalPayment": {
190 "id": 4001,
191 "displayId": "TJ-2025-001",
192 "status": {
193 "name": "ACTIVE",
194 "captionKey": "enum.objectStatus.active",
195 "active": true,
196 "caption": "Active"
197 },
198 "name": "California Tax Authority",
199 "erpSystemId": 0,
200 "schema": "string",
201 "countryDisplayId": "string"
202 },
203 "taxCodeForInterestPayment": {
204 "id": 5001,
205 "displayId": "TC-001",
206 "status": {
207 "name": "ACTIVE",
208 "captionKey": "enum.objectStatus.active",
209 "active": true,
210 "caption": "Active"
211 },
212 "name": "VAT Standard Rate",
213 "erpSystemId": 0
214 },
215 "taxJurisdictionForInterestPayment": {
216 "id": 4001,
217 "displayId": "TJ-2025-001",
218 "status": {
219 "name": "ACTIVE",
220 "captionKey": "enum.objectStatus.active",
221 "active": true,
222 "caption": "Active"
223 },
224 "name": "California Tax Authority",
225 "erpSystemId": 0,
226 "schema": "string",
227 "countryDisplayId": "string"
228 },
229 "taxCodeForNonLeasePayment": {
230 "id": 5001,
231 "displayId": "TC-001",
232 "status": {
233 "name": "ACTIVE",
234 "captionKey": "enum.objectStatus.active",
235 "active": true,
236 "caption": "Active"
237 },
238 "name": "VAT Standard Rate",
239 "erpSystemId": 0
240 },
241 "taxJurisdictionForNonLeasePayment": {
242 "id": 4001,
243 "displayId": "TJ-2025-001",
244 "status": {
245 "name": "ACTIVE",
246 "captionKey": "enum.objectStatus.active",
247 "active": true,
248 "caption": "Active"
249 },
250 "name": "California Tax Authority",
251 "erpSystemId": 0,
252 "schema": "string",
253 "countryDisplayId": "string"
254 },
255 "costCenter": {
256 "id": 14001,
257 "displayId": "CC-001",
258 "status": {
259 "name": "ACTIVE",
260 "captionKey": "enum.objectStatus.active",
261 "active": true,
262 "caption": "Active"
263 },
264 "name": "Cost Center A",
265 "erpSystemId": 0
266 },
267 "company": {
268 "id": 10000006,
269 "displayId": "1005",
270 "status": {
271 "name": "ACTIVE",
272 "captionKey": "enum.objectStatus.active",
273 "active": true,
274 "caption": "Active"
275 },
276 "erpSystemId": 10000001,
277 "erpSystemDisplayId": "FINQ8S-300",
278 "countryId": 10000095,
279 "countryDisplayId": "CA",
280 "name": "string",
281 "postingPeriodVariantId": 0,
282 "fiscalVariantId": 0
283 },
284 "taxJurisdiction": {
285 "id": 4001,
286 "displayId": "TJ-2025-001",
287 "status": {
288 "name": "ACTIVE",
289 "captionKey": "enum.objectStatus.active",
290 "active": true,
291 "caption": "Active"
292 },
293 "name": "California Tax Authority",
294 "erpSystemId": 0,
295 "schema": "string",
296 "countryDisplayId": "string"
297 },
298 "taxCode": {
299 "id": 5001,
300 "displayId": "TC-001",
301 "status": {
302 "name": "ACTIVE",
303 "captionKey": "enum.objectStatus.active",
304 "active": true,
305 "caption": "Active"
306 },
307 "name": "VAT Standard Rate",
308 "erpSystemId": 0
309 },
310 "responsibleCostCenter": {
311 "id": 14001,
312 "displayId": "CC-001",
313 "status": {
314 "name": "ACTIVE",
315 "captionKey": "enum.objectStatus.active",
316 "active": true,
317 "caption": "Active"
318 },
319 "name": "Cost Center A",
320 "erpSystemId": 0
321 },
322 "plant": {
323 "id": 10000001,
324 "displayId": "PLANT-001",
325 "status": {
326 "name": "ACTIVE",
327 "captionKey": "enum.objectStatus.active",
328 "active": true,
329 "caption": "Active"
330 },
331 "name": "Berlin Manufacturing Plant",
332 "companyId": 7001
333 },
334 "assetCostCenter": {
335 "id": 14001,
336 "displayId": "CC-001",
337 "status": {
338 "name": "ACTIVE",
339 "captionKey": "enum.objectStatus.active",
340 "active": true,
341 "caption": "Active"
342 },
343 "name": "Cost Center A",
344 "erpSystemId": 0
345 },
346 "assetProfitCenter": {
347 "id": 9001,
348 "displayId": "PC-001",
349 "status": {
350 "name": "ACTIVE",
351 "captionKey": "enum.objectStatus.active",
352 "active": true,
353 "caption": "Active"
354 },
355 "name": "North Region Profit Center",
356 "validTo": "2025-12-31",
357 "erpSystemId": 101,
358 "erpSystemDisplayId": "SAP-01"
359 },
360 "assetWorkBreakdownStructure": {
361 "id": 1001,
362 "displayId": "WBS-2025-001",
363 "status": {
364 "name": "ACTIVE",
365 "captionKey": "enum.objectStatus.active",
366 "active": true,
367 "caption": "Active"
368 },
369 "name": "Main Project WBS",
370 "erpSystemId": 0
371 },
372 "assetTaxJurisdiction": {
373 "id": 4001,
374 "displayId": "TJ-2025-001",
375 "status": {
376 "name": "ACTIVE",
377 "captionKey": "enum.objectStatus.active",
378 "active": true,
379 "caption": "Active"
380 },
381 "name": "California Tax Authority",
382 "erpSystemId": 0,
383 "schema": "string",
384 "countryDisplayId": "string"
385 },
386 "assetBusinessArea": {
387 "id": 3001,
388 "displayId": "BA-2025-001",
389 "status": {
390 "name": "ACTIVE",
391 "captionKey": "enum.objectStatus.active",
392 "active": true,
393 "caption": "Active"
394 },
395 "name": "North America Operations",
396 "erpSystemId": 0
397 },
398 "assetSegment": {
399 "id": 11001,
400 "displayId": "SEG-001",
401 "status": {
402 "name": "ACTIVE",
403 "captionKey": "enum.objectStatus.active",
404 "active": true,
405 "caption": "Active"
406 },
407 "name": "Segment Alpha",
408 "erpSystemId": 0
409 },
410 "activationGroupId": 101,
411 "activationGroupDisplayId": "AG-001",
412 "principalPositionType": {
413 "name": "LESSEE",
414 "captionKey": "enum.principalpositiontype.lessee",
415 "caption": "Lessee"
416 },
417 "effectiveDate": "2024-01-01",
418 "costCenterAllocations": [
419 {
420 "id": 10001,
421 "mainCostCenter": true,
422 "allocationPercentage": 75,
423 "costCenter": {
424 "id": 14001,
425 "displayId": "CC-001",
426 "status": {
427 "name": "ACTIVE",
428 "captionKey": "enum.objectStatus.active",
429 "active": true,
430 "caption": "Active"
431 },
432 "name": "Cost Center A",
433 "erpSystemId": 0
434 },
435 "profitCenter": {
436 "id": 9001,
437 "displayId": "PC-001",
438 "status": {
439 "name": "ACTIVE",
440 "captionKey": "enum.objectStatus.active",
441 "active": true,
442 "caption": "Active"
443 },
444 "name": "North Region Profit Center",
445 "validTo": "2025-12-31",
446 "erpSystemId": 101,
447 "erpSystemDisplayId": "SAP-01"
448 }
449 }
450 ],
451 "numberRangeIdentifierValue": "NR-0001",
452 "numberRangeIdentifierType": {
453 "name": "COMPANY_CODE"
454 },
455 "numberRangeType": {
456 "name": "CONTRACT"
457 },
458 "allowsSystemGenerateNewId": true
459 }
460 ],
461 "number": 0,
462 "sort": {
463 "unsorted": false,
464 "sorted": true,
465 "empty": false
466 },
467 "first": true,
468 "last": false,
469 "empty": false
470}
Search Periodic Posting Status Report Jobs¶
HTTP Request
POST /api/v1/periodic_posting_status_reports/jobs/search
📋 Description: Submits a request to search for periodic posting status reports related to leases, contracts, and financial obligations 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 |
false |
Request body containing search criteria and filters for retrieving periodic posting status reports related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
sort |
|
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 "executorEqual": {
14 "name": "MANUAL",
15 "captionKey": "enum.batchJobExecutor.manual",
16 "caption": "Manual"
17 },
18 "classificationsLike": "sample_classificationsLike",
19 "postingTypeEqual": {
20 "name": "ACCRUAL",
21 "captionKey": "enum.postingType.accrual",
22 "caption": "Accrual"
23 },
24 "fromYearLike": "sample_fromYearLike",
25 "toYearLike": "sample_toYearLike",
26 "externalStatusesIn": {
27 "name": "PROCESSING",
28 "captionKey": "enum.taskStatus.processing",
29 "caption": "Processing"
30 },
31 "internalStatusesIn": {
32 "name": "PROCESSING",
33 "captionKey": "enum.taskStatus.processing",
34 "caption": "Processing"
35 },
36 "fromDateGreaterThanOrEqual": "2025-01-01",
37 "fromDateLessThanOrEqual": "2025-01-01",
38 "toDateGreaterThanOrEqual": "2025-01-01",
39 "toDateLessThanOrEqual": "2025-01-01",
40 "accountingStandardTypeEqual": {
41 "name": "GAAP",
42 "captionKey": "enum.accountingStandard.gaap",
43 "caption": "GAAP"
44 },
45 "toPostingPeriodLike": "sample_toPostingPeriodLike",
46 "fromPostingPeriodLike": "sample_fromPostingPeriodLike",
47 "objectDisplayIdLike": "sample_objectDisplayIdLike",
48 "unitDisplayIdLike": "sample_unitDisplayIdLike"
49}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 10000001,
3 "totalPages": 100,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": false,
7 "paged": true,
8 "pageSize": 100,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 100,
17 "size": 100,
18 "content": [],
19 "number": 100,
20 "sort": {
21 "unsorted": false,
22 "sorted": true,
23 "empty": false
24 },
25 "first": false,
26 "last": false,
27 "empty": false
28}
Cancel Periodic Posting Status Report Job¶
HTTP Request
POST /api/v1/periodic_posting_status_reports/jobs/cancel/{id}
📋 Description: Cancels a scheduled periodic posting status report job identified by the specified ID, ensuring that any associated lease, contract, or financial obligation entries are not processed in the Nakisa Lease Accounting Suite. This operation helps maintain accurate accounting records by preventing unwanted entries from being generated.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Activation Groups For Periodic Posting Status Report Job¶
HTTP Request
POST /api/v1/periodic_posting_status_reports/jobs/activation-groups
📋 Description: Creates activation groups for periodic posting status reports within the Nakisa Lease Accounting Suite, facilitating the management of lease and contract financial obligations and ensuring accurate accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Page number (0-indexed) |
size |
query |
integer |
false |
Number of items per page |
sort |
query |
array[string] |
false |
Sorting criteria in format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing the activation group details for periodic posting status reports, including relevant lease, contract, and financial obligation information necessary for accurate accounting entry processing. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1, Max: 100 |
Body Parameters
1{
2 "searchTerm": "sample_searchTerm",
3 "profile": {
4 "id": 10000001,
5 "name": "Sample Name",
6 "principalPositionType": {
7 "name": "LESSEE",
8 "captionKey": "enum.principalpositiontype.lessee",
9 "caption": "Lessee"
10 },
11 "calendarType": {
12 "name": "_360",
13 "captionKey": "enum.calendarType.360",
14 "caption": "360 Convention"
15 },
16 "fiscalYearVariant": {
17 "id": "string",
18 "displayId": "Euro"
19 },
20 "profileId": 10000001,
21 "jobId": 10000001,
22 "objectList": [],
23 "filterTypes": {
24 "erpSystemFilterType": {
25 "name": "ALL",
26 "captionKey": "enum.filterType.all",
27 "caption": "All"
28 },
29 "erpSystems": [],
30 "leaseAreaFilterType": {
31 "name": "ALL",
32 "captionKey": "enum.filterType.all",
33 "caption": "All"
34 },
35 "leaseAreas": [],
36 "businessUnitFilterType": {
37 "name": "ALL",
38 "captionKey": "enum.filterType.all",
39 "caption": "All"
40 },
41 "businessUnits": [],
42 "companyFilterType": {
43 "name": "ALL",
44 "captionKey": "enum.filterType.all",
45 "caption": "All"
46 },
47 "companies": [],
48 "leaseDepartmentFilterType": {
49 "name": "ALL",
50 "captionKey": "enum.filterType.all",
51 "caption": "All"
52 },
53 "leaseDepartments": [],
54 "leaseGroupFilterType": {
55 "name": "ALL",
56 "captionKey": "enum.filterType.all",
57 "caption": "All"
58 },
59 "leaseGroups": [],
60 "costCenterFilterType": {
61 "name": "ALL",
62 "captionKey": "enum.filterType.all",
63 "caption": "All"
64 },
65 "costCenters": [],
66 "profitCenterFilterType": {
67 "name": "ALL",
68 "captionKey": "enum.filterType.all",
69 "caption": "All"
70 },
71 "profitCenters": [],
72 "wbsFilterType": {
73 "name": "ALL",
74 "captionKey": "enum.filterType.all",
75 "caption": "All"
76 },
77 "wbses": [],
78 "businessAreaFilterType": {
79 "name": "ALL",
80 "captionKey": "enum.filterType.all",
81 "caption": "All"
82 },
83 "businessAreas": [],
84 "functionalAreaFilterType": {
85 "name": "ALL",
86 "captionKey": "enum.filterType.all",
87 "caption": "All"
88 },
89 "functionalAreas": []
90 }
91 },
92 "migratedFilterType": {
93 "name": "ALL",
94 "captionKey": "enum.migratedFilterType.all",
95 "caption": "All"
96 }
97}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 76,
3 "totalPages": 1,
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": 76,
17 "size": 100,
18 "content": [
19 {
20 "id": 10000001,
21 "displayId": "AG-100000000",
22 "principalPositionType": {
23 "name": "LESSEE",
24 "captionKey": "enum.principalpositiontype.lessee",
25 "caption": "Lessee"
26 },
27 "name": "Test2",
28 "description": "test2",
29 "approverComment": "Approved after review",
30 "snapshotData": {
31 "isParallelCurrencyEnabled": true,
32 "isCostCenterAllocationEnabled": false,
33 "useSpotRateForGroupCurrency": true,
34 "usePostingOrDocumentDateForCurrency": true,
35 "exchangeRateTypes": [
36 {
37 "currencyDefinitionType": "CONTRACT_CURRENCY",
38 "sourceCurrencyType": "COMPANY_CURRENCY",
39 "translationDateType": "POSTING_DATE",
40 "targetCurrency": {
41 "id": "string",
42 "displayId": "US Dollar",
43 "decimalPoints": 2
44 },
45 "referenceCurrency": {
46 "id": "string",
47 "displayId": "Euro"
48 },
49 "currencyType": "GROUP_CURRENCY",
50 "exchangeRateType": "STANDARD"
51 }
52 ]
53 },
54 "revision": {
55 "id": 10000001,
56 "displayId": "0374999413-20250903-161147",
57 "name": "Inception",
58 "inception": true,
59 "revisionType": "REVISION",
60 "state": "MLA_DEFINE",
61 "approvedBy": "approver.admin@nakisa.com",
62 "approvedAt": "2019-08-24T14:15:22Z",
63 "parentRevisionId": 10000000,
64 "approverComment": "Approved after financial validation.",
65 "rouStartDate": "2025-08-01",
66 "rouEndDate": "2025-08-20",
67 "activationGroupModification": {
68 "modificationDate": "2025-08-15",
69 "terminationType": "CASUALTY",
70 "terminationDate": {
71 "timing": "START_OF_DAY",
72 "year": 2025,
73 "monthValue": 9,
74 "dayOfMonth": 4,
75 "leapYear": false,
76 "month": "SEPTEMBER",
77 "dayOfWeek": "THURSDAY",
78 "dayOfYear": 247
79 },
80 "useManualFmvValue": true,
81 "useManualAssetValues": false,
82 "enforceNonLeaseOnIndexation": false,
83 "applyIndexationLease": true,
84 "applyIndexationNonLease": false,
85 "indexationTreatmentType": "DEFAULT",
86 "indexationStartDate": "2025-09-01",
87 "indexationDateType": "USER_DEFINED",
88 "indexationStartDateNonLease": "2025-09-10",
89 "indexationDateTypeNonLease": "USER_DEFINED",
90 "modificationReasons": [
91 "CONTRACT_RATE_CHANGE",
92 "INDEXATION"
93 ],
94 "modificationPerClassificationList": [
95 {
96 "accountingStandardId": 1001,
97 "classificationType": "NON_LEASE",
98 "accountingStandardType": "IFRS",
99 "impairmentAmount": 2500.5,
100 "recoverableAmount": 2000,
101 "decreaseInAsset": 1500,
102 "decreaseInTerm": 6
103 }
104 ],
105 "massIndexationTaskId": 987654
106 },
107 "activationGroupId": 10000001,
108 "activationGroupDisplayId": "AG-100000000",
109 "activationGroupName": "Test2",
110 "leaseComponentRevisionId": 10000007,
111 "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
112 "lastLeaseComponentRevisionId": 10000006,
113 "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
114 "clonedFromRevisionId": 10000002,
115 "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
116 "lockReason": "PENDING_TERMINATION",
117 "infiniteUsefulLife": false,
118 "transferOfOwnership": false,
119 "specializedAsset": false,
120 "fairMarketValue": 1,
121 "residualValue": 1,
122 "endOfTermIntention": "TO_BE_DETERMINED",
123 "endOfTermDate": "2025-08-11",
124 "endOfTermPeriod": 9,
125 "activationDocumentDate": "2019-08-24",
126 "activationPostingDate": "2019-08-24",
127 "closingDocumentDate": "2019-08-24",
128 "closingPostingDate": "2019-08-24",
129 "numberRangeIdentifierValue": "1000",
130 "numberRangeIdentifierType": {
131 "name": "COMPANY_CODE"
132 },
133 "numberRangeType": {
134 "name": "CONTRACT"
135 },
136 "allowsSystemGenerateNewId": false
137 },
138 "leaseComponentId": 10000007,
139 "leaseComponentDisplayId": "LC-100000200",
140 "companyCodeId": 10000002,
141 "companyCodeDisplayId": "1000",
142 "splittedFromActivationGroupRevisionId": {
143 "id": 10000001,
144 "displayId": "0374999413-20250903-161147",
145 "name": "Inception",
146 "inception": true,
147 "revisionType": "REVISION",
148 "state": "MLA_DEFINE",
149 "approvedBy": "approver.admin@nakisa.com",
150 "approvedAt": "2019-08-24T14:15:22Z",
151 "parentRevisionId": 10000000,
152 "approverComment": "Approved after financial validation.",
153 "rouStartDate": "2025-08-01",
154 "rouEndDate": "2025-08-20",
155 "activationGroupModification": {
156 "modificationDate": "2025-08-15",
157 "terminationType": "CASUALTY",
158 "terminationDate": {
159 "timing": "START_OF_DAY",
160 "year": 2025,
161 "monthValue": 9,
162 "dayOfMonth": 4,
163 "leapYear": false,
164 "month": "SEPTEMBER",
165 "dayOfWeek": "THURSDAY",
166 "dayOfYear": 247
167 },
168 "useManualFmvValue": true,
169 "useManualAssetValues": false,
170 "enforceNonLeaseOnIndexation": false,
171 "applyIndexationLease": true,
172 "applyIndexationNonLease": false,
173 "indexationTreatmentType": "DEFAULT",
174 "indexationStartDate": "2025-09-01",
175 "indexationDateType": "USER_DEFINED",
176 "indexationStartDateNonLease": "2025-09-10",
177 "indexationDateTypeNonLease": "USER_DEFINED",
178 "modificationReasons": [
179 "CONTRACT_RATE_CHANGE",
180 "INDEXATION"
181 ],
182 "modificationPerClassificationList": [
183 {
184 "accountingStandardId": 1001,
185 "classificationType": "NON_LEASE",
186 "accountingStandardType": "IFRS",
187 "impairmentAmount": 2500.5,
188 "recoverableAmount": 2000,
189 "decreaseInAsset": 1500,
190 "decreaseInTerm": 6
191 }
192 ],
193 "massIndexationTaskId": 987654
194 },
195 "activationGroupId": 10000001,
196 "activationGroupDisplayId": "AG-100000000",
197 "activationGroupName": "Test2",
198 "leaseComponentRevisionId": 10000007,
199 "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
200 "lastLeaseComponentRevisionId": 10000006,
201 "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
202 "clonedFromRevisionId": 10000002,
203 "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
204 "lockReason": "PENDING_TERMINATION",
205 "infiniteUsefulLife": false,
206 "transferOfOwnership": false,
207 "specializedAsset": false,
208 "fairMarketValue": 1,
209 "residualValue": 1,
210 "endOfTermIntention": "TO_BE_DETERMINED",
211 "endOfTermDate": "2025-08-11",
212 "endOfTermPeriod": 9,
213 "activationDocumentDate": "2019-08-24",
214 "activationPostingDate": "2019-08-24",
215 "closingDocumentDate": "2019-08-24",
216 "closingPostingDate": "2019-08-24",
217 "numberRangeIdentifierValue": "1000",
218 "numberRangeIdentifierType": {
219 "name": "COMPANY_CODE"
220 },
221 "numberRangeType": {
222 "name": "CONTRACT"
223 },
224 "allowsSystemGenerateNewId": false
225 },
226 "notifications": [
227 {
228 "id": 100045,
229 "topic": {
230 "enCaption": "Lease Component Updated",
231 "frCaption": "Composant de bail mis à jour",
232 "name": "LEASE_COMPONENT_UPDATED",
233 "priority": "HIGH"
234 },
235 "username": "jdoe",
236 "activationGroupId": 20000123,
237 "activationGroupDisplayId": "AG-100045",
238 "targetId": "jdoe@example.com",
239 "targetType": "USER"
240 }
241 ],
242 "transferInfo": {
243 "transferredFromDisplayId": "CTR-00012",
244 "transferredFromRevisionId": 20000001,
245 "transferredToDisplayId": "CTR-00015",
246 "transferredToRevisionId": 20000005
247 },
248 "numberRangeIdentifierValue": "1000",
249 "numberRangeIdentifierType": {
250 "name": "COMPANY_CODE"
251 },
252 "numberRangeType": {
253 "name": "CONTRACT"
254 },
255 "allowsSystemGenerateNewId": false
256 }
257 ],
258 "number": 0,
259 "sort": {
260 "unsorted": false,
261 "sorted": true,
262 "empty": false
263 },
264 "first": true,
265 "last": true,
266 "empty": false
267}
List All Periodic Posting Status Report Jobs¶
HTTP Request
GET /api/v1/periodic_posting_status_reports/jobs
📋 Description: Retrieves the status reports of periodic posting jobs related to leases and contracts within the Nakisa Lease Accounting Suite, providing insights into financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the periodic posting status reports for lease and contract management should be returned in a paginated format to facilitate efficient data retrieval. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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}
Create New Periodic Posting Status Report Job¶
HTTP Request
POST /api/v1/periodic_posting_status_reports/jobs
📋 Description: Creates a new periodic posting status report job within the Nakisa Lease Accounting Suite, facilitating the tracking and management of lease-related financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the details of periodic posting status reports, including lease and contract information, financial obligations, and associated accounting entries. |
Body Parameters
1{
2 "id": 10000001,
3 "taskCount": 100,
4 "failedTaskCount": 100,
5 "doneTaskCount": 100,
6 "inProgressTaskCount": 100,
7 "cancelledTaskCount": 100,
8 "errorMessage": "sample_errorMessage",
9 "executor": {
10 "name": "MANUAL",
11 "captionKey": "enum.batchJobExecutor.manual",
12 "caption": "Manual"
13 },
14 "scheduleJobId": 10000001,
15 "batchSize": 1000,
16 "totalObjectCount": 100,
17 "profileId": 10000001,
18 "readOnly": false,
19 "status": {
20 "name": "PROCESSING",
21 "captionKey": "enum.batchJobStatus.processing",
22 "caption": "Processing"
23 },
24 "fileStorageId": "sample_fileStorageId",
25 "generatingExportFile": false,
26 "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
27 "finishedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
28 "input": {
29 "id": 10000001,
30 "accountingStandardType": {
31 "name": "GAAP",
32 "captionKey": "enum.accountingStandard.gaap",
33 "caption": "GAAP"
34 },
35 "classifications": {
36 "name": "FINANCE",
37 "captionKey": "enum.leaseClassificationType.finance",
38 "caption": "Finance Lease"
39 },
40 "fromYear": 100,
41 "fromPeriod": {
42 "id": 10000001,
43 "displayId": "FP-2024-Q1",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "day": 15,
51 "year": 2024,
52 "month": 3,
53 "postingPeriod": 3,
54 "yearShift": 0
55 },
56 "toYear": 100,
57 "toPeriod": {
58 "id": 10000001,
59 "displayId": "FP-2024-Q1",
60 "status": {
61 "name": "ACTIVE",
62 "captionKey": "enum.objectStatus.active",
63 "active": true,
64 "caption": "Active"
65 },
66 "day": 15,
67 "year": 2024,
68 "month": 3,
69 "postingPeriod": 3,
70 "yearShift": 0
71 },
72 "fromDate": "2025-01-01",
73 "toDate": "2025-01-01",
74 "fromDateType": "USER_DEFINED",
75 "toDateType": "USER_DEFINED",
76 "postingType": {
77 "name": "ACCRUAL",
78 "captionKey": "enum.postingType.accrual",
79 "caption": "Accrual"
80 },
81 "externalStatusFilterType": {
82 "name": "ALL",
83 "captionKey": "enum.filterType.all",
84 "caption": "All"
85 },
86 "externalStatuses": {
87 "name": "PROCESSING",
88 "captionKey": "enum.taskStatus.processing",
89 "caption": "Processing"
90 },
91 "internalStatusFilterType": {
92 "name": "ALL",
93 "captionKey": "enum.filterType.all",
94 "caption": "All"
95 },
96 "internalStatuses": {
97 "name": "PROCESSING",
98 "captionKey": "enum.taskStatus.processing",
99 "caption": "Processing"
100 },
101 "listObjectType": {
102 "name": "ACTIVATION_GROUP",
103 "captionKey": "enum.listObjectType.activationGroup",
104 "caption": "Activation Group"
105 },
106 "objectList": [],
107 "migratedFilterType": {
108 "name": "ALL",
109 "captionKey": "enum.migratedFilterType.all",
110 "caption": "All"
111 },
112 "internalAssetClassFilterType": {
113 "name": "ALL",
114 "captionKey": "enum.filterType.all",
115 "caption": "All"
116 },
117 "internalAssetClasses": [],
118 "businessAreaFilterType": {
119 "name": "ALL",
120 "captionKey": "enum.filterType.all",
121 "caption": "All"
122 },
123 "businessAreas": [],
124 "functionalAreaFilterType": {
125 "name": "ALL",
126 "captionKey": "enum.filterType.all",
127 "caption": "All"
128 },
129 "functionalAreas": []
130 },
131 "filter": {
132 "id": 10000001,
133 "name": "Sample Name",
134 "principalPositionType": {
135 "name": "LESSEE",
136 "captionKey": "enum.principalpositiontype.lessee",
137 "caption": "Lessee"
138 },
139 "calendarType": {
140 "name": "_360",
141 "captionKey": "enum.calendarType.360",
142 "caption": "360 Convention"
143 },
144 "fiscalYearVariant": {
145 "id": "string",
146 "displayId": "Euro"
147 },
148 "profileId": 10000001,
149 "jobId": 10000001,
150 "objectList": [],
151 "filterTypes": {
152 "erpSystemFilterType": {
153 "name": "ALL",
154 "captionKey": "enum.filterType.all",
155 "caption": "All"
156 },
157 "erpSystems": [],
158 "leaseAreaFilterType": {
159 "name": "ALL",
160 "captionKey": "enum.filterType.all",
161 "caption": "All"
162 },
163 "leaseAreas": [],
164 "businessUnitFilterType": {
165 "name": "ALL",
166 "captionKey": "enum.filterType.all",
167 "caption": "All"
168 },
169 "businessUnits": [],
170 "companyFilterType": {
171 "name": "ALL",
172 "captionKey": "enum.filterType.all",
173 "caption": "All"
174 },
175 "companies": [],
176 "leaseDepartmentFilterType": {
177 "name": "ALL",
178 "captionKey": "enum.filterType.all",
179 "caption": "All"
180 },
181 "leaseDepartments": [],
182 "leaseGroupFilterType": {
183 "name": "ALL",
184 "captionKey": "enum.filterType.all",
185 "caption": "All"
186 },
187 "leaseGroups": [],
188 "costCenterFilterType": {
189 "name": "ALL",
190 "captionKey": "enum.filterType.all",
191 "caption": "All"
192 },
193 "costCenters": [],
194 "profitCenterFilterType": {
195 "name": "ALL",
196 "captionKey": "enum.filterType.all",
197 "caption": "All"
198 },
199 "profitCenters": [],
200 "wbsFilterType": {
201 "name": "ALL",
202 "captionKey": "enum.filterType.all",
203 "caption": "All"
204 },
205 "wbses": [],
206 "businessAreaFilterType": {
207 "name": "ALL",
208 "captionKey": "enum.filterType.all",
209 "caption": "All"
210 },
211 "businessAreas": [],
212 "functionalAreaFilterType": {
213 "name": "ALL",
214 "captionKey": "enum.filterType.all",
215 "caption": "All"
216 },
217 "functionalAreas": []
218 }
219 },
220 "tasks": [],
221 "docStoreId": 10000001
222}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "taskCount": 100,
13 "failedTaskCount": 100,
14 "doneTaskCount": 100,
15 "inProgressTaskCount": 100,
16 "cancelledTaskCount": 100,
17 "errorMessage": "sample_errorMessage",
18 "executor": {
19 "name": "MANUAL",
20 "captionKey": "enum.batchJobExecutor.manual",
21 "caption": "Manual"
22 },
23 "scheduleJobId": 10000001,
24 "batchSize": 1000,
25 "totalObjectCount": 100,
26 "profileId": 10000001,
27 "readOnly": false,
28 "status": {
29 "name": "PROCESSING",
30 "captionKey": "enum.batchJobStatus.processing",
31 "caption": "Processing"
32 },
33 "fileStorageId": "sample_fileStorageId",
34 "generatingExportFile": false,
35 "startedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
36 "finishedGeneratingExportFileAt": "2025-01-01T10:00:00Z",
37 "input": {
38 "id": 10000001,
39 "accountingStandardType": {
40 "name": "GAAP",
41 "captionKey": "enum.accountingStandard.gaap",
42 "caption": "GAAP"
43 },
44 "classifications": {
45 "name": "FINANCE",
46 "captionKey": "enum.leaseClassificationType.finance",
47 "caption": "Finance Lease"
48 },
49 "fromYear": 100,
50 "fromPeriod": {
51 "id": 10000001,
52 "displayId": "FP-2024-Q1",
53 "status": {
54 "name": "ACTIVE",
55 "captionKey": "enum.objectStatus.active",
56 "active": true,
57 "caption": "Active"
58 },
59 "day": 15,
60 "year": 2024,
61 "month": 3,
62 "postingPeriod": 3,
63 "yearShift": 0
64 },
65 "toYear": 100,
66 "toPeriod": {
67 "id": 10000001,
68 "displayId": "FP-2024-Q1",
69 "status": {
70 "name": "ACTIVE",
71 "captionKey": "enum.objectStatus.active",
72 "active": true,
73 "caption": "Active"
74 },
75 "day": 15,
76 "year": 2024,
77 "month": 3,
78 "postingPeriod": 3,
79 "yearShift": 0
80 },
81 "fromDate": "2025-01-01",
82 "toDate": "2025-01-01",
83 "fromDateType": "USER_DEFINED",
84 "toDateType": "USER_DEFINED",
85 "postingType": {
86 "name": "ACCRUAL",
87 "captionKey": "enum.postingType.accrual",
88 "caption": "Accrual"
89 },
90 "externalStatusFilterType": {
91 "name": "ALL",
92 "captionKey": "enum.filterType.all",
93 "caption": "All"
94 },
95 "externalStatuses": {
96 "name": "PROCESSING",
97 "captionKey": "enum.taskStatus.processing",
98 "caption": "Processing"
99 },
100 "internalStatusFilterType": {
101 "name": "ALL",
102 "captionKey": "enum.filterType.all",
103 "caption": "All"
104 },
105 "internalStatuses": {
106 "name": "PROCESSING",
107 "captionKey": "enum.taskStatus.processing",
108 "caption": "Processing"
109 },
110 "listObjectType": {
111 "name": "ACTIVATION_GROUP",
112 "captionKey": "enum.listObjectType.activationGroup",
113 "caption": "Activation Group"
114 },
115 "objectList": [],
116 "migratedFilterType": {
117 "name": "ALL",
118 "captionKey": "enum.migratedFilterType.all",
119 "caption": "All"
120 },
121 "internalAssetClassFilterType": {
122 "name": "ALL",
123 "captionKey": "enum.filterType.all",
124 "caption": "All"
125 },
126 "internalAssetClasses": [],
127 "businessAreaFilterType": {
128 "name": "ALL",
129 "captionKey": "enum.filterType.all",
130 "caption": "All"
131 },
132 "businessAreas": [],
133 "functionalAreaFilterType": {
134 "name": "ALL",
135 "captionKey": "enum.filterType.all",
136 "caption": "All"
137 },
138 "functionalAreas": []
139 },
140 "filter": {
141 "id": 10000001,
142 "name": "Sample Name",
143 "principalPositionType": {
144 "name": "LESSEE",
145 "captionKey": "enum.principalpositiontype.lessee",
146 "caption": "Lessee"
147 },
148 "calendarType": {
149 "name": "_360",
150 "captionKey": "enum.calendarType.360",
151 "caption": "360 Convention"
152 },
153 "fiscalYearVariant": {
154 "id": "string",
155 "displayId": "Euro"
156 },
157 "profileId": 10000001,
158 "jobId": 10000001,
159 "objectList": [],
160 "filterTypes": {
161 "erpSystemFilterType": {
162 "name": "ALL",
163 "captionKey": "enum.filterType.all",
164 "caption": "All"
165 },
166 "erpSystems": [],
167 "leaseAreaFilterType": {
168 "name": "ALL",
169 "captionKey": "enum.filterType.all",
170 "caption": "All"
171 },
172 "leaseAreas": [],
173 "businessUnitFilterType": {
174 "name": "ALL",
175 "captionKey": "enum.filterType.all",
176 "caption": "All"
177 },
178 "businessUnits": [],
179 "companyFilterType": {
180 "name": "ALL",
181 "captionKey": "enum.filterType.all",
182 "caption": "All"
183 },
184 "companies": [],
185 "leaseDepartmentFilterType": {
186 "name": "ALL",
187 "captionKey": "enum.filterType.all",
188 "caption": "All"
189 },
190 "leaseDepartments": [],
191 "leaseGroupFilterType": {
192 "name": "ALL",
193 "captionKey": "enum.filterType.all",
194 "caption": "All"
195 },
196 "leaseGroups": [],
197 "costCenterFilterType": {
198 "name": "ALL",
199 "captionKey": "enum.filterType.all",
200 "caption": "All"
201 },
202 "costCenters": [],
203 "profitCenterFilterType": {
204 "name": "ALL",
205 "captionKey": "enum.filterType.all",
206 "caption": "All"
207 },
208 "profitCenters": [],
209 "wbsFilterType": {
210 "name": "ALL",
211 "captionKey": "enum.filterType.all",
212 "caption": "All"
213 },
214 "wbses": [],
215 "businessAreaFilterType": {
216 "name": "ALL",
217 "captionKey": "enum.filterType.all",
218 "caption": "All"
219 },
220 "businessAreas": [],
221 "functionalAreaFilterType": {
222 "name": "ALL",
223 "captionKey": "enum.filterType.all",
224 "caption": "All"
225 },
226 "functionalAreas": []
227 }
228 },
229 "tasks": [],
230 "docStoreId": 10000001
231 }
232}
Delete Periodic Posting Status Report Job¶
HTTP Request
DELETE /api/v1/periodic_posting_status_reports/jobs
📋 Description: Deletes specified periodic posting status report jobs within the Nakisa Lease Accounting Suite, facilitating the management of lease, contract, and financial obligation records by removing outdated or unnecessary entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
false |
Request body containing identifiers for the periodic posting status report jobs to be deleted, relevant to lease and contract management within the Nakisa Lease Accounting Suite. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {}
7}
List Posting Types For Periodic Posting Status Report Job¶
HTTP Request
GET /api/v1/periodic_posting_status_reports/jobs/posting_types
📋 Description: Retrieves a list of posting types associated with periodic posting status reports within the Nakisa Lease Accounting Suite, facilitating insights into lease, contract, and financial obligation management for accounting entries.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]
Response Schema
Generate Periodic Posting Status Report Job Report¶
HTTP Request
GET /api/v1/periodic_posting_status_reports/jobs/generate_report/{jobId}
📋 Description: Generates a periodic posting status report for a specific job identified by the {jobId}, providing insights into lease and contract financial obligations and related accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
jobId |
path |
integer |
true |
Unique identifier for the job |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Download Periodic Posting Status Report Job Report¶
HTTP Request
GET /api/v1/periodic_posting_status_reports/jobs/download_report/{jobId}
📋 Description: Downloads the periodic posting status report associated with the specified job ID, providing insights into lease and contract financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
jobId |
path |
integer |
true |
Unique identifier for the job |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
List All Calendar Typess¶
HTTP Request
GET /api/v1/periodic_posting_status_reports/jobs/calendar_types
📋 Description: Retrieves the available calendar types for periodic posting status reports within the Nakisa Lease Accounting Suite, facilitating effective management of lease, contract, and financial obligation accounting entries.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]