PremiseDto

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  "headPremise": true,
 12  "possessionDate": "2019-08-24",
 13  "openingDate": "2019-08-24",
 14  "closingDate": "2019-08-24",
 15  "relocationDate": "2019-08-24",
 16  "vacatingDate": "2019-08-24",
 17  "expansionDate": "2019-08-24",
 18  "statusId": 0,
 19  "usageId": 0,
 20  "parentPremiseId": 0,
 21  "costCenterId": 0,
 22  "profitCenterId": 0,
 23  "legalEntityId": 0,
 24  "occupancyIds": [
 25    0
 26  ],
 27  "locationId": 0,
 28  "locationDto": {
 29    "createdBy": "string",
 30    "lastModifiedBy": "string",
 31    "createdDate": "2019-08-24T14:15:22Z",
 32    "lastModifiedDate": "2019-08-24T14:15:22Z",
 33    "archived": true,
 34    "externalId": "string",
 35    "id": 0,
 36    "number": "string",
 37    "name": "string",
 38    "storeNumber": "string",
 39    "defaultCurrencyId": 0,
 40    "defaultMeasureId": 0,
 41    "typeId": 0,
 42    "qualityId": 0,
 43    "propertyTypeId": 0,
 44    "categoryId": 0,
 45    "statusId": 0,
 46    "businessUnitId": 0,
 47    "groupIds": [
 48      0
 49    ],
 50    "legalEntityIds": [
 51      0
 52    ],
 53    "defaultCurrency": {
 54      "id": 0,
 55      "status": "CREATED",
 56      "displayId": "string",
 57      "erpSystemId": 0,
 58      "erpSystemDisplayId": "string",
 59      "name": "string",
 60      "decimalPoints": 0,
 61      "depreciationAreaId": 0
 62    },
 63    "defaultUnitValue": {
 64      "createdBy": "string",
 65      "lastModifiedBy": "string",
 66      "createdDate": "2019-08-24T14:15:22Z",
 67      "lastModifiedDate": "2019-08-24T14:15:22Z",
 68      "archived": true,
 69      "externalId": "string",
 70      "id": 0,
 71      "unitId": 0,
 72      "unitOfMeasureId": 0,
 73      "erpSystemId": 0,
 74      "unit": {
 75        "createdBy": "string",
 76        "lastModifiedBy": "string",
 77        "createdDate": "2019-08-24T14:15:22Z",
 78        "lastModifiedDate": "2019-08-24T14:15:22Z",
 79        "archived": true,
 80        "externalId": "string",
 81        "id": 0,
 82        "priority": 0,
 83        "internalId": 0,
 84        "pickListCode": "string",
 85        "pickListLabel": "string",
 86        "label": "string",
 87        "cultureId": 0,
 88        "labelDtos": [
 89          {
 90            "createdBy": "string",
 91            "lastModifiedBy": "string",
 92            "createdDate": "2019-08-24T14:15:22Z",
 93            "lastModifiedDate": "2019-08-24T14:15:22Z",
 94            "archived": true,
 95            "externalId": "string",
 96            "id": 0,
 97            "cultureId": 0,
 98            "value": "string"
 99          }
100        ]
101      },
102      "unitOfMeasure": {
103        "id": 0,
104        "status": "CREATED",
105        "displayId": "string",
106        "erpSystemId": 0,
107        "erpSystemDisplayId": "string",
108        "name": "string"
109      }
110    },
111    "type": {
112      "createdBy": "string",
113      "lastModifiedBy": "string",
114      "createdDate": "2019-08-24T14:15:22Z",
115      "lastModifiedDate": "2019-08-24T14:15:22Z",
116      "archived": true,
117      "externalId": "string",
118      "id": 0,
119      "priority": 0,
120      "internalId": 0,
121      "pickListCode": "string",
122      "pickListLabel": "string",
123      "label": "string",
124      "cultureId": 0,
125      "labelDtos": [
126        {
127          "createdBy": "string",
128          "lastModifiedBy": "string",
129          "createdDate": "2019-08-24T14:15:22Z",
130          "lastModifiedDate": "2019-08-24T14:15:22Z",
131          "archived": true,
132          "externalId": "string",
133          "id": 0,
134          "cultureId": 0,
135          "value": "string"
136        }
137      ]
138    },
139    "quality": {
140      "createdBy": "string",
141      "lastModifiedBy": "string",
142      "createdDate": "2019-08-24T14:15:22Z",
143      "lastModifiedDate": "2019-08-24T14:15:22Z",
144      "archived": true,
145      "externalId": "string",
146      "id": 0,
147      "priority": 0,
148      "internalId": 0,
149      "pickListCode": "string",
150      "pickListLabel": "string",
151      "label": "string",
152      "cultureId": 0,
153      "labelDtos": [
154        {
155          "createdBy": "string",
156          "lastModifiedBy": "string",
157          "createdDate": "2019-08-24T14:15:22Z",
158          "lastModifiedDate": "2019-08-24T14:15:22Z",
159          "archived": true,
160          "externalId": "string",
161          "id": 0,
162          "cultureId": 0,
163          "value": "string"
164        }
165      ]
166    },
167    "propertyType": {
168      "createdBy": "string",
169      "lastModifiedBy": "string",
170      "createdDate": "2019-08-24T14:15:22Z",
171      "lastModifiedDate": "2019-08-24T14:15:22Z",
172      "archived": true,
173      "externalId": "string",
174      "id": 0,
175      "priority": 0,
176      "internalId": 0,
177      "pickListCode": "string",
178      "pickListLabel": "string",
179      "label": "string",
180      "cultureId": 0,
181      "labelDtos": [
182        {
183          "createdBy": "string",
184          "lastModifiedBy": "string",
185          "createdDate": "2019-08-24T14:15:22Z",
186          "lastModifiedDate": "2019-08-24T14:15:22Z",
187          "archived": true,
188          "externalId": "string",
189          "id": 0,
190          "cultureId": 0,
191          "value": "string"
192        }
193      ]
194    },
195    "category": {
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      "priority": 0,
204      "internalId": 0,
205      "pickListCode": "string",
206      "pickListLabel": "string",
207      "label": "string",
208      "cultureId": 0,
209      "labelDtos": [
210        {
211          "createdBy": "string",
212          "lastModifiedBy": "string",
213          "createdDate": "2019-08-24T14:15:22Z",
214          "lastModifiedDate": "2019-08-24T14:15:22Z",
215          "archived": true,
216          "externalId": "string",
217          "id": 0,
218          "cultureId": 0,
219          "value": "string"
220        }
221      ]
222    },
223    "status": {
224      "createdBy": "string",
225      "lastModifiedBy": "string",
226      "createdDate": "2019-08-24T14:15:22Z",
227      "lastModifiedDate": "2019-08-24T14:15:22Z",
228      "archived": true,
229      "externalId": "string",
230      "id": 0,
231      "priority": 0,
232      "internalId": 0,
233      "pickListCode": "string",
234      "pickListLabel": "string",
235      "label": "string",
236      "cultureId": 0,
237      "labelDtos": [
238        {
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          "cultureId": 0,
247          "value": "string"
248        }
249      ]
250    },
251    "addressDto": {
252      "createdBy": "string",
253      "lastModifiedBy": "string",
254      "createdDate": "2019-08-24T14:15:22Z",
255      "lastModifiedDate": "2019-08-24T14:15:22Z",
256      "archived": true,
257      "externalId": "string",
258      "id": 0,
259      "street": "string",
260      "civicNumber": "string",
261      "suite": "string",
262      "postalCode": "string",
263      "lon": 0.1,
264      "lat": 0.1,
265      "city": {
266        "createdBy": "string",
267        "lastModifiedBy": "string",
268        "createdDate": "2019-08-24T14:15:22Z",
269        "lastModifiedDate": "2019-08-24T14:15:22Z",
270        "archived": true,
271        "externalId": "string",
272        "id": 0,
273        "name": "string",
274        "province": {
275          "createdBy": "string",
276          "lastModifiedBy": "string",
277          "createdDate": "2019-08-24T14:15:22Z",
278          "lastModifiedDate": "2019-08-24T14:15:22Z",
279          "archived": true,
280          "externalId": "string",
281          "id": 0,
282          "name": "string",
283          "code": "string",
284          "country": {
285            "createdBy": "string",
286            "lastModifiedBy": "string",
287            "createdDate": "2019-08-24T14:15:22Z",
288            "lastModifiedDate": "2019-08-24T14:15:22Z",
289            "archived": true,
290            "externalId": "string",
291            "id": 0,
292            "name": "string",
293            "code": "string"
294          },
295          "provinceCountryKey": "string"
296        },
297        "cityProvinceCountryKey": "string"
298      },
299      "district": {
300        "createdBy": "string",
301        "lastModifiedBy": "string",
302        "createdDate": "2019-08-24T14:15:22Z",
303        "lastModifiedDate": "2019-08-24T14:15:22Z",
304        "archived": true,
305        "externalId": "string",
306        "id": 0,
307        "name": "string",
308        "city": {
309          "createdBy": "string",
310          "lastModifiedBy": "string",
311          "createdDate": "2019-08-24T14:15:22Z",
312          "lastModifiedDate": "2019-08-24T14:15:22Z",
313          "archived": true,
314          "externalId": "string",
315          "id": 0,
316          "name": "string",
317          "province": {
318            "createdBy": "string",
319            "lastModifiedBy": "string",
320            "createdDate": "2019-08-24T14:15:22Z",
321            "lastModifiedDate": "2019-08-24T14:15:22Z",
322            "archived": true,
323            "externalId": "string",
324            "id": 0,
325            "name": "string",
326            "code": "string",
327            "country": {
328              "createdBy": "string",
329              "lastModifiedBy": "string",
330              "createdDate": "2019-08-24T14:15:22Z",
331              "lastModifiedDate": "2019-08-24T14:15:22Z",
332              "archived": true,
333              "externalId": "string",
334              "id": 0,
335              "name": "string",
336              "code": "string"
337            },
338            "provinceCountryKey": "string"
339          },
340          "cityProvinceCountryKey": "string"
341        }
342      },
343      "cityId": 0,
344      "districtId": 0
345    },
346    "secondAddressDto": {
347      "createdBy": "string",
348      "lastModifiedBy": "string",
349      "createdDate": "2019-08-24T14:15:22Z",
350      "lastModifiedDate": "2019-08-24T14:15:22Z",
351      "archived": true,
352      "externalId": "string",
353      "id": 0,
354      "street": "string",
355      "civicNumber": "string",
356      "suite": "string",
357      "postalCode": "string",
358      "lon": 0.1,
359      "lat": 0.1,
360      "city": {
361        "createdBy": "string",
362        "lastModifiedBy": "string",
363        "createdDate": "2019-08-24T14:15:22Z",
364        "lastModifiedDate": "2019-08-24T14:15:22Z",
365        "archived": true,
366        "externalId": "string",
367        "id": 0,
368        "name": "string",
369        "province": {
370          "createdBy": "string",
371          "lastModifiedBy": "string",
372          "createdDate": "2019-08-24T14:15:22Z",
373          "lastModifiedDate": "2019-08-24T14:15:22Z",
374          "archived": true,
375          "externalId": "string",
376          "id": 0,
377          "name": "string",
378          "code": "string",
379          "country": {
380            "createdBy": "string",
381            "lastModifiedBy": "string",
382            "createdDate": "2019-08-24T14:15:22Z",
383            "lastModifiedDate": "2019-08-24T14:15:22Z",
384            "archived": true,
385            "externalId": "string",
386            "id": 0,
387            "name": "string",
388            "code": "string"
389          },
390          "provinceCountryKey": "string"
391        },
392        "cityProvinceCountryKey": "string"
393      },
394      "district": {
395        "createdBy": "string",
396        "lastModifiedBy": "string",
397        "createdDate": "2019-08-24T14:15:22Z",
398        "lastModifiedDate": "2019-08-24T14:15:22Z",
399        "archived": true,
400        "externalId": "string",
401        "id": 0,
402        "name": "string",
403        "city": {
404          "createdBy": "string",
405          "lastModifiedBy": "string",
406          "createdDate": "2019-08-24T14:15:22Z",
407          "lastModifiedDate": "2019-08-24T14:15:22Z",
408          "archived": true,
409          "externalId": "string",
410          "id": 0,
411          "name": "string",
412          "province": {
413            "createdBy": "string",
414            "lastModifiedBy": "string",
415            "createdDate": "2019-08-24T14:15:22Z",
416            "lastModifiedDate": "2019-08-24T14:15:22Z",
417            "archived": true,
418            "externalId": "string",
419            "id": 0,
420            "name": "string",
421            "code": "string",
422            "country": {
423              "createdBy": "string",
424              "lastModifiedBy": "string",
425              "createdDate": "2019-08-24T14:15:22Z",
426              "lastModifiedDate": "2019-08-24T14:15:22Z",
427              "archived": true,
428              "externalId": "string",
429              "id": 0,
430              "name": "string",
431              "code": "string"
432            },
433            "provinceCountryKey": "string"
434          },
435          "cityProvinceCountryKey": "string"
436        }
437      },
438      "cityId": 0,
439      "districtId": 0
440    }
441  },
442  "status": {
443    "createdBy": "string",
444    "lastModifiedBy": "string",
445    "createdDate": "2019-08-24T14:15:22Z",
446    "lastModifiedDate": "2019-08-24T14:15:22Z",
447    "archived": true,
448    "externalId": "string",
449    "id": 0,
450    "priority": 0,
451    "internalId": 0,
452    "pickListCode": "string",
453    "pickListLabel": "string",
454    "label": "string",
455    "cultureId": 0,
456    "labelDtos": [
457      {
458        "createdBy": "string",
459        "lastModifiedBy": "string",
460        "createdDate": "2019-08-24T14:15:22Z",
461        "lastModifiedDate": "2019-08-24T14:15:22Z",
462        "archived": true,
463        "externalId": "string",
464        "id": 0,
465        "cultureId": 0,
466        "value": "string"
467      }
468    ]
469  },
470  "usage": {
471    "createdBy": "string",
472    "lastModifiedBy": "string",
473    "createdDate": "2019-08-24T14:15:22Z",
474    "lastModifiedDate": "2019-08-24T14:15:22Z",
475    "archived": true,
476    "externalId": "string",
477    "id": 0,
478    "priority": 0,
479    "internalId": 0,
480    "pickListCode": "string",
481    "pickListLabel": "string",
482    "label": "string",
483    "cultureId": 0,
484    "labelDtos": [
485      {
486        "createdBy": "string",
487        "lastModifiedBy": "string",
488        "createdDate": "2019-08-24T14:15:22Z",
489        "lastModifiedDate": "2019-08-24T14:15:22Z",
490        "archived": true,
491        "externalId": "string",
492        "id": 0,
493        "cultureId": 0,
494        "value": "string"
495      }
496    ]
497  },
498  "occupanciesDto": [
499    {
500      "createdBy": "string",
501      "lastModifiedBy": "string",
502      "createdDate": "2019-08-24T14:15:22Z",
503      "lastModifiedDate": "2019-08-24T14:15:22Z",
504      "archived": true,
505      "externalId": "string",
506      "id": 0,
507      "priority": 0,
508      "internalId": 0,
509      "pickListCode": "string",
510      "pickListLabel": "string",
511      "label": "string",
512      "cultureId": 0,
513      "labelDtos": [
514        {
515          "createdBy": "string",
516          "lastModifiedBy": "string",
517          "createdDate": "2019-08-24T14:15:22Z",
518          "lastModifiedDate": "2019-08-24T14:15:22Z",
519          "archived": true,
520          "externalId": "string",
521          "id": 0,
522          "cultureId": 0,
523          "value": "string"
524        }
525      ]
526    }
527  ]
528}

📄 Description: Data transfer object representing a premise within the business context, encapsulating essential details such as location, type, and operational status to facilitate informed decision-making and resource allocation.

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 premise 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

true

none

Represents the contact number associated with the premise, facilitating communication and service management.

name

string

true

none

Name of the resource

headPremise

boolean

false

none

Indicates whether the premise is designated as the primary location for business operations.

possessionDate

string(date)

false

none

Date of the possession

openingDate

string(date)

false

none

Date of the opening

closingDate

string(date)

false

none

Date of the closing

relocationDate

string(date)

false

none

Date of the relocation

vacatingDate

string(date)

false

none

Date of the vacating

expansionDate

string(date)

false

none

Date of the expansion

statusId

integer(int64)

false

none

Unique identifier for the status

usageId

integer(int64)

false

none

Unique identifier for the usage

parentPremiseId

integer(int64)

false

none

Unique identifier for the parent premise

costCenterId

integer(int64)

true

none

Unique identifier for the cost center

profitCenterId

integer(int64)

false

none

Unique identifier for the profit center

legalEntityId

integer(int64)

true

none

Unique identifier for the legal entity

occupancyIds

[integer]

false

none

An array of unique identifiers representing the occupancy records associated with the premise, facilitating efficient management and tracking of occupancy data.

locationId

integer(int64)

true

none

Unique identifier for the location

locationDto

LocationDto

false

none

Represents the detailed premises information associated with the location, providing essential context for location-based operations and decision-making.

status

PickListOptionDto

false

none

Status of the resource

usage

PickListOptionDto

false

none

Represents the usage metrics associated with the premise, providing insights into operational efficiency and resource allocation.

occupanciesDto

[PickListOptionDto]

false

none

An array of PremiseDto objects representing the occupancy details associated with a specific premise, facilitating effective space management and resource allocation.