ContractRevisionDto

Example Json Object

 1{
 2  "id": 10000008,
 3  "displayId": "CR-0001",
 4  "name": "Initial Revision",
 5  "inception": "2019-08-24",
 6  "revisionType": "ACTIVE",
 7  "state": "LC_DEFINE",
 8  "approvedBy": "manager.user@company.com",
 9  "approvedAt": "2019-08-24T14:15:22Z",
10  "parentRevisionId": 10000010,
11  "approverComment": "Approved with changes.",
12  "contractId": 20000001,
13  "contractDisplayId": "C-0001",
14  "contractName": "Office Lease Contract",
15  "principalPositionType": "LESSEE",
16  "mlaId": 30000001,
17  "companyId": 40000001,
18  "description": "Revision to adjust payment terms.",
19  "externalReference": "EXT-REF-001",
20  "internalReference": "INT-REF-001",
21  "formOfLease": "FULL",
22  "jointVentureLeaseType": "GROSS_LEASE",
23  "businessPlace": "New York Office",
24  "tradingPartner": {
25    "id": 0,
26    "displayId": "string",
27    "status": "CREATED",
28    "name": "string",
29    "erpSystemId": 0,
30    "erpSystemDisplayId": "string"
31  },
32  "contractCategoryGroup": {
33    "id": 0,
34    "displayId": "string",
35    "status": "CREATED",
36    "name": "string"
37  },
38  "contractGroup1": {
39    "id": 400001,
40    "displayId": "CG1-01",
41    "status": "ACTIVE",
42    "name": "Real Estate Contracts"
43  },
44  "contractGroup2": {
45    "id": 500001,
46    "displayId": "CG2-01",
47    "status": "ACTIVE",
48    "name": "Equipment Leasing Contracts"
49  },
50  "group3": "Group3-Value",
51  "group4": "Group4-Value",
52  "signingPerson": "John Doe",
53  "placeOfSignature": "Montreal, Canada",
54  "dateOfSignature": "2019-08-24T14:15:22Z",
55  "numberRangeIdentifierType": {
56    "name": "COMPANY_CODE"
57  },
58  "numberRangeIdentifierValue": "0001",
59  "numberRangeType": {
60    "name": "CONTRACT"
61  },
62  "allowsSystemGenerateNewId": true
63}

📄 Description: Represents a Contract Revision entity containing identification, organizational, approval, and categorization details.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier of the contract revision.

displayId

string

false

none

Display-friendly identifier of the contract revision.

name

string

false

none

Name of the contract revision.

inception

string(date)

false

none

Inception date of the contract revision.

revisionType

string

false

none

Type of contract revision (e.g., AMENDMENT, RENEWAL).

state

string

false

none

Current workflow state of the contract revision.

approvedBy

string

false

none

User identifier of the approver.

approvedAt

string(date-time)

false

none

Timestamp when the revision was approved.

parentRevisionId

integer(int64)

false

none

Identifier of the parent contract revision, if any.

approverComment

string

false

none

Comment added by the approver.

contractId

integer(int64)

false

none

Identifier of the contract associated with this revision.

contractDisplayId

string

false

none

Display identifier of the associated contract.

contractName

string

false

none

Name of the associated contract.

principalPositionType

string

false

none

Type of the principal position associated with the revision.

mlaId

integer(int64)

false

none

Identifier of the Master Lease Agreement (MLA) if linked.

companyId

integer(int64)

false

none

Identifier of the company associated with the contract revision.

description

string

false

none

Description of the contract revision.

externalReference

string

false

none

External reference linked to the revision.

internalReference

string

false

none

Internal reference linked to the revision.

formOfLease

string

false

none

Form of lease associated with the contract revision.

jointVentureLeaseType

string

false

none

Specifies the type of joint venture lease, if applicable.

businessPlace

string

false

none

Business place associated with the contract revision.

tradingPartner

TradingPartnerLite

false

none

none

contractCategoryGroup

ContractCategoryGroupLite

false

none

none

contractGroup1

ContractGroup1Lite

false

none

Represents the first-level contract grouping used for categorization and reporting.

contractGroup2

ContractGroup2Lite

false

none

Represents the second-level contract grouping used for categorization and reporting.

group3

string

false

none

Additional contract group classification (3rd level).

group4

string

false

none

Additional contract group classification (4th level).

signingPerson

string

false

none

Person authorized to sign the contract revision.

placeOfSignature

string

false

none

Location where the contract revision was signed.

dateOfSignature

string(date-time)

false

none

Date when the contract revision was signed.

numberRangeIdentifierType

INumberRangeIdentifierType

false

none

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

numberRangeIdentifierValue

string

false

none

The identifier value used within the number range type.

numberRangeType

INumberRangeType

false

none

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

allowsSystemGenerateNewId

boolean

false

none

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

Enumerated Values

Attribute

Value

formOfLease

FULL, NET

jointVentureLeaseType

GROSS_LEASE, NET_LEASE

principalPositionType

LESSEE, LESSOR

revisionType

ACTIVE, DRAFT, INACTIVE, REVERTED, REVISION

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