Contract Event

Retrieves A Contract Revision

HTTP Request

GET /api/v1/events/contract-revisions/{id}

📋 Description: Retrieves detailed information about a specific contract revision identified by the provided ID.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

The unique identifier of the contract event to retrieve.

Example Values

Parameter

Example

Type

id

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved contract revision

ResponseContractRevisionDto

Example Responses

 1{
 2  "code": "OK",
 3  "message": "Successfully retrieved list of contract revisions.",
 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    "id": 10000008,
19    "displayId": "CR-0001",
20    "name": "Initial Revision",
21    "inception": "2019-08-24",
22    "revisionType": "ACTIVE",
23    "state": "LC_DEFINE",
24    "approvedBy": "manager.user@company.com",
25    "approvedAt": "2019-08-24T14:15:22Z",
26    "parentRevisionId": 10000010,
27    "approverComment": "Approved with changes.",
28    "contractId": 20000001,
29    "contractDisplayId": "C-0001",
30    "contractName": "Office Lease Contract",
31    "principalPositionType": "LESSEE",
32    "mlaId": 30000001,
33    "companyId": 40000001,
34    "description": "Revision to adjust payment terms.",
35    "externalReference": "EXT-REF-001",
36    "internalReference": "INT-REF-001",
37    "formOfLease": "FULL",
38    "jointVentureLeaseType": "GROSS_LEASE",
39    "businessPlace": "New York Office",
40    "tradingPartner": {
41      "id": 0,
42      "displayId": "string",
43      "status": "CREATED",
44      "name": "string",
45      "erpSystemId": 0,
46      "erpSystemDisplayId": "string"
47    },
48    "contractCategoryGroup": {
49      "id": 0,
50      "displayId": "string",
51      "status": "CREATED",
52      "name": "string"
53    },
54    "contractGroup1": {
55      "id": 400001,
56      "displayId": "CG1-01",
57      "status": "ACTIVE",
58      "name": "Real Estate Contracts"
59    },
60    "contractGroup2": {
61      "id": 500001,
62      "displayId": "CG2-01",
63      "status": "ACTIVE",
64      "name": "Equipment Leasing Contracts"
65    },
66    "group3": "Group3-Value",
67    "group4": "Group4-Value",
68    "signingPerson": "John Doe",
69    "placeOfSignature": "Montreal, Canada",
70    "dateOfSignature": "2019-08-24T14:15:22Z",
71    "numberRangeIdentifierType": {
72      "name": "COMPANY_CODE"
73    },
74    "numberRangeIdentifierValue": "0001",
75    "numberRangeType": {
76      "name": "CONTRACT"
77    },
78    "allowsSystemGenerateNewId": true
79  }
80}

Update A Contract Revision

HTTP Request

PUT /api/v1/events/contract-revisions/{id}

📋 Description: Updates the specified contract revision in the Nakisa Lease Accounting Suite

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier of the contract revision to update.

body

body

ContractRevisionDto

false

none

Example Values

Parameter

Example

Type

id

10000001

path

Body Parameters

 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}

Responses

Status

Meaning

Description

Schema

200

OK

Contract revision successfully updated.

ResponseContractRevisionDto

Example Responses

 1{
 2  "code": "OK",
 3  "message": "Successfully retrieved list of contract revisions.",
 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    "id": 10000008,
19    "displayId": "CR-0001",
20    "name": "Initial Revision",
21    "inception": "2019-08-24",
22    "revisionType": "ACTIVE",
23    "state": "LC_DEFINE",
24    "approvedBy": "manager.user@company.com",
25    "approvedAt": "2019-08-24T14:15:22Z",
26    "parentRevisionId": 10000010,
27    "approverComment": "Approved with changes.",
28    "contractId": 20000001,
29    "contractDisplayId": "C-0001",
30    "contractName": "Office Lease Contract",
31    "principalPositionType": "LESSEE",
32    "mlaId": 30000001,
33    "companyId": 40000001,
34    "description": "Revision to adjust payment terms.",
35    "externalReference": "EXT-REF-001",
36    "internalReference": "INT-REF-001",
37    "formOfLease": "FULL",
38    "jointVentureLeaseType": "GROSS_LEASE",
39    "businessPlace": "New York Office",
40    "tradingPartner": {
41      "id": 0,
42      "displayId": "string",
43      "status": "CREATED",
44      "name": "string",
45      "erpSystemId": 0,
46      "erpSystemDisplayId": "string"
47    },
48    "contractCategoryGroup": {
49      "id": 0,
50      "displayId": "string",
51      "status": "CREATED",
52      "name": "string"
53    },
54    "contractGroup1": {
55      "id": 400001,
56      "displayId": "CG1-01",
57      "status": "ACTIVE",
58      "name": "Real Estate Contracts"
59    },
60    "contractGroup2": {
61      "id": 500001,
62      "displayId": "CG2-01",
63      "status": "ACTIVE",
64      "name": "Equipment Leasing Contracts"
65    },
66    "group3": "Group3-Value",
67    "group4": "Group4-Value",
68    "signingPerson": "John Doe",
69    "placeOfSignature": "Montreal, Canada",
70    "dateOfSignature": "2019-08-24T14:15:22Z",
71    "numberRangeIdentifierType": {
72      "name": "COMPANY_CODE"
73    },
74    "numberRangeIdentifierValue": "0001",
75    "numberRangeType": {
76      "name": "CONTRACT"
77    },
78    "allowsSystemGenerateNewId": true
79  }
80}

