ResponseListContractAccountingDto

Example Json Object

  1{
  2  "code": "OK",
  3  "message": "Successfully retrieved list of contract accountings.",
  4  "defaultMessage": "Operation completed successfully.",
  5  "debugMessage": "No errors occurred during the query execution.",
  6  "errors": {
  7    "all": [
  8      {
  9        "type": "GENERIC",
 10        "source": {},
 11        "field": "string",
 12        "errorKey": "string",
 13        "errorMessage": "string"
 14      }
 15    ]
 16  },
 17  "object": [
 18    {
 19      "id": 10000001,
 20      "displayId": "1092983935-20250724-115809",
 21      "principalPositionType": {
 22        "name": "LESSEE",
 23        "captionKey": "enum.principalpositiontype.lessee",
 24        "caption": "Lessee"
 25      },
 26      "contractRate": 12,
 27      "straightLineNonLeaseIncomeForPosting": false,
 28      "compoundingFrequency": {
 29        "name": "MONTHLY",
 30        "captionKey": "enum.compoundingFrequency.monthly",
 31        "length": 12,
 32        "times": 12,
 33        "caption": "Monthly"
 34      },
 35      "lessorPaymentReference": "string",
 36      "trackCost": false,
 37      "generateVendorInvoice": false,
 38      "calculateTax": false,
 39      "calendarType": {
 40        "name": "_360",
 41        "captionKey": "enum.calendarType.360",
 42        "caption": "360 Convention"
 43      },
 44      "fiscalVariant": {
 45        "id": 1001,
 46        "displayId": "FV-2025",
 47        "status": {
 48          "name": "ACTIVE",
 49          "captionKey": "enum.objectStatus.active",
 50          "active": true,
 51          "caption": "Active"
 52        },
 53        "isCalendarYear": true,
 54        "yearDependent": false,
 55        "erpSystemDisplayId": "SAP-ERP",
 56        "isErpSystemDefault": true
 57      },
 58      "workBreakdownStructure": {
 59        "id": 1001,
 60        "displayId": "WBS-2025-001",
 61        "status": {
 62          "name": "ACTIVE",
 63          "captionKey": "enum.objectStatus.active",
 64          "active": true,
 65          "caption": "Active"
 66        },
 67        "name": "Main Project WBS"
 68      },
 69      "functionalArea": {
 70        "id": 2001,
 71        "displayId": "FA-2025-001",
 72        "status": {
 73          "name": "ACTIVE",
 74          "captionKey": "enum.objectStatus.active",
 75          "active": true,
 76          "caption": "Active"
 77        },
 78        "name": "Accounting Department"
 79      },
 80      "businessArea": {
 81        "id": 3001,
 82        "displayId": "BA-2025-001",
 83        "status": {
 84          "name": "ACTIVE",
 85          "captionKey": "enum.objectStatus.active",
 86          "active": true,
 87          "caption": "Active"
 88        },
 89        "name": "North America Operations"
 90      },
 91      "taxJurisdiction": {
 92        "id": 4001,
 93        "displayId": "TJ-2025-001",
 94        "status": {
 95          "name": "ACTIVE",
 96          "captionKey": "enum.objectStatus.active",
 97          "active": true,
 98          "caption": "Active"
 99        },
100        "name": "California Tax Authority"
101      },
102      "taxCode": {
103        "id": 5001,
104        "displayId": "TC-001",
105        "status": {
106          "name": "ACTIVE",
107          "captionKey": "enum.objectStatus.active",
108          "active": true,
109          "caption": "Active"
110        },
111        "name": "VAT Standard Rate"
112      },
113      "paymentTerm": {
114        "id": 6001,
115        "displayId": "PT-2025-001",
116        "status": {
117          "name": "ACTIVE",
118          "captionKey": "enum.objectStatus.active",
119          "active": true,
120          "caption": "Active"
121        },
122        "name": "Net 30 Days"
123      },
124      "paymentBlock": {
125        "id": 7001,
126        "displayId": "PB-001",
127        "status": {
128          "name": "ACTIVE",
129          "captionKey": "enum.objectStatus.active",
130          "active": true,
131          "caption": "Active"
132        },
133        "name": "Block A"
134      },
135      "paymentMethod": {
136        "id": 8001,
137        "displayId": "PM-001",
138        "status": {
139          "name": "ACTIVE",
140          "captionKey": "enum.objectStatus.active",
141          "active": true,
142          "caption": "Active"
143        },
144        "name": "Bank Transfer",
145        "type": "WIRE"
146      },
147      "profitCenter": {
148        "id": 9001,
149        "displayId": "PC-001",
150        "status": {
151          "name": "ACTIVE",
152          "captionKey": "enum.objectStatus.active",
153          "active": true,
154          "caption": "Active"
155        },
156        "name": "North Region Profit Center",
157        "validTo": "2025-12-31",
158        "erpSystemId": 101,
159        "erpSystemDisplayId": "SAP-01"
160      },
161      "network": {
162        "id": 10001,
163        "displayId": "NET-001",
164        "status": {
165          "name": "ACTIVE",
166          "captionKey": "enum.objectStatus.active",
167          "active": true,
168          "caption": "Active"
169        },
170        "name": "Global Network"
171      },
172      "segment": {
173        "id": 11001,
174        "displayId": "SEG-001",
175        "status": {
176          "name": "ACTIVE",
177          "captionKey": "enum.objectStatus.active",
178          "active": true,
179          "caption": "Active"
180        },
181        "name": "Segment Alpha"
182      },
183      "internalOrder": {
184        "id": 12001,
185        "displayId": "IO-001",
186        "status": {
187          "name": "ACTIVE",
188          "captionKey": "enum.objectStatus.active",
189          "active": true,
190          "caption": "Active"
191        },
192        "name": "Internal Order A"
193      },
194      "internalOrderType": {
195        "id": 13001,
196        "displayId": "IOT-001",
197        "status": {
198          "name": "ACTIVE",
199          "captionKey": "enum.objectStatus.active",
200          "active": true,
201          "caption": "Active"
202        },
203        "name": "Internal Order Type A"
204      },
205      "costCenter": {
206        "id": 14001,
207        "displayId": "CC-001",
208        "status": {
209          "name": "ACTIVE",
210          "captionKey": "enum.objectStatus.active",
211          "active": true,
212          "caption": "Active"
213        },
214        "name": "Cost Center A"
215      },
216      "responsibleCostCenter": {
217        "id": 14001,
218        "displayId": "CC-001",
219        "status": {
220          "name": "ACTIVE",
221          "captionKey": "enum.objectStatus.active",
222          "active": true,
223          "caption": "Active"
224        },
225        "name": "Cost Center A"
226      },
227      "contractId": 10000001,
228      "contractDisplayId": "CT-100000000",
229      "contractRevisionId": 10000001,
230      "taxCalculationType": "NET",
231      "transactionTypePosting": false,
232      "costCenterAllocations": [
233        {
234          "id": 10001,
235          "mainCostCenter": true,
236          "allocationPercentage": 75,
237          "costCenter": {
238            "id": 14001,
239            "displayId": "CC-001",
240            "status": {
241              "name": "ACTIVE",
242              "captionKey": "enum.objectStatus.active",
243              "active": true,
244              "caption": "Active"
245            },
246            "name": "Cost Center A"
247          },
248          "profitCenter": {
249            "id": 9001,
250            "displayId": "PC-001",
251            "status": {
252              "name": "ACTIVE",
253              "captionKey": "enum.objectStatus.active",
254              "active": true,
255              "caption": "Active"
256            },
257            "name": "North Region Profit Center",
258            "validTo": "2025-12-31",
259            "erpSystemId": 101,
260            "erpSystemDisplayId": "SAP-01"
261          }
262        }
263      ],
264      "type": "LESSEE",
265      "numberRangeIdentifierType": {
266        "name": "COMPANY_CODE"
267      },
268      "numberRangeIdentifierValue": "COMP-0001",
269      "numberRangeType": {
270        "name": "CONTRACT"
271      },
272      "allowsSystemGenerateNewId": false
273    }
274  ]
275}

📄 Description: Represents a standard response wrapper for returning a list of Contract accounting entities.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Response code indicating success or failure.

message

string

false

write-only

A short message describing the response status.

defaultMessage

string

false

write-only

Default message in case no specific message is set.

debugMessage

string

false

write-only

Detailed message useful for debugging purposes.

errors

Errors

false

none

none

object

[oneOf]

false

none

List of Contract entities returned by the request.

📄 Description: oneOf - discriminator: ContractAccountingDto.type

Name

Type

Required

Restrictions

Description

» anonymous

ContractAccountingDto

false

none

Represents accounting-related details for a contract, including rates, tax, payments, and organizational allocations.

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

LesseeContractAccountingDto

false

none

none

📄 Description: xor

Name

Type

Required

Restrictions

Description

» anonymous

LessorContractAccountingDto

false

none

none

Enumerated Values

Attribute

Value

code

API_CALL_FAILED, ATTACHED, BAD_REQUEST, DATA_VALIDATION_ERROR, DELETED, DETACHED, INTERNAL_SYSTEM_ERROR, NULL_RESPONSE, OK, OK_BUT_RESPONSE_INVALID, REQUEST_VALIDATION_ERROR, SERVICE_VALIDATION_ERROR, UPDATED