UnitDto

Example Json Object

  1{
  2  "id": 10000001,
  3  "displayId": "UNIT-000123",
  4  "name": "Office Printer",
  5  "description": "High-speed color printer for main office.",
  6  "assetNumber": "A-1001",
  7  "referenceId": "REF-2024-001",
  8  "serialNumber": "SN12345678",
  9  "licenseNumber": "LIC-98765",
 10  "inventoryNumber": "INV-55555",
 11  "room": "Room 101",
 12  "location": "Head Office",
 13  "evaluationGroup1": "Group A",
 14  "evaluationGroup2": "Group B",
 15  "evaluationGroup3": "Group C",
 16  "investmentReason": "Replacement of outdated equipment",
 17  "typeName": "Printer",
 18  "calculateGrossTax": true,
 19  "shippingDate": "2024-01-15",
 20  "deliveryDate": "2024-01-20",
 21  "receptionDate": "2024-01-21",
 22  "activationDate": "2024-01-22",
 23  "rouEndDate": "2026-01-22",
 24  "erpAssetRetirementDate": "2028-01-01",
 25  "state": "UNIT_ACTIVE",
 26  "taxCalculationType": "NET",
 27  "internalAssetClass": {
 28    "id": 10000001,
 29    "displayId": "IAC-001",
 30    "status": "CREATED",
 31    "name": "Machinery and Equipment",
 32    "assetClassType": "PROPERTY",
 33    "infiniteUsefulLife": false
 34  },
 35  "profitCenter": {
 36    "id": 9001,
 37    "displayId": "PC-001",
 38    "status": "ACTIVE",
 39    "name": "North Region Profit Center",
 40    "validTo": "2025-12-31",
 41    "erpSystemId": 101,
 42    "erpSystemDisplayId": "SAP-01"
 43  },
 44  "workBreakdownStructure": {
 45    "id": 1001,
 46    "displayId": "WBS-2025-001",
 47    "status": "ACTIVE",
 48    "name": "Main Project WBS"
 49  },
 50  "functionalArea": {
 51    "id": 2001,
 52    "displayId": "FA-2025-001",
 53    "status": "ACTIVE",
 54    "name": "Accounting Department"
 55  },
 56  "businessArea": {
 57    "id": 3001,
 58    "displayId": "BA-2025-001",
 59    "status": "ACTIVE",
 60    "name": "North America Operations"
 61  },
 62  "network": {
 63    "id": 10001,
 64    "displayId": "NET-001",
 65    "status": "ACTIVE",
 66    "name": "Global Network"
 67  },
 68  "segment": {
 69    "id": 11001,
 70    "displayId": "SEG-001",
 71    "status": "ACTIVE",
 72    "name": "Segment Alpha"
 73  },
 74  "internalOrder": {
 75    "id": 10000001,
 76    "status": "ACTIVE",
 77    "displayId": "IO-2024-001",
 78    "erpSystemId": 1001,
 79    "erpSystemDisplayId": "SAP-001",
 80    "name": "Office Renovation Order",
 81    "internalOrderTypeId": 3001,
 82    "internalOrderTypeDisplayId": "CAPEX",
 83    "controllingAreaId": 4001,
 84    "controllingAreaDisplayId": "CA-1001"
 85  },
 86  "internalOrderType": {
 87    "id": 10000001,
 88    "status": "ACTIVE",
 89    "displayId": "CAPEX",
 90    "erpSystemId": 1001,
 91    "erpSystemDisplayId": "SAP-001",
 92    "name": "Capital Expenditure Orders",
 93    "internalOrderId": 20004567
 94  },
 95  "currency": {
 96    "id": 840,
 97    "displayId": "USD",
 98    "status": "ACTIVE",
 99    "name": "United States Dollar",
100    "decimalPoints": 2
101  },
102  "taxCodeForPrincipalPayment": {
103    "id": 5001,
104    "displayId": "TC-001",
105    "status": "ACTIVE",
106    "name": "VAT Standard Rate"
107  },
108  "taxJurisdictionForPrincipalPayment": {
109    "id": 4001,
110    "displayId": "TJ-2025-001",
111    "status": "ACTIVE",
112    "name": "California Tax Authority"
113  },
114  "taxCodeForInterestPayment": {
115    "id": 5001,
116    "displayId": "TC-001",
117    "status": "ACTIVE",
118    "name": "VAT Standard Rate"
119  },
120  "taxJurisdictionForInterestPayment": {
121    "id": 4001,
122    "displayId": "TJ-2025-001",
123    "status": "ACTIVE",
124    "name": "California Tax Authority"
125  },
126  "taxCodeForNonLeasePayment": {
127    "id": 5001,
128    "displayId": "TC-001",
129    "status": "ACTIVE",
130    "name": "VAT Standard Rate"
131  },
132  "taxJurisdictionForNonLeasePayment": {
133    "id": 4001,
134    "displayId": "TJ-2025-001",
135    "status": "ACTIVE",
136    "name": "California Tax Authority"
137  },
138  "costCenter": {
139    "id": 14001,
140    "displayId": "CC-001",
141    "status": "ACTIVE",
142    "name": "Cost Center A"
143  },
144  "company": {
145    "id": 10000006,
146    "displayId": "1005",
147    "status": "ACTIVE",
148    "erpSystemId": 10000001,
149    "erpSystemDisplayId": "FINQ8S-300",
150    "countryId": 10000095,
151    "countryDisplayId": "CA",
152    "postingPeriodVariantId": 0,
153    "fiscalVariantId": 0
154  },
155  "taxJurisdiction": {
156    "id": 4001,
157    "displayId": "TJ-2025-001",
158    "status": "ACTIVE",
159    "name": "California Tax Authority"
160  },
161  "taxCode": {
162    "id": 5001,
163    "displayId": "TC-001",
164    "status": "ACTIVE",
165    "name": "VAT Standard Rate"
166  },
167  "responsibleCostCenter": {
168    "id": 14001,
169    "displayId": "CC-001",
170    "status": "ACTIVE",
171    "name": "Cost Center A"
172  },
173  "plant": {
174    "id": 10000001,
175    "displayId": "PLANT-001",
176    "status": "ACTIVE",
177    "name": "Berlin Manufacturing Plant",
178    "companyId": 7001
179  },
180  "assetCostCenter": {
181    "id": 14001,
182    "displayId": "CC-001",
183    "status": "ACTIVE",
184    "name": "Cost Center A"
185  },
186  "assetProfitCenter": {
187    "id": 9001,
188    "displayId": "PC-001",
189    "status": "ACTIVE",
190    "name": "North Region Profit Center",
191    "validTo": "2025-12-31",
192    "erpSystemId": 101,
193    "erpSystemDisplayId": "SAP-01"
194  },
195  "assetWorkBreakdownStructure": {
196    "id": 1001,
197    "displayId": "WBS-2025-001",
198    "status": "ACTIVE",
199    "name": "Main Project WBS"
200  },
201  "assetTaxJurisdiction": {
202    "id": 4001,
203    "displayId": "TJ-2025-001",
204    "status": "ACTIVE",
205    "name": "California Tax Authority"
206  },
207  "assetBusinessArea": {
208    "id": 3001,
209    "displayId": "BA-2025-001",
210    "status": "ACTIVE",
211    "name": "North America Operations"
212  },
213  "assetSegment": {
214    "id": 11001,
215    "displayId": "SEG-001",
216    "status": "ACTIVE",
217    "name": "Segment Alpha"
218  },
219  "activationGroupId": 101,
220  "activationGroupDisplayId": "AG-001",
221  "principalPositionType": "LESSEE",
222  "effectiveDate": "2024-01-01",
223  "costCenterAllocations": [
224    {
225      "id": 10001,
226      "mainCostCenter": true,
227      "allocationPercentage": 75,
228      "costCenter": {
229        "id": 14001,
230        "displayId": "CC-001",
231        "status": "ACTIVE",
232        "name": "Cost Center A"
233      },
234      "profitCenter": {
235        "id": 9001,
236        "displayId": "PC-001",
237        "status": "ACTIVE",
238        "name": "North Region Profit Center",
239        "validTo": "2025-12-31",
240        "erpSystemId": 101,
241        "erpSystemDisplayId": "SAP-01"
242      }
243    }
244  ],
245  "numberRangeIdentifierType": {
246    "name": "COMPANY_CODE"
247  },
248  "numberRangeIdentifierValue": "NR-0001",
249  "numberRangeType": {
250    "name": "CONTRACT"
251  },
252  "allowsSystemGenerateNewId": true
253}

📄 Description: Represents a unit with all its associated metadata, including identifiers, dates, classification, financials, and organizational details.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier of the unit.

displayId

string

false

none

Readable identifier of the unit.

name

string

false

none

Name of the unit.

description

string

false

none

Detailed description of the unit.

assetNumber

string

false

none

Internal asset number for tracking.

referenceId

string

false

none

External reference identifier.

serialNumber

string

false

none

Manufacturer serial number.

licenseNumber

string

false

none

License number associated with the unit, if any.

inventoryNumber

string

false

none

Inventory control number.

room

string

false

none

Room where the unit is located.

location

string

false

none

Physical or organizational location of the unit.

evaluationGroup1

string

false

none

First evaluation group classification.

evaluationGroup2

string

false

none

Second evaluation group classification.

evaluationGroup3

string

false

none

Third evaluation group classification.

investmentReason

string

false

none

Reason for investment in this unit.

typeName

string

false

none

Type name of the unit.

calculateGrossTax

boolean

false

none

Whether gross tax should be calculated for this unit.

shippingDate

string(date)

false

none

Date the unit was shipped.

deliveryDate

string(date)

false

none

Date the unit was delivered.

receptionDate

string(date)

false

none

Date the unit was received.

activationDate

string(date)

false

none

Date the unit was activated.

rouEndDate

string(date)

false

none

End date for ROU (Right-of-Use) lease.

erpAssetRetirementDate

string(date)

false

none

ERP system retirement date.

state

string

false

none

Current state of the unit.

taxCalculationType

string

false

none

Tax calculation type.

internalAssetClass

InternalAssetClassLite

false

none

Represents an Internal Asset Class entity containing classification, organizational, and status information.

profitCenter

ProfitCenterLite

false

none

Represents a simplified Profit Center entity.

workBreakdownStructure

WorkBreakdownStructureLite

false

none

Represents a simplified Work Breakdown Structure (WBS) entity with basic identifiers and status.

functionalArea

FunctionalAreaLite

false

none

Represents a simplified Functional Area entity with basic identifiers and status.

businessArea

BusinessAreaLite

false

none

Represents a simplified Business Area entity with basic identifiers and status.

network

NetworkLite

false

none

Represents a simplified Network entity.

segment

SegmentLite

false

none

Represents a simplified Segment entity.

internalOrder

InternalOrderDto

false

none

Represents an internal order, including status, ERP references, and controlling area details.

internalOrderType

InternalOrderTypeDto

false

none

Represents a type of internal order, including ERP references and associated internal order.

currency

CurrencyLite

false

none

Represents a Currency entity containing identification, status, and formatting information.

taxCodeForPrincipalPayment

TaxCodeLite

false

none

Represents a simplified Tax Code entity with basic identifiers and status.

taxJurisdictionForPrincipalPayment

TaxJurisdictionLite

false

none

Represents a simplified Tax Jurisdiction entity with basic identifiers and status.

taxCodeForInterestPayment

TaxCodeLite

false

none

Represents a simplified Tax Code entity with basic identifiers and status.

taxJurisdictionForInterestPayment

TaxJurisdictionLite

false

none

Represents a simplified Tax Jurisdiction entity with basic identifiers and status.

taxCodeForNonLeasePayment

TaxCodeLite

false

none

Represents a simplified Tax Code entity with basic identifiers and status.

taxJurisdictionForNonLeasePayment

TaxJurisdictionLite

false

none

Represents a simplified Tax Jurisdiction entity with basic identifiers and status.

costCenter

CostCenterLite

false

none

Represents a simplified Cost Center entity.

company

CompanyLite

false

none

Represents a Company entity containing organizational, ERP, and status information.

taxJurisdiction

TaxJurisdictionLite

false

none

Represents a simplified Tax Jurisdiction entity with basic identifiers and status.

taxCode

TaxCodeLite

false

none

Represents a simplified Tax Code entity with basic identifiers and status.

responsibleCostCenter

CostCenterLite

false

none

Represents a simplified Cost Center entity.

plant

PlantLite

false

none

Represents a plant, including its company association and operational status.

assetCostCenter

CostCenterLite

false

none

Represents a simplified Cost Center entity.

assetProfitCenter

ProfitCenterLite

false

none

Represents a simplified Profit Center entity.

assetWorkBreakdownStructure

WorkBreakdownStructureLite

false

none

Represents a simplified Work Breakdown Structure (WBS) entity with basic identifiers and status.

assetTaxJurisdiction

TaxJurisdictionLite

false

none

Represents a simplified Tax Jurisdiction entity with basic identifiers and status.

assetBusinessArea

BusinessAreaLite

false

none

Represents a simplified Business Area entity with basic identifiers and status.

assetSegment

SegmentLite

false

none

Represents a simplified Segment entity.

activationGroupId

integer(int64)

false

none

ID of the activation group.

activationGroupDisplayId

string

false

none

Display ID of the activation group.

principalPositionType

string

false

none

Principal position type.

effectiveDate

string(date)

false

none

Effective date of the unit.

costCenterAllocations

[CostCenterAllocationsItemDto]

false

none

Allocations of costs across cost centers.

numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Represents a number range identifier type associated with number range types.

numberRangeIdentifierValue

string

false

none

Value of number range identifier.

numberRangeType

INumberRangeType

false

none

Represents a number range type with its name and related configuration.

allowsSystemGenerateNewId

boolean

false

none

Indicates whether the system can generate a new ID.

Enumerated Values

Attribute

Value

principalPositionType

LESSEE, LESSOR

state

AG_ACTIVATING, AG_ACTIVE, AG_CLASSIFIED, AG_CLOSED, AG_CLOSING, AG_DEFINE, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_PENDING_ASSESSMENT, AG_PENDING_CLASSIFICATION, AG_RECLOSE, AG_REJECTED, AG_REPROCESS, AG_REVERSING, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, CONTRACT_ACTIVE, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, LC_ACTIVATING, LC_ACTIVE, LC_CLOSED, LC_DEFINE, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, MLA_ACTIVE, MLA_CLOSED, MLA_DEFINE, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, UNIT_ACTIVE, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DRAFT, UNIT_INITIAL, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED

taxCalculationType

NET