Delete Contract Revision

HTTP Request

DELETE /api/v1/events/contract-revisions/{id}

📋 Description: Deletes a specified contract revision from the Nakisa Lease Accounting Suite

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier of the Contract Revision to delete.

Example Values

Parameter

Example

Type

id

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

Contract Revision successfully deleted.

ResponseVoid

Example Responses

 1{
 2  "code": "OK",
 3  "message": "Operation completed successfully",
 4  "defaultMessage": "Success",
 5  "debugMessage": "string",
 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}

Patches Contract Revision

HTTP Request

PATCH /api/v1/events/contract-revisions/{id}

📋 Description: Patches the specified contract revision in the Nakisa Lease Accounting Suite

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier of the contract revision to patch.

body

body

JsonPatch

false

none

Example Values

Parameter

Example

Type

id

10000001

path

body

{"op":"replace","path":"/name","value":"patched contract"}

body

Body Parameters

1{
2  "op": "replace",
3  "path": "/name",
4  "value": "patched contract"
5}

Responses

Status

Meaning

Description

Schema

200

OK

Successfully patched contract revision.

ResponseContractRevisionDto

Example Responses

 1{
 2  "code": "OK",
 3  "message": "Successfully retrieved list of contract revisions.",
 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    "id": 10000008,
19    "displayId": "CR-0001",
20    "name": "Initial Revision",
21    "inception": "2019-08-24",
22    "revisionType": "ACTIVE",
23    "state": "LC_DEFINE",
24    "approvedBy": "manager.user@company.com",
25    "approvedAt": "2019-08-24T14:15:22Z",
26    "parentRevisionId": 10000010,
27    "approverComment": "Approved with changes.",
28    "contractId": 20000001,
29    "contractDisplayId": "C-0001",
30    "contractName": "Office Lease Contract",
31    "principalPositionType": "LESSEE",
32    "mlaId": 30000001,
33    "companyId": 40000001,
34    "description": "Revision to adjust payment terms.",
35    "externalReference": "EXT-REF-001",
36    "internalReference": "INT-REF-001",
37    "formOfLease": "FULL",
38    "jointVentureLeaseType": "GROSS_LEASE",
39    "businessPlace": "New York Office",
40    "tradingPartner": {
41      "id": 0,
42      "displayId": "string",
43      "status": "CREATED",
44      "name": "string",
45      "erpSystemId": 0,
46      "erpSystemDisplayId": "string"
47    },
48    "contractCategoryGroup": {
49      "id": 0,
50      "displayId": "string",
51      "status": "CREATED",
52      "name": "string"
53    },
54    "contractGroup1": {
55      "id": 400001,
56      "displayId": "CG1-01",
57      "status": "ACTIVE",
58      "name": "Real Estate Contracts"
59    },
60    "contractGroup2": {
61      "id": 500001,
62      "displayId": "CG2-01",
63      "status": "ACTIVE",
64      "name": "Equipment Leasing Contracts"
65    },
66    "group3": "Group3-Value",
67    "group4": "Group4-Value",
68    "signingPerson": "John Doe",
69    "placeOfSignature": "Montreal, Canada",
70    "dateOfSignature": "2019-08-24T14:15:22Z",
71    "numberRangeIdentifierType": {
72      "name": "COMPANY_CODE"
73    },
74    "numberRangeIdentifierValue": "0001",
75    "numberRangeType": {
76      "name": "CONTRACT"
77    },
78    "allowsSystemGenerateNewId": true
79  }
80}

