LocationDto¶
Example Json Object
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 "number": "string",
10 "name": "string",
11 "storeNumber": "string",
12 "defaultCurrencyId": 0,
13 "defaultMeasureId": 0,
14 "typeId": 0,
15 "qualityId": 0,
16 "propertyTypeId": 0,
17 "categoryId": 0,
18 "statusId": 0,
19 "businessUnitId": 0,
20 "groupIds": [
21 0
22 ],
23 "legalEntityIds": [
24 0
25 ],
26 "defaultCurrency": {
27 "id": 0,
28 "status": "CREATED",
29 "displayId": "string",
30 "erpSystemId": 0,
31 "erpSystemDisplayId": "string",
32 "name": "string",
33 "decimalPoints": 0,
34 "depreciationAreaId": 0
35 },
36 "defaultUnitValue": {
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 "unitId": 0,
45 "unitOfMeasureId": 0,
46 "erpSystemId": 0,
47 "unit": {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "priority": 0,
56 "internalId": 0,
57 "pickListCode": "string",
58 "pickListLabel": "string",
59 "label": "string",
60 "cultureId": 0,
61 "labelDtos": [
62 {
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 "cultureId": 0,
71 "value": "string"
72 }
73 ]
74 },
75 "unitOfMeasure": {
76 "id": 0,
77 "status": "CREATED",
78 "displayId": "string",
79 "erpSystemId": 0,
80 "erpSystemDisplayId": "string",
81 "name": "string"
82 }
83 },
84 "type": {
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 "quality": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "propertyType": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "category": {
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 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "status": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "priority": 0,
205 "internalId": 0,
206 "pickListCode": "string",
207 "pickListLabel": "string",
208 "label": "string",
209 "cultureId": 0,
210 "labelDtos": [
211 {
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 "cultureId": 0,
220 "value": "string"
221 }
222 ]
223 },
224 "addressDto": {
225 "createdBy": "string",
226 "lastModifiedBy": "string",
227 "createdDate": "2019-08-24T14:15:22Z",
228 "lastModifiedDate": "2019-08-24T14:15:22Z",
229 "archived": true,
230 "externalId": "string",
231 "id": 0,
232 "street": "string",
233 "civicNumber": "string",
234 "suite": "string",
235 "postalCode": "string",
236 "lon": 0.1,
237 "lat": 0.1,
238 "city": {
239 "createdBy": "string",
240 "lastModifiedBy": "string",
241 "createdDate": "2019-08-24T14:15:22Z",
242 "lastModifiedDate": "2019-08-24T14:15:22Z",
243 "archived": true,
244 "externalId": "string",
245 "id": 0,
246 "name": "string",
247 "province": {
248 "createdBy": "string",
249 "lastModifiedBy": "string",
250 "createdDate": "2019-08-24T14:15:22Z",
251 "lastModifiedDate": "2019-08-24T14:15:22Z",
252 "archived": true,
253 "externalId": "string",
254 "id": 0,
255 "name": "string",
256 "code": "string",
257 "country": {
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 "name": "string",
266 "code": "string"
267 },
268 "provinceCountryKey": "string"
269 },
270 "cityProvinceCountryKey": "string"
271 },
272 "district": {
273 "createdBy": "string",
274 "lastModifiedBy": "string",
275 "createdDate": "2019-08-24T14:15:22Z",
276 "lastModifiedDate": "2019-08-24T14:15:22Z",
277 "archived": true,
278 "externalId": "string",
279 "id": 0,
280 "name": "string",
281 "city": {
282 "createdBy": "string",
283 "lastModifiedBy": "string",
284 "createdDate": "2019-08-24T14:15:22Z",
285 "lastModifiedDate": "2019-08-24T14:15:22Z",
286 "archived": true,
287 "externalId": "string",
288 "id": 0,
289 "name": "string",
290 "province": {
291 "createdBy": "string",
292 "lastModifiedBy": "string",
293 "createdDate": "2019-08-24T14:15:22Z",
294 "lastModifiedDate": "2019-08-24T14:15:22Z",
295 "archived": true,
296 "externalId": "string",
297 "id": 0,
298 "name": "string",
299 "code": "string",
300 "country": {
301 "createdBy": "string",
302 "lastModifiedBy": "string",
303 "createdDate": "2019-08-24T14:15:22Z",
304 "lastModifiedDate": "2019-08-24T14:15:22Z",
305 "archived": true,
306 "externalId": "string",
307 "id": 0,
308 "name": "string",
309 "code": "string"
310 },
311 "provinceCountryKey": "string"
312 },
313 "cityProvinceCountryKey": "string"
314 }
315 },
316 "cityId": 0,
317 "districtId": 0
318 },
319 "secondAddressDto": {
320 "createdBy": "string",
321 "lastModifiedBy": "string",
322 "createdDate": "2019-08-24T14:15:22Z",
323 "lastModifiedDate": "2019-08-24T14:15:22Z",
324 "archived": true,
325 "externalId": "string",
326 "id": 0,
327 "street": "string",
328 "civicNumber": "string",
329 "suite": "string",
330 "postalCode": "string",
331 "lon": 0.1,
332 "lat": 0.1,
333 "city": {
334 "createdBy": "string",
335 "lastModifiedBy": "string",
336 "createdDate": "2019-08-24T14:15:22Z",
337 "lastModifiedDate": "2019-08-24T14:15:22Z",
338 "archived": true,
339 "externalId": "string",
340 "id": 0,
341 "name": "string",
342 "province": {
343 "createdBy": "string",
344 "lastModifiedBy": "string",
345 "createdDate": "2019-08-24T14:15:22Z",
346 "lastModifiedDate": "2019-08-24T14:15:22Z",
347 "archived": true,
348 "externalId": "string",
349 "id": 0,
350 "name": "string",
351 "code": "string",
352 "country": {
353 "createdBy": "string",
354 "lastModifiedBy": "string",
355 "createdDate": "2019-08-24T14:15:22Z",
356 "lastModifiedDate": "2019-08-24T14:15:22Z",
357 "archived": true,
358 "externalId": "string",
359 "id": 0,
360 "name": "string",
361 "code": "string"
362 },
363 "provinceCountryKey": "string"
364 },
365 "cityProvinceCountryKey": "string"
366 },
367 "district": {
368 "createdBy": "string",
369 "lastModifiedBy": "string",
370 "createdDate": "2019-08-24T14:15:22Z",
371 "lastModifiedDate": "2019-08-24T14:15:22Z",
372 "archived": true,
373 "externalId": "string",
374 "id": 0,
375 "name": "string",
376 "city": {
377 "createdBy": "string",
378 "lastModifiedBy": "string",
379 "createdDate": "2019-08-24T14:15:22Z",
380 "lastModifiedDate": "2019-08-24T14:15:22Z",
381 "archived": true,
382 "externalId": "string",
383 "id": 0,
384 "name": "string",
385 "province": {
386 "createdBy": "string",
387 "lastModifiedBy": "string",
388 "createdDate": "2019-08-24T14:15:22Z",
389 "lastModifiedDate": "2019-08-24T14:15:22Z",
390 "archived": true,
391 "externalId": "string",
392 "id": 0,
393 "name": "string",
394 "code": "string",
395 "country": {
396 "createdBy": "string",
397 "lastModifiedBy": "string",
398 "createdDate": "2019-08-24T14:15:22Z",
399 "lastModifiedDate": "2019-08-24T14:15:22Z",
400 "archived": true,
401 "externalId": "string",
402 "id": 0,
403 "name": "string",
404 "code": "string"
405 },
406 "provinceCountryKey": "string"
407 },
408 "cityProvinceCountryKey": "string"
409 }
410 },
411 "cityId": 0,
412 "districtId": 0
413 }
414}
📄 Description: Data transfer object representing a geographic location, encapsulating essential attributes such as coordinates, address details, and associated metadata for effective spatial analysis and decision-making.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
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 location 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 |
number |
string |
false |
none |
Represents the contact number associated with the location, facilitating communication and operational coordination. |
name |
string |
true |
none |
Name of the resource |
storeNumber |
string |
false |
none |
Unique identifier for the store, facilitating efficient tracking and management of retail locations within the system. |
defaultCurrencyId |
integer(int64) |
true |
none |
Unique identifier for the default currency |
defaultMeasureId |
integer(int64) |
true |
none |
Unique identifier for the default measure |
typeId |
integer(int64) |
true |
none |
Unique identifier for the type |
qualityId |
integer(int64) |
false |
none |
Unique identifier for the quality |
propertyTypeId |
integer(int64) |
false |
none |
Unique identifier for the property type |
categoryId |
integer(int64) |
false |
none |
Unique identifier for the category |
statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
businessUnitId |
integer(int64) |
false |
none |
Unique identifier for the business unit |
groupIds |
[integer] |
false |
none |
Array of unique identifiers representing the groups associated with the specified location, facilitating efficient management and organization within the system. |
legalEntityIds |
[integer] |
false |
none |
An array of unique identifiers representing the legal entities associated with the location, facilitating compliance and regulatory tracking. |
defaultCurrency |
false |
none |
Specifies the default currency used for transactions and financial reporting within the specified location. |
|
defaultUnitValue |
false |
none |
Represents the default unit value associated with a specific location, facilitating standardized measurements across various operational processes. |
|
type |
false |
none |
Type of the resource |
|
quality |
false |
none |
Indicates the quality assessment of the location, providing insights for decision-making in resource allocation and operational efficiency. |
|
propertyType |
false |
none |
Type of the property |
|
category |
false |
none |
Category of the resource |
|
status |
false |
none |
Status of the resource |
|
addressDto |
true |
none |
Represents the location details associated with the entity, providing essential information for accurate address identification and management. |
|
secondAddressDto |
false |
none |
Represents an additional address associated with a location, facilitating comprehensive address management within the system. |