Operating Cost Period¶
Update Note¶
HTTP Request
PUT /api/notes/{id}
📋 Description: Updates an existing note identified by its unique ID, allowing users to modify content and enhance information management within the application.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated note details, including title, content, and any relevant metadata for effective note management. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "message": "string",
10 "userIds": [
11 0
12 ],
13 "redirectUrl": "string"
14}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "message": "string",
10 "userIds": [
11 0
12 ],
13 "redirectUrl": "string"
14}
Delete Note¶
HTTP Request
DELETE /api/notes/{id}
📋 Description: Deletes a specific note identified by its unique ID, ensuring the removal of unnecessary or outdated information from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Update Operating Cost Period¶
HTTP Request
PUT /api/locations/{locationId}/operating-cost-periods/{id}
📋 Description: Updates the details of a specific operating cost period for a given location, enabling accurate financial tracking and management of operational expenses.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated operating cost period details, including financial metrics and relevant timestamps for the specified location. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "startDate": "2019-08-24",
10 "endDate": "2019-08-24",
11 "year": 1950,
12 "statusId": 0,
13 "expenses": [
14 {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "operatingCostExpenseTypeId": 0,
23 "amount": 0,
24 "revisedAmount": 0,
25 "considerRevisedAmount": true,
26 "operatingCostExpenseType": {
27 "createdBy": "string",
28 "lastModifiedBy": "string",
29 "createdDate": "2019-08-24T14:15:22Z",
30 "lastModifiedDate": "2019-08-24T14:15:22Z",
31 "archived": true,
32 "externalId": "string",
33 "id": 0,
34 "priority": 0,
35 "internalId": 0,
36 "pickListCode": "string",
37 "pickListLabel": "string",
38 "label": "string",
39 "cultureId": 0,
40 "labelDtos": [
41 {
42 "createdBy": "string",
43 "lastModifiedBy": "string",
44 "createdDate": "2019-08-24T14:15:22Z",
45 "lastModifiedDate": "2019-08-24T14:15:22Z",
46 "archived": true,
47 "externalId": "string",
48 "id": 0,
49 "cultureId": 0,
50 "value": "string"
51 }
52 ]
53 },
54 "expenseGroup": {
55 "createdBy": "string",
56 "lastModifiedBy": "string",
57 "createdDate": "2019-08-24T14:15:22Z",
58 "lastModifiedDate": "2019-08-24T14:15:22Z",
59 "archived": true,
60 "externalId": "string",
61 "id": 0,
62 "priority": 0,
63 "internalId": 0,
64 "pickListCode": "string",
65 "pickListLabel": "string",
66 "label": "string",
67 "cultureId": 0,
68 "labelDtos": [
69 {
70 "createdBy": "string",
71 "lastModifiedBy": "string",
72 "createdDate": "2019-08-24T14:15:22Z",
73 "lastModifiedDate": "2019-08-24T14:15:22Z",
74 "archived": true,
75 "externalId": "string",
76 "id": 0,
77 "cultureId": 0,
78 "value": "string"
79 }
80 ]
81 }
82 }
83 ],
84 "status": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "leaseReconciliationPeriods": [
113 {
114 "createdBy": "string",
115 "lastModifiedBy": "string",
116 "createdDate": "2019-08-24T14:15:22Z",
117 "lastModifiedDate": "2019-08-24T14:15:22Z",
118 "archived": true,
119 "externalId": "string",
120 "id": 0,
121 "startDate": "2019-08-24",
122 "endDate": "2019-08-24",
123 "statusId": 0,
124 "invoiceAmount": 0,
125 "receivedDate": "2019-08-24",
126 "acceptedAmount": 0,
127 "reviewedBy": "string",
128 "reviewedDate": "2019-08-24",
129 "fullReconciliation": true,
130 "status": {
131 "createdBy": "string",
132 "lastModifiedBy": "string",
133 "createdDate": "2019-08-24T14:15:22Z",
134 "lastModifiedDate": "2019-08-24T14:15:22Z",
135 "archived": true,
136 "externalId": "string",
137 "id": 0,
138 "priority": 0,
139 "internalId": 0,
140 "pickListCode": "string",
141 "pickListLabel": "string",
142 "label": "string",
143 "cultureId": 0,
144 "labelDtos": [
145 {
146 "createdBy": "string",
147 "lastModifiedBy": "string",
148 "createdDate": "2019-08-24T14:15:22Z",
149 "lastModifiedDate": "2019-08-24T14:15:22Z",
150 "archived": true,
151 "externalId": "string",
152 "id": 0,
153 "cultureId": 0,
154 "value": "string"
155 }
156 ]
157 },
158 "operatingCostPeriodId": 0,
159 "reconciledExpenseCategoryDtos": [
160 {
161 "createdBy": "string",
162 "lastModifiedBy": "string",
163 "createdDate": "2019-08-24T14:15:22Z",
164 "lastModifiedDate": "2019-08-24T14:15:22Z",
165 "archived": true,
166 "externalId": "string",
167 "id": 0,
168 "expenseGroupId": 0,
169 "totalCost": 0,
170 "accrualAmount": 0,
171 "balance": 0,
172 "expenseGroup": {
173 "createdBy": "string",
174 "lastModifiedBy": "string",
175 "createdDate": "2019-08-24T14:15:22Z",
176 "lastModifiedDate": "2019-08-24T14:15:22Z",
177 "archived": true,
178 "externalId": "string",
179 "id": 0,
180 "priority": 0,
181 "internalId": 0,
182 "pickListCode": "string",
183 "pickListLabel": "string",
184 "label": "string",
185 "cultureId": 0,
186 "labelDtos": [
187 {
188 "createdBy": "string",
189 "lastModifiedBy": "string",
190 "createdDate": "2019-08-24T14:15:22Z",
191 "lastModifiedDate": "2019-08-24T14:15:22Z",
192 "archived": true,
193 "externalId": "string",
194 "id": 0,
195 "cultureId": 0,
196 "value": "string"
197 }
198 ]
199 },
200 "reconciledExpenseDtos": [
201 {
202 "createdBy": "string",
203 "lastModifiedBy": "string",
204 "createdDate": "2019-08-24T14:15:22Z",
205 "lastModifiedDate": "2019-08-24T14:15:22Z",
206 "archived": true,
207 "externalId": "string",
208 "id": 0,
209 "totalCost": 0,
210 "operatingCostExpenseTypeId": 0,
211 "operatingCostExpenseType": {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "priority": 0,
220 "internalId": 0,
221 "pickListCode": "string",
222 "pickListLabel": "string",
223 "label": "string",
224 "cultureId": 0,
225 "labelDtos": [
226 {
227 "createdBy": "string",
228 "lastModifiedBy": "string",
229 "createdDate": "2019-08-24T14:15:22Z",
230 "lastModifiedDate": "2019-08-24T14:15:22Z",
231 "archived": true,
232 "externalId": "string",
233 "id": 0,
234 "cultureId": 0,
235 "value": "string"
236 }
237 ]
238 },
239 "reconciledExpenseSegmentDtos": [
240 {
241 "createdBy": "string",
242 "lastModifiedBy": "string",
243 "createdDate": "2019-08-24T14:15:22Z",
244 "lastModifiedDate": "2019-08-24T14:15:22Z",
245 "archived": true,
246 "externalId": "string",
247 "id": 0,
248 "startDate": "2019-08-24",
249 "endDate": "2019-08-24",
250 "adjustedLocationCost": 0,
251 "proSharePercentage": 0,
252 "proShareCost": 0,
253 "cap": 0,
254 "subtotalCost": 0,
255 "adminFees": 0,
256 "totalCost": 0,
257 "conditionDto": {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "parentConditionId": 0,
266 "typeId": 0,
267 "startDate": "2019-08-24",
268 "endDate": "2019-08-24",
269 "replaceById": 0,
270 "managedById": 0,
271 "payById": 0,
272 "adminFee": 0,
273 "fixedIncreasePercentage": 0,
274 "note": "string",
275 "pageNumber": "string",
276 "section": "string",
277 "type": {},
278 "replaceBy": {},
279 "managedBy": {},
280 "payBy": {},
281 "proShareDto": {},
282 "capDto": {}
283 }
284 }
285 ]
286 }
287 ],
288 "hasWarning": true
289 }
290 ]
291 }
292 ]
293}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "startDate": "2019-08-24",
10 "endDate": "2019-08-24",
11 "year": 1950,
12 "statusId": 0,
13 "expenses": [
14 {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "operatingCostExpenseTypeId": 0,
23 "amount": 0,
24 "revisedAmount": 0,
25 "considerRevisedAmount": true,
26 "operatingCostExpenseType": {
27 "createdBy": "string",
28 "lastModifiedBy": "string",
29 "createdDate": "2019-08-24T14:15:22Z",
30 "lastModifiedDate": "2019-08-24T14:15:22Z",
31 "archived": true,
32 "externalId": "string",
33 "id": 0,
34 "priority": 0,
35 "internalId": 0,
36 "pickListCode": "string",
37 "pickListLabel": "string",
38 "label": "string",
39 "cultureId": 0,
40 "labelDtos": [
41 {
42 "createdBy": "string",
43 "lastModifiedBy": "string",
44 "createdDate": "2019-08-24T14:15:22Z",
45 "lastModifiedDate": "2019-08-24T14:15:22Z",
46 "archived": true,
47 "externalId": "string",
48 "id": 0,
49 "cultureId": 0,
50 "value": "string"
51 }
52 ]
53 },
54 "expenseGroup": {
55 "createdBy": "string",
56 "lastModifiedBy": "string",
57 "createdDate": "2019-08-24T14:15:22Z",
58 "lastModifiedDate": "2019-08-24T14:15:22Z",
59 "archived": true,
60 "externalId": "string",
61 "id": 0,
62 "priority": 0,
63 "internalId": 0,
64 "pickListCode": "string",
65 "pickListLabel": "string",
66 "label": "string",
67 "cultureId": 0,
68 "labelDtos": [
69 {
70 "createdBy": "string",
71 "lastModifiedBy": "string",
72 "createdDate": "2019-08-24T14:15:22Z",
73 "lastModifiedDate": "2019-08-24T14:15:22Z",
74 "archived": true,
75 "externalId": "string",
76 "id": 0,
77 "cultureId": 0,
78 "value": "string"
79 }
80 ]
81 }
82 }
83 ],
84 "status": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "leaseReconciliationPeriods": [
113 {
114 "createdBy": "string",
115 "lastModifiedBy": "string",
116 "createdDate": "2019-08-24T14:15:22Z",
117 "lastModifiedDate": "2019-08-24T14:15:22Z",
118 "archived": true,
119 "externalId": "string",
120 "id": 0,
121 "startDate": "2019-08-24",
122 "endDate": "2019-08-24",
123 "statusId": 0,
124 "invoiceAmount": 0,
125 "receivedDate": "2019-08-24",
126 "acceptedAmount": 0,
127 "reviewedBy": "string",
128 "reviewedDate": "2019-08-24",
129 "fullReconciliation": true,
130 "status": {
131 "createdBy": "string",
132 "lastModifiedBy": "string",
133 "createdDate": "2019-08-24T14:15:22Z",
134 "lastModifiedDate": "2019-08-24T14:15:22Z",
135 "archived": true,
136 "externalId": "string",
137 "id": 0,
138 "priority": 0,
139 "internalId": 0,
140 "pickListCode": "string",
141 "pickListLabel": "string",
142 "label": "string",
143 "cultureId": 0,
144 "labelDtos": [
145 {
146 "createdBy": "string",
147 "lastModifiedBy": "string",
148 "createdDate": "2019-08-24T14:15:22Z",
149 "lastModifiedDate": "2019-08-24T14:15:22Z",
150 "archived": true,
151 "externalId": "string",
152 "id": 0,
153 "cultureId": 0,
154 "value": "string"
155 }
156 ]
157 },
158 "operatingCostPeriodId": 0,
159 "reconciledExpenseCategoryDtos": [
160 {
161 "createdBy": "string",
162 "lastModifiedBy": "string",
163 "createdDate": "2019-08-24T14:15:22Z",
164 "lastModifiedDate": "2019-08-24T14:15:22Z",
165 "archived": true,
166 "externalId": "string",
167 "id": 0,
168 "expenseGroupId": 0,
169 "totalCost": 0,
170 "accrualAmount": 0,
171 "balance": 0,
172 "expenseGroup": {
173 "createdBy": "string",
174 "lastModifiedBy": "string",
175 "createdDate": "2019-08-24T14:15:22Z",
176 "lastModifiedDate": "2019-08-24T14:15:22Z",
177 "archived": true,
178 "externalId": "string",
179 "id": 0,
180 "priority": 0,
181 "internalId": 0,
182 "pickListCode": "string",
183 "pickListLabel": "string",
184 "label": "string",
185 "cultureId": 0,
186 "labelDtos": [
187 {
188 "createdBy": "string",
189 "lastModifiedBy": "string",
190 "createdDate": "2019-08-24T14:15:22Z",
191 "lastModifiedDate": "2019-08-24T14:15:22Z",
192 "archived": true,
193 "externalId": "string",
194 "id": 0,
195 "cultureId": 0,
196 "value": "string"
197 }
198 ]
199 },
200 "reconciledExpenseDtos": [
201 {
202 "createdBy": "string",
203 "lastModifiedBy": "string",
204 "createdDate": "2019-08-24T14:15:22Z",
205 "lastModifiedDate": "2019-08-24T14:15:22Z",
206 "archived": true,
207 "externalId": "string",
208 "id": 0,
209 "totalCost": 0,
210 "operatingCostExpenseTypeId": 0,
211 "operatingCostExpenseType": {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "priority": 0,
220 "internalId": 0,
221 "pickListCode": "string",
222 "pickListLabel": "string",
223 "label": "string",
224 "cultureId": 0,
225 "labelDtos": [
226 {
227 "createdBy": "string",
228 "lastModifiedBy": "string",
229 "createdDate": "2019-08-24T14:15:22Z",
230 "lastModifiedDate": "2019-08-24T14:15:22Z",
231 "archived": true,
232 "externalId": "string",
233 "id": 0,
234 "cultureId": 0,
235 "value": "string"
236 }
237 ]
238 },
239 "reconciledExpenseSegmentDtos": [
240 {
241 "createdBy": "string",
242 "lastModifiedBy": "string",
243 "createdDate": "2019-08-24T14:15:22Z",
244 "lastModifiedDate": "2019-08-24T14:15:22Z",
245 "archived": true,
246 "externalId": "string",
247 "id": 0,
248 "startDate": "2019-08-24",
249 "endDate": "2019-08-24",
250 "adjustedLocationCost": 0,
251 "proSharePercentage": 0,
252 "proShareCost": 0,
253 "cap": 0,
254 "subtotalCost": 0,
255 "adminFees": 0,
256 "totalCost": 0,
257 "conditionDto": {
258 "createdBy": "string",
259 "lastModifiedBy": "string",
260 "createdDate": "2019-08-24T14:15:22Z",
261 "lastModifiedDate": "2019-08-24T14:15:22Z",
262 "archived": true,
263 "externalId": "string",
264 "id": 0,
265 "parentConditionId": 0,
266 "typeId": 0,
267 "startDate": "2019-08-24",
268 "endDate": "2019-08-24",
269 "replaceById": 0,
270 "managedById": 0,
271 "payById": 0,
272 "adminFee": 0,
273 "fixedIncreasePercentage": 0,
274 "note": "string",
275 "pageNumber": "string",
276 "section": "string",
277 "type": {},
278 "replaceBy": {},
279 "managedBy": {},
280 "payBy": {},
281 "proShareDto": {},
282 "capDto": {}
283 }
284 }
285 ]
286 }
287 ],
288 "hasWarning": true
289 }
290 ]
291 }
292 ]
293}
Get Expenses¶
HTTP Request
GET /api/operating-cost-periods/{periodId}/operating-cost-period-expenses
📋 Description: Fetches the operating cost expenses associated with a specific operating cost period identified by the provided periodId, enabling detailed financial analysis and reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
periodId |
path |
integer(int64) |
true |
Unique identifier for the period |
page |
query |
integer(int32) |
false |
Page number for pagination |
size |
query |
integer(int32) |
false |
Number of items per page |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "page": {
3 "size": 0,
4 "totalElements": 0,
5 "totalPages": 0,
6 "number": 0
7 },
8 "content": [
9 {
10 "createdBy": "string",
11 "lastModifiedBy": "string",
12 "createdDate": "2019-08-24T14:15:22Z",
13 "lastModifiedDate": "2019-08-24T14:15:22Z",
14 "archived": true,
15 "externalId": "string",
16 "id": 0,
17 "operatingCostExpenseTypeId": 0,
18 "amount": 0,
19 "revisedAmount": 0,
20 "considerRevisedAmount": true,
21 "operatingCostExpenseType": {
22 "createdBy": "string",
23 "lastModifiedBy": "string",
24 "createdDate": "2019-08-24T14:15:22Z",
25 "lastModifiedDate": "2019-08-24T14:15:22Z",
26 "archived": true,
27 "externalId": "string",
28 "id": 0,
29 "priority": 0,
30 "internalId": 0,
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "label": "string",
34 "cultureId": 0,
35 "labelDtos": [
36 {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "cultureId": 0,
45 "value": "string"
46 }
47 ]
48 },
49 "expenseGroup": {
50 "createdBy": "string",
51 "lastModifiedBy": "string",
52 "createdDate": "2019-08-24T14:15:22Z",
53 "lastModifiedDate": "2019-08-24T14:15:22Z",
54 "archived": true,
55 "externalId": "string",
56 "id": 0,
57 "priority": 0,
58 "internalId": 0,
59 "pickListCode": "string",
60 "pickListLabel": "string",
61 "label": "string",
62 "cultureId": 0,
63 "labelDtos": [
64 {
65 "createdBy": "string",
66 "lastModifiedBy": "string",
67 "createdDate": "2019-08-24T14:15:22Z",
68 "lastModifiedDate": "2019-08-24T14:15:22Z",
69 "archived": true,
70 "externalId": "string",
71 "id": 0,
72 "cultureId": 0,
73 "value": "string"
74 }
75 ]
76 }
77 }
78 ],
79 "_embedded": {
80 "property1": {},
81 "property2": {}
82 },
83 "_links": {
84 "property1": {},
85 "property2": {}
86 }
87}
Create Expenses¶
HTTP Request
POST /api/operating-cost-periods/{periodId}/operating-cost-period-expenses
📋 Description: Creates a new operating cost expense associated with the specified operating cost period, enabling effective financial management and tracking of expenses within that period.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
periodId |
path |
integer(int64) |
true |
Unique identifier for the period |
body |
body |
true |
Request body containing the detailed expense data associated with the specified operating cost period, including categorization and monetary values. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "operatingCostExpenseTypeId": 0,
11 "amount": 0,
12 "revisedAmount": 0,
13 "considerRevisedAmount": true,
14 "operatingCostExpenseType": {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "priority": 0,
23 "internalId": 0,
24 "pickListCode": "string",
25 "pickListLabel": "string",
26 "label": "string",
27 "cultureId": 0,
28 "labelDtos": [
29 {
30 "createdBy": "string",
31 "lastModifiedBy": "string",
32 "createdDate": "2019-08-24T14:15:22Z",
33 "lastModifiedDate": "2019-08-24T14:15:22Z",
34 "archived": true,
35 "externalId": "string",
36 "id": 0,
37 "cultureId": 0,
38 "value": "string"
39 }
40 ]
41 },
42 "expenseGroup": {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "priority": 0,
51 "internalId": 0,
52 "pickListCode": "string",
53 "pickListLabel": "string",
54 "label": "string",
55 "cultureId": 0,
56 "labelDtos": [
57 {
58 "createdBy": "string",
59 "lastModifiedBy": "string",
60 "createdDate": "2019-08-24T14:15:22Z",
61 "lastModifiedDate": "2019-08-24T14:15:22Z",
62 "archived": true,
63 "externalId": "string",
64 "id": 0,
65 "cultureId": 0,
66 "value": "string"
67 }
68 ]
69 }
70 }
71]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "operatingCostExpenseTypeId": 0,
11 "amount": 0,
12 "revisedAmount": 0,
13 "considerRevisedAmount": true,
14 "operatingCostExpenseType": {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "priority": 0,
23 "internalId": 0,
24 "pickListCode": "string",
25 "pickListLabel": "string",
26 "label": "string",
27 "cultureId": 0,
28 "labelDtos": [
29 {
30 "createdBy": "string",
31 "lastModifiedBy": "string",
32 "createdDate": "2019-08-24T14:15:22Z",
33 "lastModifiedDate": "2019-08-24T14:15:22Z",
34 "archived": true,
35 "externalId": "string",
36 "id": 0,
37 "cultureId": 0,
38 "value": "string"
39 }
40 ]
41 },
42 "expenseGroup": {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "priority": 0,
51 "internalId": 0,
52 "pickListCode": "string",
53 "pickListLabel": "string",
54 "label": "string",
55 "cultureId": 0,
56 "labelDtos": [
57 {
58 "createdBy": "string",
59 "lastModifiedBy": "string",
60 "createdDate": "2019-08-24T14:15:22Z",
61 "lastModifiedDate": "2019-08-24T14:15:22Z",
62 "archived": true,
63 "externalId": "string",
64 "id": 0,
65 "cultureId": 0,
66 "value": "string"
67 }
68 ]
69 }
70 }
71]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the expenses incurred during a specific operating cost period, designed to facilitate financial analysis and reporting within budget management processes.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Indicates whether the operating cost period expense has been archived, reflecting its status within the financial records. |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» operatingCostExpenseTypeId |
integer(int64) |
false |
none |
Unique identifier for the operating cost expense type |
» amount |
number |
true |
none |
Amount value |
» revisedAmount |
number |
false |
none |
Amount of revised |
» considerRevisedAmount |
boolean |
false |
none |
Amount of consider revised |
» operatingCostExpenseType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Indicates whether the pick list option has been archived, allowing for effective management of active and inactive options within the system. |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»» pickListCode |
string |
false |
none |
Code for the pick list |
»» pickListLabel |
string |
false |
none |
Label for the pick list |
»» label |
string |
false |
none |
Label for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» labelDtos |
false |
none |
An array of pick list options that allows users to select and categorize relevant data points within the application. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Indicates whether the label has been archived, reflecting its current status within the system. |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» value |
string |
true |
none |
Represents the textual value associated with the label, providing essential context for categorization and identification within the system. |
» expenseGroup |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
Get Notes¶
HTTP Request
GET /api/operating-cost-periods/{periodId}/notes
📋 Description: Retrieves notes associated with a specific operating cost period identified by the provided periodId, enabling users to access relevant documentation for financial analysis and decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
periodId |
path |
integer(int64) |
true |
Unique identifier for the period |
archived |
query |
boolean |
false |
Indicates whether the notes for the specified operating cost period are archived, allowing users to filter and retrieve only relevant information. |
page |
query |
integer(int32) |
false |
Page number for pagination |
size |
query |
integer(int32) |
false |
Number of items per page |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
archived |
|
query |
page |
|
query |
size |
|
query |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "page": {
3 "size": 0,
4 "totalElements": 0,
5 "totalPages": 0,
6 "number": 0
7 },
8 "content": [
9 {
10 "createdBy": "string",
11 "lastModifiedBy": "string",
12 "createdDate": "2019-08-24T14:15:22Z",
13 "lastModifiedDate": "2019-08-24T14:15:22Z",
14 "archived": true,
15 "externalId": "string",
16 "id": 0,
17 "message": "string",
18 "userIds": [
19 0
20 ],
21 "redirectUrl": "string"
22 }
23 ],
24 "_embedded": {
25 "property1": {},
26 "property2": {}
27 },
28 "_links": {
29 "property1": {},
30 "property2": {}
31 }
32}
Create Notes¶
HTTP Request
POST /api/operating-cost-periods/{periodId}/notes
📋 Description: Adds a new note to the specified operating cost period, enhancing the documentation and tracking of financial insights associated with that period.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
periodId |
path |
integer(int64) |
true |
Unique identifier for the period |
body |
body |
true |
Request body containing detailed notes related to the specified operating cost period, including relevant context and annotations for enhanced financial analysis. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a note within the system, encapsulating key information such as content, author, and timestamps for effective collaboration and record-keeping.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Indicates whether the note has been archived, reflecting its current status in the system. |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» message |
string |
true |
none |
Textual content of the note, providing essential information or context related to the associated record. |
» userIds |
[integer] |
false |
none |
An array of unique identifiers representing the users associated with the specific note, facilitating efficient tracking and management of user-related information. |
» redirectUrl |
string |
false |
none |
URL to which users will be redirected after completing an action, ensuring a seamless transition within the application. |
Archive Note¶
HTTP Request
POST /api/notes/{id}/archive
📋 Description: Archives a specified note, effectively removing it from the active list and preserving it for future reference. This operation helps maintain organization and streamline note management within the application.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "message": "string",
10 "userIds": [
11 0
12 ],
13 "redirectUrl": "string"
14}
Get Operating Cost Periods¶
HTTP Request
GET /api/locations/{locationId}/operating-cost-periods
📋 Description: Retrieves the operating cost periods associated with a specific location, enabling users to analyze financial performance and operational efficiency over defined timeframes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
archived |
query |
boolean |
false |
Indicates whether to include archived operating cost periods for the specified location in the response. |
sort |
query |
array[string] |
false |
Sort order specification |
page |
query |
integer(int32) |
false |
Page number for pagination |
size |
query |
integer(int32) |
false |
Number of items per page |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
archived |
|
query |
page |
|
query |
size |
|
query |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "page": {
3 "size": 0,
4 "totalElements": 0,
5 "totalPages": 0,
6 "number": 0
7 },
8 "content": [
9 {
10 "createdBy": "string",
11 "lastModifiedBy": "string",
12 "createdDate": "2019-08-24T14:15:22Z",
13 "lastModifiedDate": "2019-08-24T14:15:22Z",
14 "archived": true,
15 "externalId": "string",
16 "id": 0,
17 "startDate": "2019-08-24",
18 "endDate": "2019-08-24",
19 "year": 1950,
20 "statusId": 0,
21 "expenses": [
22 {
23 "createdBy": "string",
24 "lastModifiedBy": "string",
25 "createdDate": "2019-08-24T14:15:22Z",
26 "lastModifiedDate": "2019-08-24T14:15:22Z",
27 "archived": true,
28 "externalId": "string",
29 "id": 0,
30 "operatingCostExpenseTypeId": 0,
31 "amount": 0,
32 "revisedAmount": 0,
33 "considerRevisedAmount": true,
34 "operatingCostExpenseType": {
35 "createdBy": "string",
36 "lastModifiedBy": "string",
37 "createdDate": "2019-08-24T14:15:22Z",
38 "lastModifiedDate": "2019-08-24T14:15:22Z",
39 "archived": true,
40 "externalId": "string",
41 "id": 0,
42 "priority": 0,
43 "internalId": 0,
44 "pickListCode": "string",
45 "pickListLabel": "string",
46 "label": "string",
47 "cultureId": 0,
48 "labelDtos": [
49 {
50 "createdBy": "string",
51 "lastModifiedBy": "string",
52 "createdDate": "2019-08-24T14:15:22Z",
53 "lastModifiedDate": "2019-08-24T14:15:22Z",
54 "archived": true,
55 "externalId": "string",
56 "id": 0,
57 "cultureId": 0,
58 "value": "string"
59 }
60 ]
61 },
62 "expenseGroup": {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "priority": 0,
71 "internalId": 0,
72 "pickListCode": "string",
73 "pickListLabel": "string",
74 "label": "string",
75 "cultureId": 0,
76 "labelDtos": [
77 {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "cultureId": 0,
86 "value": "string"
87 }
88 ]
89 }
90 }
91 ],
92 "status": {
93 "createdBy": "string",
94 "lastModifiedBy": "string",
95 "createdDate": "2019-08-24T14:15:22Z",
96 "lastModifiedDate": "2019-08-24T14:15:22Z",
97 "archived": true,
98 "externalId": "string",
99 "id": 0,
100 "priority": 0,
101 "internalId": 0,
102 "pickListCode": "string",
103 "pickListLabel": "string",
104 "label": "string",
105 "cultureId": 0,
106 "labelDtos": [
107 {
108 "createdBy": "string",
109 "lastModifiedBy": "string",
110 "createdDate": "2019-08-24T14:15:22Z",
111 "lastModifiedDate": "2019-08-24T14:15:22Z",
112 "archived": true,
113 "externalId": "string",
114 "id": 0,
115 "cultureId": 0,
116 "value": "string"
117 }
118 ]
119 },
120 "leaseReconciliationPeriods": [
121 {
122 "createdBy": "string",
123 "lastModifiedBy": "string",
124 "createdDate": "2019-08-24T14:15:22Z",
125 "lastModifiedDate": "2019-08-24T14:15:22Z",
126 "archived": true,
127 "externalId": "string",
128 "id": 0,
129 "startDate": "2019-08-24",
130 "endDate": "2019-08-24",
131 "statusId": 0,
132 "invoiceAmount": 0,
133 "receivedDate": "2019-08-24",
134 "acceptedAmount": 0,
135 "reviewedBy": "string",
136 "reviewedDate": "2019-08-24",
137 "fullReconciliation": true,
138 "status": {
139 "createdBy": "string",
140 "lastModifiedBy": "string",
141 "createdDate": "2019-08-24T14:15:22Z",
142 "lastModifiedDate": "2019-08-24T14:15:22Z",
143 "archived": true,
144 "externalId": "string",
145 "id": 0,
146 "priority": 0,
147 "internalId": 0,
148 "pickListCode": "string",
149 "pickListLabel": "string",
150 "label": "string",
151 "cultureId": 0,
152 "labelDtos": [
153 {
154 "createdBy": "string",
155 "lastModifiedBy": "string",
156 "createdDate": "2019-08-24T14:15:22Z",
157 "lastModifiedDate": "2019-08-24T14:15:22Z",
158 "archived": true,
159 "externalId": "string",
160 "id": 0,
161 "cultureId": 0,
162 "value": "string"
163 }
164 ]
165 },
166 "operatingCostPeriodId": 0,
167 "reconciledExpenseCategoryDtos": [
168 {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "expenseGroupId": 0,
177 "totalCost": 0,
178 "accrualAmount": 0,
179 "balance": 0,
180 "expenseGroup": {
181 "createdBy": "string",
182 "lastModifiedBy": "string",
183 "createdDate": "2019-08-24T14:15:22Z",
184 "lastModifiedDate": "2019-08-24T14:15:22Z",
185 "archived": true,
186 "externalId": "string",
187 "id": 0,
188 "priority": 0,
189 "internalId": 0,
190 "pickListCode": "string",
191 "pickListLabel": "string",
192 "label": "string",
193 "cultureId": 0,
194 "labelDtos": [
195 {
196 "createdBy": "string",
197 "lastModifiedBy": "string",
198 "createdDate": "2019-08-24T14:15:22Z",
199 "lastModifiedDate": "2019-08-24T14:15:22Z",
200 "archived": true,
201 "externalId": "string",
202 "id": 0,
203 "cultureId": 0,
204 "value": "string"
205 }
206 ]
207 },
208 "reconciledExpenseDtos": [
209 {
210 "createdBy": "string",
211 "lastModifiedBy": "string",
212 "createdDate": "2019-08-24T14:15:22Z",
213 "lastModifiedDate": "2019-08-24T14:15:22Z",
214 "archived": true,
215 "externalId": "string",
216 "id": 0,
217 "totalCost": 0,
218 "operatingCostExpenseTypeId": 0,
219 "operatingCostExpenseType": {
220 "createdBy": "string",
221 "lastModifiedBy": "string",
222 "createdDate": "2019-08-24T14:15:22Z",
223 "lastModifiedDate": "2019-08-24T14:15:22Z",
224 "archived": true,
225 "externalId": "string",
226 "id": 0,
227 "priority": 0,
228 "internalId": 0,
229 "pickListCode": "string",
230 "pickListLabel": "string",
231 "label": "string",
232 "cultureId": 0,
233 "labelDtos": []
234 },
235 "reconciledExpenseSegmentDtos": [
236 {}
237 ]
238 }
239 ],
240 "hasWarning": true
241 }
242 ]
243 }
244 ]
245 }
246 ],
247 "_embedded": {
248 "property1": {},
249 "property2": {}
250 },
251 "_links": {
252 "property1": {},
253 "property2": {}
254 }
255}
Create Operating Cost Periods¶
HTTP Request
POST /api/locations/{locationId}/operating-cost-periods
📋 Description: Creates a new operating cost period for the specified location, enabling businesses to effectively manage and track their operational expenses over defined timeframes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
locationId |
path |
integer(int64) |
true |
Unique identifier for the location |
body |
body |
true |
Request body containing the operating cost period details, including start and end dates, cost estimates, and associated metadata for the specified location. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "startDate": "2019-08-24",
11 "endDate": "2019-08-24",
12 "year": 1950,
13 "statusId": 0,
14 "expenses": [
15 {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "operatingCostExpenseTypeId": 0,
24 "amount": 0,
25 "revisedAmount": 0,
26 "considerRevisedAmount": true,
27 "operatingCostExpenseType": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "expenseGroup": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 }
83 }
84 ],
85 "status": {
86 "createdBy": "string",
87 "lastModifiedBy": "string",
88 "createdDate": "2019-08-24T14:15:22Z",
89 "lastModifiedDate": "2019-08-24T14:15:22Z",
90 "archived": true,
91 "externalId": "string",
92 "id": 0,
93 "priority": 0,
94 "internalId": 0,
95 "pickListCode": "string",
96 "pickListLabel": "string",
97 "label": "string",
98 "cultureId": 0,
99 "labelDtos": [
100 {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "cultureId": 0,
109 "value": "string"
110 }
111 ]
112 },
113 "leaseReconciliationPeriods": [
114 {
115 "createdBy": "string",
116 "lastModifiedBy": "string",
117 "createdDate": "2019-08-24T14:15:22Z",
118 "lastModifiedDate": "2019-08-24T14:15:22Z",
119 "archived": true,
120 "externalId": "string",
121 "id": 0,
122 "startDate": "2019-08-24",
123 "endDate": "2019-08-24",
124 "statusId": 0,
125 "invoiceAmount": 0,
126 "receivedDate": "2019-08-24",
127 "acceptedAmount": 0,
128 "reviewedBy": "string",
129 "reviewedDate": "2019-08-24",
130 "fullReconciliation": true,
131 "status": {
132 "createdBy": "string",
133 "lastModifiedBy": "string",
134 "createdDate": "2019-08-24T14:15:22Z",
135 "lastModifiedDate": "2019-08-24T14:15:22Z",
136 "archived": true,
137 "externalId": "string",
138 "id": 0,
139 "priority": 0,
140 "internalId": 0,
141 "pickListCode": "string",
142 "pickListLabel": "string",
143 "label": "string",
144 "cultureId": 0,
145 "labelDtos": [
146 {
147 "createdBy": "string",
148 "lastModifiedBy": "string",
149 "createdDate": "2019-08-24T14:15:22Z",
150 "lastModifiedDate": "2019-08-24T14:15:22Z",
151 "archived": true,
152 "externalId": "string",
153 "id": 0,
154 "cultureId": 0,
155 "value": "string"
156 }
157 ]
158 },
159 "operatingCostPeriodId": 0,
160 "reconciledExpenseCategoryDtos": [
161 {
162 "createdBy": "string",
163 "lastModifiedBy": "string",
164 "createdDate": "2019-08-24T14:15:22Z",
165 "lastModifiedDate": "2019-08-24T14:15:22Z",
166 "archived": true,
167 "externalId": "string",
168 "id": 0,
169 "expenseGroupId": 0,
170 "totalCost": 0,
171 "accrualAmount": 0,
172 "balance": 0,
173 "expenseGroup": {
174 "createdBy": "string",
175 "lastModifiedBy": "string",
176 "createdDate": "2019-08-24T14:15:22Z",
177 "lastModifiedDate": "2019-08-24T14:15:22Z",
178 "archived": true,
179 "externalId": "string",
180 "id": 0,
181 "priority": 0,
182 "internalId": 0,
183 "pickListCode": "string",
184 "pickListLabel": "string",
185 "label": "string",
186 "cultureId": 0,
187 "labelDtos": [
188 {
189 "createdBy": "string",
190 "lastModifiedBy": "string",
191 "createdDate": "2019-08-24T14:15:22Z",
192 "lastModifiedDate": "2019-08-24T14:15:22Z",
193 "archived": true,
194 "externalId": "string",
195 "id": 0,
196 "cultureId": 0,
197 "value": "string"
198 }
199 ]
200 },
201 "reconciledExpenseDtos": [
202 {
203 "createdBy": "string",
204 "lastModifiedBy": "string",
205 "createdDate": "2019-08-24T14:15:22Z",
206 "lastModifiedDate": "2019-08-24T14:15:22Z",
207 "archived": true,
208 "externalId": "string",
209 "id": 0,
210 "totalCost": 0,
211 "operatingCostExpenseTypeId": 0,
212 "operatingCostExpenseType": {
213 "createdBy": "string",
214 "lastModifiedBy": "string",
215 "createdDate": "2019-08-24T14:15:22Z",
216 "lastModifiedDate": "2019-08-24T14:15:22Z",
217 "archived": true,
218 "externalId": "string",
219 "id": 0,
220 "priority": 0,
221 "internalId": 0,
222 "pickListCode": "string",
223 "pickListLabel": "string",
224 "label": "string",
225 "cultureId": 0,
226 "labelDtos": [
227 {}
228 ]
229 },
230 "reconciledExpenseSegmentDtos": [
231 {
232 "createdBy": "string",
233 "lastModifiedBy": "string",
234 "createdDate": "2019-08-24T14:15:22Z",
235 "lastModifiedDate": "2019-08-24T14:15:22Z",
236 "archived": true,
237 "externalId": "string",
238 "id": 0,
239 "startDate": "2019-08-24",
240 "endDate": "2019-08-24",
241 "adjustedLocationCost": 0,
242 "proSharePercentage": 0,
243 "proShareCost": 0,
244 "cap": 0,
245 "subtotalCost": 0,
246 "adminFees": 0,
247 "totalCost": 0,
248 "conditionDto": {}
249 }
250 ]
251 }
252 ],
253 "hasWarning": true
254 }
255 ]
256 }
257 ]
258 }
259]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "startDate": "2019-08-24",
11 "endDate": "2019-08-24",
12 "year": 1950,
13 "statusId": 0,
14 "expenses": [
15 {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "operatingCostExpenseTypeId": 0,
24 "amount": 0,
25 "revisedAmount": 0,
26 "considerRevisedAmount": true,
27 "operatingCostExpenseType": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "expenseGroup": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 }
83 }
84 ],
85 "status": {
86 "createdBy": "string",
87 "lastModifiedBy": "string",
88 "createdDate": "2019-08-24T14:15:22Z",
89 "lastModifiedDate": "2019-08-24T14:15:22Z",
90 "archived": true,
91 "externalId": "string",
92 "id": 0,
93 "priority": 0,
94 "internalId": 0,
95 "pickListCode": "string",
96 "pickListLabel": "string",
97 "label": "string",
98 "cultureId": 0,
99 "labelDtos": [
100 {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "cultureId": 0,
109 "value": "string"
110 }
111 ]
112 },
113 "leaseReconciliationPeriods": [
114 {
115 "createdBy": "string",
116 "lastModifiedBy": "string",
117 "createdDate": "2019-08-24T14:15:22Z",
118 "lastModifiedDate": "2019-08-24T14:15:22Z",
119 "archived": true,
120 "externalId": "string",
121 "id": 0,
122 "startDate": "2019-08-24",
123 "endDate": "2019-08-24",
124 "statusId": 0,
125 "invoiceAmount": 0,
126 "receivedDate": "2019-08-24",
127 "acceptedAmount": 0,
128 "reviewedBy": "string",
129 "reviewedDate": "2019-08-24",
130 "fullReconciliation": true,
131 "status": {
132 "createdBy": "string",
133 "lastModifiedBy": "string",
134 "createdDate": "2019-08-24T14:15:22Z",
135 "lastModifiedDate": "2019-08-24T14:15:22Z",
136 "archived": true,
137 "externalId": "string",
138 "id": 0,
139 "priority": 0,
140 "internalId": 0,
141 "pickListCode": "string",
142 "pickListLabel": "string",
143 "label": "string",
144 "cultureId": 0,
145 "labelDtos": [
146 {
147 "createdBy": "string",
148 "lastModifiedBy": "string",
149 "createdDate": "2019-08-24T14:15:22Z",
150 "lastModifiedDate": "2019-08-24T14:15:22Z",
151 "archived": true,
152 "externalId": "string",
153 "id": 0,
154 "cultureId": 0,
155 "value": "string"
156 }
157 ]
158 },
159 "operatingCostPeriodId": 0,
160 "reconciledExpenseCategoryDtos": [
161 {
162 "createdBy": "string",
163 "lastModifiedBy": "string",
164 "createdDate": "2019-08-24T14:15:22Z",
165 "lastModifiedDate": "2019-08-24T14:15:22Z",
166 "archived": true,
167 "externalId": "string",
168 "id": 0,
169 "expenseGroupId": 0,
170 "totalCost": 0,
171 "accrualAmount": 0,
172 "balance": 0,
173 "expenseGroup": {
174 "createdBy": "string",
175 "lastModifiedBy": "string",
176 "createdDate": "2019-08-24T14:15:22Z",
177 "lastModifiedDate": "2019-08-24T14:15:22Z",
178 "archived": true,
179 "externalId": "string",
180 "id": 0,
181 "priority": 0,
182 "internalId": 0,
183 "pickListCode": "string",
184 "pickListLabel": "string",
185 "label": "string",
186 "cultureId": 0,
187 "labelDtos": [
188 {
189 "createdBy": "string",
190 "lastModifiedBy": "string",
191 "createdDate": "2019-08-24T14:15:22Z",
192 "lastModifiedDate": "2019-08-24T14:15:22Z",
193 "archived": true,
194 "externalId": "string",
195 "id": 0,
196 "cultureId": 0,
197 "value": "string"
198 }
199 ]
200 },
201 "reconciledExpenseDtos": [
202 {
203 "createdBy": "string",
204 "lastModifiedBy": "string",
205 "createdDate": "2019-08-24T14:15:22Z",
206 "lastModifiedDate": "2019-08-24T14:15:22Z",
207 "archived": true,
208 "externalId": "string",
209 "id": 0,
210 "totalCost": 0,
211 "operatingCostExpenseTypeId": 0,
212 "operatingCostExpenseType": {
213 "createdBy": "string",
214 "lastModifiedBy": "string",
215 "createdDate": "2019-08-24T14:15:22Z",
216 "lastModifiedDate": "2019-08-24T14:15:22Z",
217 "archived": true,
218 "externalId": "string",
219 "id": 0,
220 "priority": 0,
221 "internalId": 0,
222 "pickListCode": "string",
223 "pickListLabel": "string",
224 "label": "string",
225 "cultureId": 0,
226 "labelDtos": [
227 {}
228 ]
229 },
230 "reconciledExpenseSegmentDtos": [
231 {
232 "createdBy": "string",
233 "lastModifiedBy": "string",
234 "createdDate": "2019-08-24T14:15:22Z",
235 "lastModifiedDate": "2019-08-24T14:15:22Z",
236 "archived": true,
237 "externalId": "string",
238 "id": 0,
239 "startDate": "2019-08-24",
240 "endDate": "2019-08-24",
241 "adjustedLocationCost": 0,
242 "proSharePercentage": 0,
243 "proShareCost": 0,
244 "cap": 0,
245 "subtotalCost": 0,
246 "adminFees": 0,
247 "totalCost": 0,
248 "conditionDto": {}
249 }
250 ]
251 }
252 ],
253 "hasWarning": true
254 }
255 ]
256 }
257 ]
258 }
259]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the operating cost period, encapsulating key financial metrics and timeframes essential for budget analysis and operational planning.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Indicates whether the operating cost period has been archived, reflecting its status in the financial management lifecycle. |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» year |
integer(int32) |
false |
none |
Represents the fiscal year associated with the operating cost period, enabling accurate financial analysis and reporting. |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
» expenses |
false |
none |
An array of operating cost periods that outlines the various expenses incurred during a specified timeframe, facilitating comprehensive financial analysis and budgeting. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Indicates whether the operating cost period expense has been archived, reflecting its status within the financial records. |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» operatingCostExpenseTypeId |
integer(int64) |
false |
none |
Unique identifier for the operating cost expense type |
»» amount |
number |
true |
none |
Amount value |
»» revisedAmount |
number |
false |
none |
Amount of revised |
»» considerRevisedAmount |
boolean |
false |
none |
Amount of consider revised |
»» operatingCostExpenseType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Indicates whether the pick list option has been archived, allowing for effective management of active and inactive options within the system. |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»»» pickListCode |
string |
false |
none |
Code for the pick list |
»»» pickListLabel |
string |
false |
none |
Label for the pick list |
»»» label |
string |
false |
none |
Label for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» labelDtos |
false |
none |
An array of pick list options that allows users to select and categorize relevant data points within the application. |
|
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»» archived |
boolean |
false |
none |
Indicates whether the label has been archived, reflecting its current status within the system. |
»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»»» value |
string |
true |
none |
Represents the textual value associated with the label, providing essential context for categorization and identification within the system. |
»» expenseGroup |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
» status |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
» leaseReconciliationPeriods |
false |
none |
An array of operating cost periods used for lease reconciliation, providing detailed insights into the financial adjustments associated with lease agreements. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Indicates whether the lease reconciliation period has been archived, reflecting its status within the lease management process. |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» endDate |
string(date) |
false |
none |
End date of the resource |
»» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
»» invoiceAmount |
number |
false |
none |
Amount of invoice |
»» receivedDate |
string(date) |
false |
none |
Date of the received |
»» acceptedAmount |
number |
false |
none |
Amount of accepted |
»» reviewedBy |
string |
false |
none |
Identifier of the individual or entity that has reviewed the lease reconciliation period, ensuring accountability and traceability in the review process. |
»» reviewedDate |
string(date) |
false |
none |
Date of the reviewed |
»» fullReconciliation |
boolean |
false |
none |
Indicates whether a complete reconciliation of lease transactions is required for the specified period. |
»» status |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
»» operatingCostPeriodId |
integer(int64) |
false |
none |
Unique identifier for the operating cost period |
»» reconciledExpenseCategoryDtos |
false |
none |
An array of reconciled expense category data transfer objects that represent the categorized expenses for each lease reconciliation period. |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Indicates whether the reconciled expense category has been archived, reflecting its current status within the financial management system. |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» expenseGroupId |
integer(int64) |
false |
none |
Unique identifier for the expense group |
»»» totalCost |
number |
false |
none |
Total cost associated with the reconciled expense category, providing a comprehensive overview of expenditures for financial analysis and reporting. |
»»» accrualAmount |
number |
false |
none |
Amount of accrual |
»»» balance |
number |
false |
none |
Represents the total balance of expenses within the reconciled expense category, providing insight into financial standing for effective budget management. |
»»» expenseGroup |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
»»» reconciledExpenseDtos |
false |
none |
An array of reconciled expense category data transfer objects that represent the categorized expenses that have been verified and reconciled for accurate financial reporting. |
|
»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»» archived |
boolean |
false |
none |
Indicates whether the reconciled expense has been archived, reflecting its status in the financial records. |
»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»» totalCost |
number |
false |
none |
TotalCost represents the cumulative financial expenditure associated with the reconciled expense, providing essential insights for budget management and financial analysis. |
»»»» operatingCostExpenseTypeId |
integer(int64) |
false |
none |
Unique identifier for the operating cost expense type |
»»»» operatingCostExpenseType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
»»»» reconciledExpenseSegmentDtos |
false |
none |
An array of reconciled expense segments, each represented by a ReconciledExpenseDto, providing detailed insights into the categorized expenses for accurate financial reporting and analysis. |
|
»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»» archived |
boolean |
false |
none |
Indicates whether the reconciled expense segment has been archived, reflecting its status in the financial records. |
»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»» startDate |
string(date) |
false |
none |
Start date of the resource |
»»»»» endDate |
string(date) |
false |
none |
End date of the resource |
»»»»» adjustedLocationCost |
number |
false |
none |
Represents the recalibrated cost associated with the location of a reconciled expense segment, providing critical financial insights for expense management. |
»»»»» proSharePercentage |
number |
false |
none |
Percentage of pro share |
»»»»» proShareCost |
number |
false |
none |
Represents the proportional share cost associated with a reconciled expense segment, facilitating accurate financial reporting and analysis. |
»»»»» cap |
number |
false |
none |
Represents the maximum allowable expense amount for a specific segment within the reconciled expense report. |
»»»»» subtotalCost |
number |
false |
none |
Represents the total cost of expenses before any applicable taxes or discounts, providing a clear view of the financial commitment associated with the reconciled expense segment. |
»»»»» adminFees |
number |
false |
none |
Represents the total administrative fees associated with the reconciled expense segment, providing clarity on cost allocations for financial reporting. |
»»»»» totalCost |
number |
false |
none |
Total cost representing the cumulative expenses associated with a reconciled expense segment. |
»»»»» conditionDto |
false |
none |
Data transfer object representing the conditions associated with a lease agreement, including key terms and stipulations that govern the rental relationship between parties. |
|
»»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»»» archived |
boolean |
false |
none |
Indicates whether the lease condition has been archived, reflecting its current status within the lease management process. |
»»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»»» parentConditionId |
integer(int64) |
false |
none |
Unique identifier for the parent condition |
»»»»»» typeId |
integer(int64) |
false |
none |
Unique identifier for the type |
»»»»»» startDate |
string(date) |
false |
none |
Start date of the resource |
»»»»»» endDate |
string(date) |
false |
none |
End date of the resource |
»»»»»» replaceById |
integer(int64) |
false |
none |
Unique identifier for the replace by |
»»»»»» managedById |
integer(int64) |
false |
none |
Unique identifier for the managed by |
»»»»»» payById |
integer(int64) |
false |
none |
Unique identifier for the pay by |
»»»»»» adminFee |
number |
false |
none |
Represents the administrative fee associated with the lease agreement, facilitating accurate financial calculations and reporting. |
»»»»»» fixedIncreasePercentage |
number |
false |
none |
Percentage of fixed increase |
»»»»»» note |
string |
false |
none |
Textual remarks or observations related to the lease condition, providing additional context for stakeholders involved in lease management. |
»»»»»» pageNumber |
string |
false |
none |
Page number for pagination |
»»»»»» section |
string |
false |
none |
Specifies the section of the lease agreement that outlines the conditions applicable to the lease. |
»»»»»» type |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
»»»»»» replaceBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
»»»»»» managedBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
»»»»»» payBy |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
»»»»»» proShareDto |
any |
false |
none |
Data transfer object representing the lease conditions associated with the professional share agreement. |
oneOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a professional sharing initiative, encapsulating key details and metrics to facilitate collaboration and resource allocation within the organization. |
|
»»»»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»»»»» archived |
boolean |
false |
none |
Indicates whether the ProShare record has been archived, reflecting its current status within the system. |
»»»»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»»»»» type |
string |
true |
none |
Type of the resource |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing area-based professional sharing initiatives, encapsulating relevant details and metrics to facilitate collaboration and resource allocation within targeted regions. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a professional sharing initiative, encapsulating key details and metrics to facilitate collaboration and resource allocation within the organization. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» dividendAreaTypeId |
integer(int64) |
false |
none |
none |
»»»»»»»»» divisorAreaTypeId |
integer(int64) |
false |
none |
none |
»»»»»»»»» dividendAreaId |
integer(int64) |
false |
none |
none |
»»»»»»»»» divisorAreaId |
integer(int64) |
false |
none |
none |
»»»»»»»»» dividendAreaType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
|
»»»»»»»»» divisorAreaType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and selecting predefined values in business processes, enhancing data consistency and user experience. |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a fixed percentage profit-sharing arrangement, detailing the allocation of profits among stakeholders within a business context. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a professional sharing initiative, encapsulating key details and metrics to facilitate collaboration and resource allocation within the organization. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» fixedPercentage |
number |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»» capDto |
any |
false |
none |
Represents the lease conditions associated with the asset, providing essential details for effective lease management. |
oneOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a Customer Account Profile, encapsulating essential details and attributes related to customer interactions and account management. |
|
»»»»»»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»»»»»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»»»»»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»»»»»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»»»»»»» archived |
boolean |
false |
none |
Indicates whether the associated record has been archived, reflecting its current status within the system. |
»»»»»»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»»»»»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»»»»»»» type |
string |
true |
none |
Type of the resource |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing a fixed capital asset, including its valuation, depreciation, and associated metadata, essential for financial reporting and asset management. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a Customer Account Profile, encapsulating essential details and attributes related to customer interactions and account management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» amount |
number |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing the core attributes and operational parameters of the OverBase Capital Allocation Process, facilitating efficient management and tracking of capital allocation decisions within the organization. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a Customer Account Profile, encapsulating essential details and attributes related to customer interactions and account management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» baseYear |
integer(int32) |
false |
none |
none |
»»»»»»»»» baseAmount |
number |
false |
none |
none |
»»»»»»»»» maxIncreasePercentage |
number |
false |
none |
none |
»»»»»»»»» cumulative |
boolean |
false |
none |
none |
xor
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»» anonymous |
false |
none |
Data transfer object representing the annual capital allocation plan, detailing financial projections and resource distribution for effective budget management and strategic planning. |
allOf - discriminator: type
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
false |
none |
Data transfer object representing a Customer Account Profile, encapsulating essential details and attributes related to customer interactions and account management. |
and
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»»»»»»» anonymous |
object |
false |
none |
none |
»»»»»»»»» baseYear |
integer(int32) |
false |
none |
none |
»»»»»»»»» baseAmount |
number |
false |
none |
none |
»»»»»»»»» maxIncreasePercentage |
number |
false |
none |
none |
»»»»»»»»» cumulative |
boolean |
false |
none |
none |
continued
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
»»» hasWarning |
boolean |
false |
none |
Whether the resource has has warning |
Delete Operating Cost Period¶
HTTP Request
DELETE /api/operating-cost-periods/{id}
📋 Description: Deletes a specified operating cost period, allowing for the removal of outdated or incorrect entries from the system, thereby ensuring accurate financial reporting and management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |