MasterAgreementDto

Example Json Object

  1{
  2  "id": 10000086,
  3  "displayId": "MA-2025-0001",
  4  "year": 2023,
  5  "name": "Global HQ Lease Agreement",
  6  "description": "Master lease agreement for HQ premises.",
  7  "validFrom": "2019-08-24",
  8  "validTo": "2019-08-24",
  9  "targetValue": 1000000,
 10  "legalJurisdiction": "Germany",
 11  "approverComment": "Reviewed and approved by legal team.",
 12  "signingPerson": "John Doe",
 13  "placeOfSignature": "Berlin, Germany",
 14  "dateOfSignature": "2019-08-24",
 15  "state": "MLA_DEFINE",
 16  "dataCreationInfo": {
 17    "id": 0,
 18    "idGenerationType": "AUTO",
 19    "source": "string",
 20    "type": "MIGRATION",
 21    "startDateTime": "2019-08-24T14:15:22Z",
 22    "endDateTime": "2019-08-24T14:15:22Z"
 23  },
 24  "agreementGroup": {
 25    "id": 20000001,
 26    "displayId": "AG-001",
 27    "status": {
 28      "name": "ACTIVE",
 29      "captionKey": "enum.objectStatus.active",
 30      "active": true,
 31      "caption": "Active"
 32    },
 33    "name": "Global Agreement Group"
 34  },
 35  "currency": {
 36    "id": 840,
 37    "displayId": "USD",
 38    "status": {
 39      "name": "ACTIVE",
 40      "captionKey": "enum.objectStatus.active",
 41      "active": true,
 42      "caption": "Active"
 43    },
 44    "name": "United States Dollar",
 45    "decimalPoints": 2
 46  },
 47  "internalAssetClass": {
 48    "id": 10000001,
 49    "displayId": "IAC-001",
 50    "status": {
 51      "name": "ACTIVE",
 52      "captionKey": "enum.objectStatus.active",
 53      "active": true,
 54      "caption": "Active"
 55    },
 56    "name": "Machinery and Equipment",
 57    "assetClassType": "PROPERTY",
 58    "infiniteUsefulLife": false
 59  },
 60  "leaseArea": {
 61    "id": 10000001,
 62    "displayId": "0001",
 63    "status": {
 64      "name": "ACTIVE",
 65      "captionKey": "enum.objectStatus.active",
 66      "active": true,
 67      "caption": "Active"
 68    },
 69    "name": "Global Lease Area"
 70  },
 71  "businessUnit": {
 72    "id": 10000001,
 73    "displayId": "BU0001",
 74    "status": {
 75      "name": "ACTIVE",
 76      "captionKey": "enum.objectStatus.active",
 77      "active": true,
 78      "caption": "Active"
 79    },
 80    "name": "North America Business Unit"
 81  },
 82  "companyCode": {
 83    "id": 10000006,
 84    "displayId": "1005",
 85    "status": {
 86      "name": "ACTIVE",
 87      "captionKey": "enum.objectStatus.active",
 88      "active": true,
 89      "caption": "Active"
 90    },
 91    "erpSystemId": 10000001,
 92    "erpSystemDisplayId": "FINQ8S-300",
 93    "countryId": 10000095,
 94    "countryDisplayId": "CA",
 95    "postingPeriodVariantId": 0,
 96    "fiscalVariantId": 0
 97  },
 98  "department": {
 99    "id": 300001,
100    "displayId": "DEP-01",
101    "status": {
102      "name": "ACTIVE",
103      "captionKey": "enum.objectStatus.active",
104      "active": true,
105      "caption": "Active"
106    },
107    "name": "Finance Department"
108  },
109  "leaseGroup": {
110    "id": 60000001,
111    "displayId": "LG-001",
112    "status": {
113      "name": "ACTIVE",
114      "captionKey": "enum.objectStatus.active",
115      "active": true,
116      "caption": "Active"
117    },
118    "name": "Global Lease Group"
119  },
120  "allowsSystemGenerateNewId": true,
121  "numberRangeIdentifierType": {
122    "name": "COMPANY_CODE"
123  },
124  "numberRangeIdentifierValue": "0001",
125  "numberRangeType": {
126    "name": "CONTRACT"
127  }
128}

📄 Description: Represents a Master Agreement entity including lease terms, financial obligations, and accounting entries, for the specified agreement ID.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier of the master agreement. Value is set automatically.

displayId

string

false

none

Display-friendly identifier (usually a human-readable number or code).

year

integer(int32)

true

none

The year associated with the agreement.

name

string

true

none

Name or title of the master agreement.

description

string¦null

false

none

Detailed description of the agreement.

validFrom

string(date)

false

none

The start date from which the agreement is considered effective.

validTo

string(date)

false

none

The end date until which the agreement remains valid.

targetValue

number(double)

false

none

Targeted monetary value associated with the agreement.

legalJurisdiction

string

false

none

Legal region or country where the agreement is governed.

approverComment

string¦null

false

none

Comment or note added by the approver of the agreement.

signingPerson

string

false

none

Name of the person who signed the agreement.

placeOfSignature

string

false

none

Location where the agreement was signed.

dateOfSignature

string(date)

false

none

Date on which the agreement was signed.

state

string

false

none

Current state of the agreement in the workflow or lifecycle.

dataCreationInfo

DataCreationSettingLite

false

none

none

agreementGroup

AgreementGroupLite

false

none

Represents an Agreement Group entity containing organizational and status information.

currency

CurrencyLite

false

none

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

internalAssetClass

InternalAssetClassLite

false

none

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

leaseArea

LeaseAreaLite

true

none

Represents a Lease Area entity containing organizational and status information.

businessUnit

BusinessUnitLite

false

none

Represents a Business Unit entity containing organizational and status information.

companyCode

CompanyLite

false

none

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

department

DepartmentLite

false

none

Represents a Department entity with organizational and status information.

leaseGroup

LeaseGroupLite

false

none

Represents a Lease Group entity containing organizational and status information.

allowsSystemGenerateNewId

boolean

false

none

Indicates whether the system is allowed to auto-generate a new identifier.

numberRangeIdentifierType

INumberRangeIdentifierType

false

none

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

numberRangeIdentifierValue

string

false

none

Value used to identify the context for the number range (e.g., lease area ID).

numberRangeType

INumberRangeType

false

none

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

Enumerated Values

Attribute

Value

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