Update Contracts Revisions In Bulk

HTTP Request

PUT /api/v1/events/contract-revisions/bulk

📋 Description: Updates multiple contract revisions in bulk within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

ContractRevisionDto

false

none

Body Parameters

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

Responses

Status

Meaning

Description

Schema

200

OK

All contract revisions successfully updated.

ResponseListContractRevisionDto

Example Responses

 1{
 2  "code": "OK",
 3  "message": "Successfully retrieved list of contract revisions.",
 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": 10000008,
20      "displayId": "CR-0001",
21      "name": "Initial Revision",
22      "inception": "2019-08-24",
23      "revisionType": "ACTIVE",
24      "state": "LC_DEFINE",
25      "approvedBy": "manager.user@company.com",
26      "approvedAt": "2019-08-24T14:15:22Z",
27      "parentRevisionId": 10000010,
28      "approverComment": "Approved with changes.",
29      "contractId": 20000001,
30      "contractDisplayId": "C-0001",
31      "contractName": "Office Lease Contract",
32      "principalPositionType": "LESSEE",
33      "mlaId": 30000001,
34      "companyId": 40000001,
35      "description": "Revision to adjust payment terms.",
36      "externalReference": "EXT-REF-001",
37      "internalReference": "INT-REF-001",
38      "formOfLease": "FULL",
39      "jointVentureLeaseType": "GROSS_LEASE",
40      "businessPlace": "New York Office",
41      "tradingPartner": {
42        "id": 0,
43        "displayId": "string",
44        "status": "CREATED",
45        "name": "string",
46        "erpSystemId": 0,
47        "erpSystemDisplayId": "string"
48      },
49      "contractCategoryGroup": {
50        "id": 0,
51        "displayId": "string",
52        "status": "CREATED",
53        "name": "string"
54      },
55      "contractGroup1": {
56        "id": 400001,
57        "displayId": "CG1-01",
58        "status": "ACTIVE",
59        "name": "Real Estate Contracts"
60      },
61      "contractGroup2": {
62        "id": 500001,
63        "displayId": "CG2-01",
64        "status": "ACTIVE",
65        "name": "Equipment Leasing Contracts"
66      },
67      "group3": "Group3-Value",
68      "group4": "Group4-Value",
69      "signingPerson": "John Doe",
70      "placeOfSignature": "Montreal, Canada",
71      "dateOfSignature": "2019-08-24T14:15:22Z",
72      "numberRangeIdentifierType": {
73        "name": "COMPANY_CODE"
74      },
75      "numberRangeIdentifierValue": "0001",
76      "numberRangeType": {
77        "name": "CONTRACT"
78      },
79      "allowsSystemGenerateNewId": true
80    }
81  ]
82}

Search Contract Revisions

HTTP Request

POST /api/v1/events/contract-revisions/search

📋 Description: Performs a filtered search and returns paginated results.

Parameters

Name

In

Type

Required

Description

page

query

integer

false

Zero-based page index (0..N)

size

query

integer

false

The size of the page to be returned

sort

query

array[string]

false

Sorting criteria in the format: property,(asc

body

body

ContractRevisionDtoFilter

false

none

Default Values

Parameter

Default

Type

page

0

query

size

100

query

sort

["createdAt,ASC"]

query

Parameter Constraints

Parameter

Constraints

page

Min: 0

size

Min: 1

Body Parameters

 1{
 2  "idIn": [
 3    1001,
 4    1002,
 5    1003
 6  ],
 7  "idEqual": 1001,
 8  "idLike": "REV*",
 9  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
10  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
11  "createdByLike": "admin*",
12  "createdByEqual": "system-user",
13  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
14  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
15  "modifiedByLike": "john*",
16  "modifiedByEqual": "john.doe",
17  "displayIdIn": [
18    "REV-2025-001",
19    "REV-2025-002"
20  ],
21  "displayIdLike": "REV*",
22  "nameOrDisplayIdLike": "Lease*",
23  "nameLike": "Contract Update*",
24  "inceptionEqual": "2019-08-24",
25  "revisionTypeIn": [
26    "ACTIVE"
27  ],
28  "stateIn": [
29    "MLA_DEFINE"
30  ],
31  "stateEqual": "MLA_DEFINE",
32  "approvedByLike": "mgr*",
33  "approvedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
34  "approvedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
35  "contractNameOrDisplayIdLike": "Main Lease*",
36  "contractIdIn": [
37    2001,
38    2002
39  ],
40  "contractDisplayIdIn": [
41    "C-2025-001",
42    "C-2025-002"
43  ],
44  "contractNameEqual": "Head Office Lease",
45  "principalPositionTypeEqual": "LESSOR",
46  "mlaIdEqual": 3001,
47  "companyIdEqual": 4001,
48  "tradingPartnerIdIn": [
49    5001,
50    5002
51  ],
52  "tradingPartnerIdEqual": 5001,
53  "contractCategoryGroupIdEqual": 6001,
54  "contractGroup1IdIn": [
55    7001,
56    7002
57  ],
58  "contractGroup1IdEqual": 7001,
59  "contractGroup2IdIn": [
60    8001,
61    8002
62  ],
63  "contractGroup2IdEqual": 8001
64}

Responses

Status

Meaning

Description

Schema

200

OK

Search results successfully returned.

PageContractRevisionDto

Example Responses

 1{
 2  "totalPages": 15,
 3  "totalElements": 150,
 4  "numberOfElements": 10,
 5  "size": 10,
 6  "content": [
 7    {
 8      "id": 10000008,
 9      "displayId": "CR-0001",
10      "name": "Initial Revision",
11      "inception": "2019-08-24",
12      "revisionType": "ACTIVE",
13      "state": "LC_DEFINE",
14      "approvedBy": "manager.user@company.com",
15      "approvedAt": "2019-08-24T14:15:22Z",
16      "parentRevisionId": 10000010,
17      "approverComment": "Approved with changes.",
18      "contractId": 20000001,
19      "contractDisplayId": "C-0001",
20      "contractName": "Office Lease Contract",
21      "principalPositionType": "LESSEE",
22      "mlaId": 30000001,
23      "companyId": 40000001,
24      "description": "Revision to adjust payment terms.",
25      "externalReference": "EXT-REF-001",
26      "internalReference": "INT-REF-001",
27      "formOfLease": "FULL",
28      "jointVentureLeaseType": "GROSS_LEASE",
29      "businessPlace": "New York Office",
30      "tradingPartner": {
31        "id": 0,
32        "displayId": "string",
33        "status": "CREATED",
34        "name": "string",
35        "erpSystemId": 0,
36        "erpSystemDisplayId": "string"
37      },
38      "contractCategoryGroup": {
39        "id": 0,
40        "displayId": "string",
41        "status": "CREATED",
42        "name": "string"
43      },
44      "contractGroup1": {
45        "id": 400001,
46        "displayId": "CG1-01",
47        "status": "ACTIVE",
48        "name": "Real Estate Contracts"
49      },
50      "contractGroup2": {
51        "id": 500001,
52        "displayId": "CG2-01",
53        "status": "ACTIVE",
54        "name": "Equipment Leasing Contracts"
55      },
56      "group3": "Group3-Value",
57      "group4": "Group4-Value",
58      "signingPerson": "John Doe",
59      "placeOfSignature": "Montreal, Canada",
60      "dateOfSignature": "2019-08-24T14:15:22Z",
61      "numberRangeIdentifierType": {
62        "name": "COMPANY_CODE"
63      },
64      "numberRangeIdentifierValue": "0001",
65      "numberRangeType": {
66        "name": "CONTRACT"
67      },
68      "allowsSystemGenerateNewId": true
69    }
70  ],
71  "number": 0,
72  "sort": {
73    "unsorted": false,
74    "sorted": true,
75    "empty": false
76  },
77  "pageable": {
78    "unpaged": false,
79    "pageSize": 100,
80    "paged": true,
81    "offset": 0,
82    "sort": {
83      "unsorted": false,
84      "sorted": true,
85      "empty": false
86    },
87    "pageNumber": 0
88  },
89  "first": true,
90  "last": false,
91  "empty": false
92}

Modify Contract Revision (After Being Approved)

HTTP Request

POST /api/v1/events/contract-revisions/modification

📋 Description: Modify contract revision (after being approved)

Parameters

Name

In

Type

Required

Description

body

body

ContractModificationRequest

false

none

Body Parameters

1{
2  "name": "Extension of Lease Period",
3  "contractRevisionId": 10000001
4}

Responses

Status

Meaning

Description

Schema

200

OK

Modification successfully done.

ResponseContractRevisionDto

Example Responses

 1{
 2  "code": "OK",
 3  "message": "Successfully retrieved list of contract revisions.",
 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    "id": 10000008,
19    "displayId": "CR-0001",
20    "name": "Initial Revision",
21    "inception": "2019-08-24",
22    "revisionType": "ACTIVE",
23    "state": "LC_DEFINE",
24    "approvedBy": "manager.user@company.com",
25    "approvedAt": "2019-08-24T14:15:22Z",
26    "parentRevisionId": 10000010,
27    "approverComment": "Approved with changes.",
28    "contractId": 20000001,
29    "contractDisplayId": "C-0001",
30    "contractName": "Office Lease Contract",
31    "principalPositionType": "LESSEE",
32    "mlaId": 30000001,
33    "companyId": 40000001,
34    "description": "Revision to adjust payment terms.",
35    "externalReference": "EXT-REF-001",
36    "internalReference": "INT-REF-001",
37    "formOfLease": "FULL",
38    "jointVentureLeaseType": "GROSS_LEASE",
39    "businessPlace": "New York Office",
40    "tradingPartner": {
41      "id": 0,
42      "displayId": "string",
43      "status": "CREATED",
44      "name": "string",
45      "erpSystemId": 0,
46      "erpSystemDisplayId": "string"
47    },
48    "contractCategoryGroup": {
49      "id": 0,
50      "displayId": "string",
51      "status": "CREATED",
52      "name": "string"
53    },
54    "contractGroup1": {
55      "id": 400001,
56      "displayId": "CG1-01",
57      "status": "ACTIVE",
58      "name": "Real Estate Contracts"
59    },
60    "contractGroup2": {
61      "id": 500001,
62      "displayId": "CG2-01",
63      "status": "ACTIVE",
64      "name": "Equipment Leasing Contracts"
65    },
66    "group3": "Group3-Value",
67    "group4": "Group4-Value",
68    "signingPerson": "John Doe",
69    "placeOfSignature": "Montreal, Canada",
70    "dateOfSignature": "2019-08-24T14:15:22Z",
71    "numberRangeIdentifierType": {
72      "name": "COMPANY_CODE"
73    },
74    "numberRangeIdentifierValue": "0001",
75    "numberRangeType": {
76      "name": "CONTRACT"
77    },
78    "allowsSystemGenerateNewId": true
79  }
80}

List All Contracts Events

HTTP Request

GET /api/v1/events/contract-revisions

📋 Description: Returns a paginated list of all Contract events.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Pagination parameters including page, size, and sort.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of Contracts.

PageContractRevisionDto

Example Responses

 1{
 2  "totalPages": 15,
 3  "totalElements": 150,
 4  "numberOfElements": 10,
 5  "size": 10,
 6  "content": [
 7    {
 8      "id": 10000008,
 9      "displayId": "CR-0001",
10      "name": "Initial Revision",
11      "inception": "2019-08-24",
12      "revisionType": "ACTIVE",
13      "state": "LC_DEFINE",
14      "approvedBy": "manager.user@company.com",
15      "approvedAt": "2019-08-24T14:15:22Z",
16      "parentRevisionId": 10000010,
17      "approverComment": "Approved with changes.",
18      "contractId": 20000001,
19      "contractDisplayId": "C-0001",
20      "contractName": "Office Lease Contract",
21      "principalPositionType": "LESSEE",
22      "mlaId": 30000001,
23      "companyId": 40000001,
24      "description": "Revision to adjust payment terms.",
25      "externalReference": "EXT-REF-001",
26      "internalReference": "INT-REF-001",
27      "formOfLease": "FULL",
28      "jointVentureLeaseType": "GROSS_LEASE",
29      "businessPlace": "New York Office",
30      "tradingPartner": {
31        "id": 0,
32        "displayId": "string",
33        "status": "CREATED",
34        "name": "string",
35        "erpSystemId": 0,
36        "erpSystemDisplayId": "string"
37      },
38      "contractCategoryGroup": {
39        "id": 0,
40        "displayId": "string",
41        "status": "CREATED",
42        "name": "string"
43      },
44      "contractGroup1": {
45        "id": 400001,
46        "displayId": "CG1-01",
47        "status": "ACTIVE",
48        "name": "Real Estate Contracts"
49      },
50      "contractGroup2": {
51        "id": 500001,
52        "displayId": "CG2-01",
53        "status": "ACTIVE",
54        "name": "Equipment Leasing Contracts"
55      },
56      "group3": "Group3-Value",
57      "group4": "Group4-Value",
58      "signingPerson": "John Doe",
59      "placeOfSignature": "Montreal, Canada",
60      "dateOfSignature": "2019-08-24T14:15:22Z",
61      "numberRangeIdentifierType": {
62        "name": "COMPANY_CODE"
63      },
64      "numberRangeIdentifierValue": "0001",
65      "numberRangeType": {
66        "name": "CONTRACT"
67      },
68      "allowsSystemGenerateNewId": true
69    }
70  ],
71  "number": 0,
72  "sort": {
73    "unsorted": false,
74    "sorted": true,
75    "empty": false
76  },
77  "pageable": {
78    "unpaged": false,
79    "pageSize": 100,
80    "paged": true,
81    "offset": 0,
82    "sort": {
83      "unsorted": false,
84      "sorted": true,
85      "empty": false
86    },
87    "pageNumber": 0
88  },
89  "first": true,
90  "last": false,
91  "empty": false
92}

Get Contract Revision

HTTP Request

GET /api/v1/events/contract-revisions/contract/{contractId}

📋 Description: Retrieves a contract revision by contractId

Parameters

Name

In

Type

Required

Description

id

path

integer

true

The unique identifier of the contract to retrieve contract event

pageable

query

Pageable

false

Pagination parameters including page, size, and sort.

Example Values

Parameter

Example

Type

id

10000004

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of revisions.

PageContractRevisionDto

Example Responses

 1{
 2  "totalPages": 15,
 3  "totalElements": 150,
 4  "numberOfElements": 10,
 5  "size": 10,
 6  "content": [
 7    {
 8      "id": 10000008,
 9      "displayId": "CR-0001",
10      "name": "Initial Revision",
11      "inception": "2019-08-24",
12      "revisionType": "ACTIVE",
13      "state": "LC_DEFINE",
14      "approvedBy": "manager.user@company.com",
15      "approvedAt": "2019-08-24T14:15:22Z",
16      "parentRevisionId": 10000010,
17      "approverComment": "Approved with changes.",
18      "contractId": 20000001,
19      "contractDisplayId": "C-0001",
20      "contractName": "Office Lease Contract",
21      "principalPositionType": "LESSEE",
22      "mlaId": 30000001,
23      "companyId": 40000001,
24      "description": "Revision to adjust payment terms.",
25      "externalReference": "EXT-REF-001",
26      "internalReference": "INT-REF-001",
27      "formOfLease": "FULL",
28      "jointVentureLeaseType": "GROSS_LEASE",
29      "businessPlace": "New York Office",
30      "tradingPartner": {
31        "id": 0,
32        "displayId": "string",
33        "status": "CREATED",
34        "name": "string",
35        "erpSystemId": 0,
36        "erpSystemDisplayId": "string"
37      },
38      "contractCategoryGroup": {
39        "id": 0,
40        "displayId": "string",
41        "status": "CREATED",
42        "name": "string"
43      },
44      "contractGroup1": {
45        "id": 400001,
46        "displayId": "CG1-01",
47        "status": "ACTIVE",
48        "name": "Real Estate Contracts"
49      },
50      "contractGroup2": {
51        "id": 500001,
52        "displayId": "CG2-01",
53        "status": "ACTIVE",
54        "name": "Equipment Leasing Contracts"
55      },
56      "group3": "Group3-Value",
57      "group4": "Group4-Value",
58      "signingPerson": "John Doe",
59      "placeOfSignature": "Montreal, Canada",
60      "dateOfSignature": "2019-08-24T14:15:22Z",
61      "numberRangeIdentifierType": {
62        "name": "COMPANY_CODE"
63      },
64      "numberRangeIdentifierValue": "0001",
65      "numberRangeType": {
66        "name": "CONTRACT"
67      },
68      "allowsSystemGenerateNewId": true
69    }
70  ],
71  "number": 0,
72  "sort": {
73    "unsorted": false,
74    "sorted": true,
75    "empty": false
76  },
77  "pageable": {
78    "unpaged": false,
79    "pageSize": 100,
80    "paged": true,
81    "offset": 0,
82    "sort": {
83      "unsorted": false,
84      "sorted": true,
85      "empty": false
86    },
87    "pageNumber": 0
88  },
89  "first": true,
90  "last": false,
91  "empty": false
92}