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 its unique ID, facilitating effective lease management and financial obligation tracking within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

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  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000008,
 8    "displayId": "CR-0001",
 9    "name": "Initial Revision",
10    "inception": "2019-08-24",
11    "revisionType": "ACTIVE",
12    "state": "LC_DEFINE",
13    "approvedBy": "manager.user@company.com",
14    "approvedAt": "2019-08-24T14:15:22Z",
15    "parentRevisionId": 10000010,
16    "approverComment": "Approved with changes.",
17    "contractId": 20000001,
18    "contractDisplayId": "C-0001",
19    "contractName": "Office Lease Contract",
20    "principalPositionType": {
21      "name": "LESSEE",
22      "captionKey": "enum.principalpositiontype.lessee",
23      "caption": "Lessee"
24    },
25    "mlaId": 30000001,
26    "companyId": 40000001,
27    "description": "Revision to adjust payment terms.",
28    "externalReference": "EXT-REF-001",
29    "internalReference": "INT-REF-001",
30    "formOfLease": "FULL",
31    "jointVentureLeaseType": "GROSS_LEASE",
32    "businessPlace": "New York Office",
33    "tradingPartner": {
34      "id": 50000001,
35      "displayId": "TP-0001",
36      "status": {
37        "name": "ACTIVE",
38        "captionKey": "enum.objectStatus.active",
39        "active": true,
40        "caption": "Active"
41      },
42      "name": "ABC Real Estate Partners",
43      "erpSystemId": 60000001,
44      "erpSystemDisplayId": "ERP-SYS-01"
45    },
46    "contractCategoryGroup": {
47      "id": 10000001,
48      "displayId": "sample_displayId",
49      "status": {
50        "name": "ACTIVE",
51        "captionKey": "enum.objectStatus.active",
52        "active": true,
53        "caption": "Active"
54      },
55      "name": "Sample Name"
56    },
57    "contractGroup1": {
58      "id": 400001,
59      "displayId": "CG1-01",
60      "status": {
61        "name": "ACTIVE",
62        "captionKey": "enum.objectStatus.active",
63        "active": true,
64        "caption": "Active"
65      },
66      "name": "Real Estate Contracts"
67    },
68    "contractGroup2": {
69      "id": 500001,
70      "displayId": "CG2-01",
71      "status": {
72        "name": "ACTIVE",
73        "captionKey": "enum.objectStatus.active",
74        "active": true,
75        "caption": "Active"
76      },
77      "name": "Equipment Leasing Contracts"
78    },
79    "group3": "Group3-Value",
80    "group4": "Group4-Value",
81    "signingPerson": "John Doe",
82    "placeOfSignature": "Montreal, Canada",
83    "dateOfSignature": "2019-08-24T14:15:22Z",
84    "numberRangeIdentifierValue": "0001",
85    "numberRangeIdentifierType": {
86      "name": "COMPANY_CODE"
87    },
88    "numberRangeType": {
89      "name": "CONTRACT"
90    },
91    "allowsSystemGenerateNewId": true
92  }
93}

Update A Contract Revision

HTTP Request

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

📋 Description: Updates the specified contract revision within the Nakisa Lease Accounting Suite, allowing users to modify details related to lease agreements and financial obligations, ensuring accurate accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

ContractRevisionDto

false

Request body containing the updated contract revision details, including lease terms and financial obligations, essential for accurate accounting entries in the Nakisa Lease Accounting Suite.

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": {
16    "name": "LESSEE",
17    "captionKey": "enum.principalpositiontype.lessee",
18    "caption": "Lessee"
19  },
20  "mlaId": 30000001,
21  "companyId": 40000001,
22  "description": "Revision to adjust payment terms.",
23  "externalReference": "EXT-REF-001",
24  "internalReference": "INT-REF-001",
25  "formOfLease": "FULL",
26  "jointVentureLeaseType": "GROSS_LEASE",
27  "businessPlace": "New York Office",
28  "tradingPartner": {
29    "id": 50000001,
30    "displayId": "TP-0001",
31    "status": {
32      "name": "ACTIVE",
33      "captionKey": "enum.objectStatus.active",
34      "active": true,
35      "caption": "Active"
36    },
37    "name": "ABC Real Estate Partners",
38    "erpSystemId": 60000001,
39    "erpSystemDisplayId": "ERP-SYS-01"
40  },
41  "contractCategoryGroup": {
42    "id": 10000001,
43    "displayId": "sample_displayId",
44    "status": {
45      "name": "ACTIVE",
46      "captionKey": "enum.objectStatus.active",
47      "active": true,
48      "caption": "Active"
49    },
50    "name": "Sample Name"
51  },
52  "contractGroup1": {
53    "id": 400001,
54    "displayId": "CG1-01",
55    "status": {
56      "name": "ACTIVE",
57      "captionKey": "enum.objectStatus.active",
58      "active": true,
59      "caption": "Active"
60    },
61    "name": "Real Estate Contracts"
62  },
63  "contractGroup2": {
64    "id": 500001,
65    "displayId": "CG2-01",
66    "status": {
67      "name": "ACTIVE",
68      "captionKey": "enum.objectStatus.active",
69      "active": true,
70      "caption": "Active"
71    },
72    "name": "Equipment Leasing Contracts"
73  },
74  "group3": "Group3-Value",
75  "group4": "Group4-Value",
76  "signingPerson": "John Doe",
77  "placeOfSignature": "Montreal, Canada",
78  "dateOfSignature": "2019-08-24T14:15:22Z",
79  "numberRangeIdentifierValue": "0001",
80  "numberRangeIdentifierType": {
81    "name": "COMPANY_CODE"
82  },
83  "numberRangeType": {
84    "name": "CONTRACT"
85  },
86  "allowsSystemGenerateNewId": true
87}

Responses

Status

Meaning

Description

Schema

200

OK

Contract revision successfully updated.

ResponseContractRevisionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000008,
 8    "displayId": "CR-0001",
 9    "name": "Initial Revision",
10    "inception": "2019-08-24",
11    "revisionType": "ACTIVE",
12    "state": "LC_DEFINE",
13    "approvedBy": "manager.user@company.com",
14    "approvedAt": "2019-08-24T14:15:22Z",
15    "parentRevisionId": 10000010,
16    "approverComment": "Approved with changes.",
17    "contractId": 20000001,
18    "contractDisplayId": "C-0001",
19    "contractName": "Office Lease Contract",
20    "principalPositionType": {
21      "name": "LESSEE",
22      "captionKey": "enum.principalpositiontype.lessee",
23      "caption": "Lessee"
24    },
25    "mlaId": 30000001,
26    "companyId": 40000001,
27    "description": "Revision to adjust payment terms.",
28    "externalReference": "EXT-REF-001",
29    "internalReference": "INT-REF-001",
30    "formOfLease": "FULL",
31    "jointVentureLeaseType": "GROSS_LEASE",
32    "businessPlace": "New York Office",
33    "tradingPartner": {
34      "id": 50000001,
35      "displayId": "TP-0001",
36      "status": {
37        "name": "ACTIVE",
38        "captionKey": "enum.objectStatus.active",
39        "active": true,
40        "caption": "Active"
41      },
42      "name": "ABC Real Estate Partners",
43      "erpSystemId": 60000001,
44      "erpSystemDisplayId": "ERP-SYS-01"
45    },
46    "contractCategoryGroup": {
47      "id": 10000001,
48      "displayId": "sample_displayId",
49      "status": {
50        "name": "ACTIVE",
51        "captionKey": "enum.objectStatus.active",
52        "active": true,
53        "caption": "Active"
54      },
55      "name": "Sample Name"
56    },
57    "contractGroup1": {
58      "id": 400001,
59      "displayId": "CG1-01",
60      "status": {
61        "name": "ACTIVE",
62        "captionKey": "enum.objectStatus.active",
63        "active": true,
64        "caption": "Active"
65      },
66      "name": "Real Estate Contracts"
67    },
68    "contractGroup2": {
69      "id": 500001,
70      "displayId": "CG2-01",
71      "status": {
72        "name": "ACTIVE",
73        "captionKey": "enum.objectStatus.active",
74        "active": true,
75        "caption": "Active"
76      },
77      "name": "Equipment Leasing Contracts"
78    },
79    "group3": "Group3-Value",
80    "group4": "Group4-Value",
81    "signingPerson": "John Doe",
82    "placeOfSignature": "Montreal, Canada",
83    "dateOfSignature": "2019-08-24T14:15:22Z",
84    "numberRangeIdentifierValue": "0001",
85    "numberRangeIdentifierType": {
86      "name": "COMPANY_CODE"
87    },
88    "numberRangeType": {
89      "name": "CONTRACT"
90    },
91    "allowsSystemGenerateNewId": true
92  }
93}

Delete Contract Revision

HTTP Request

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

📋 Description: Deletes a specified contract revision from the Nakisa Lease Accounting Suite, ensuring that associated financial obligations and accounting entries are updated accordingly.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

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  "errors": {
4    "all": []
5  },
6  "object": {}
7}

Patches Contract Revision

HTTP Request

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

📋 Description: Updates the specified contract revision in the Nakisa Lease Accounting Suite, allowing users to modify details related to lease agreements, financial obligations, and accounting entries. This operation ensures that contract revisions are accurately reflected in the system for effective lease management.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

JsonPatch

false

Request body containing the updated contract revision details, including lease terms and financial obligations, necessary for accurate accounting entries.

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  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000008,
 8    "displayId": "CR-0001",
 9    "name": "Initial Revision",
10    "inception": "2019-08-24",
11    "revisionType": "ACTIVE",
12    "state": "LC_DEFINE",
13    "approvedBy": "manager.user@company.com",
14    "approvedAt": "2019-08-24T14:15:22Z",
15    "parentRevisionId": 10000010,
16    "approverComment": "Approved with changes.",
17    "contractId": 20000001,
18    "contractDisplayId": "C-0001",
19    "contractName": "Office Lease Contract",
20    "principalPositionType": {
21      "name": "LESSEE",
22      "captionKey": "enum.principalpositiontype.lessee",
23      "caption": "Lessee"
24    },
25    "mlaId": 30000001,
26    "companyId": 40000001,
27    "description": "Revision to adjust payment terms.",
28    "externalReference": "EXT-REF-001",
29    "internalReference": "INT-REF-001",
30    "formOfLease": "FULL",
31    "jointVentureLeaseType": "GROSS_LEASE",
32    "businessPlace": "New York Office",
33    "tradingPartner": {
34      "id": 50000001,
35      "displayId": "TP-0001",
36      "status": {
37        "name": "ACTIVE",
38        "captionKey": "enum.objectStatus.active",
39        "active": true,
40        "caption": "Active"
41      },
42      "name": "ABC Real Estate Partners",
43      "erpSystemId": 60000001,
44      "erpSystemDisplayId": "ERP-SYS-01"
45    },
46    "contractCategoryGroup": {
47      "id": 10000001,
48      "displayId": "sample_displayId",
49      "status": {
50        "name": "ACTIVE",
51        "captionKey": "enum.objectStatus.active",
52        "active": true,
53        "caption": "Active"
54      },
55      "name": "Sample Name"
56    },
57    "contractGroup1": {
58      "id": 400001,
59      "displayId": "CG1-01",
60      "status": {
61        "name": "ACTIVE",
62        "captionKey": "enum.objectStatus.active",
63        "active": true,
64        "caption": "Active"
65      },
66      "name": "Real Estate Contracts"
67    },
68    "contractGroup2": {
69      "id": 500001,
70      "displayId": "CG2-01",
71      "status": {
72        "name": "ACTIVE",
73        "captionKey": "enum.objectStatus.active",
74        "active": true,
75        "caption": "Active"
76      },
77      "name": "Equipment Leasing Contracts"
78    },
79    "group3": "Group3-Value",
80    "group4": "Group4-Value",
81    "signingPerson": "John Doe",
82    "placeOfSignature": "Montreal, Canada",
83    "dateOfSignature": "2019-08-24T14:15:22Z",
84    "numberRangeIdentifierValue": "0001",
85    "numberRangeIdentifierType": {
86      "name": "COMPANY_CODE"
87    },
88    "numberRangeType": {
89      "name": "CONTRACT"
90    },
91    "allowsSystemGenerateNewId": true
92  }
93}

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, ensuring accurate alignment of lease agreements with financial obligations and accounting entries. This operation facilitates efficient management of contract data, enhancing overall lease administration.

Parameters

Name

In

Type

Required

Description

body

body

ContractRevisionDto

false

Request body containing bulk contract revision data, including lease details, financial obligations, and associated accounting entries for efficient processing within the Nakisa Lease Accounting Suite.

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": {
17      "name": "LESSEE",
18      "captionKey": "enum.principalpositiontype.lessee",
19      "caption": "Lessee"
20    },
21    "mlaId": 30000001,
22    "companyId": 40000001,
23    "description": "Revision to adjust payment terms.",
24    "externalReference": "EXT-REF-001",
25    "internalReference": "INT-REF-001",
26    "formOfLease": "FULL",
27    "jointVentureLeaseType": "GROSS_LEASE",
28    "businessPlace": "New York Office",
29    "tradingPartner": {
30      "id": 50000001,
31      "displayId": "TP-0001",
32      "status": {
33        "name": "ACTIVE",
34        "captionKey": "enum.objectStatus.active",
35        "active": true,
36        "caption": "Active"
37      },
38      "name": "ABC Real Estate Partners",
39      "erpSystemId": 60000001,
40      "erpSystemDisplayId": "ERP-SYS-01"
41    },
42    "contractCategoryGroup": {
43      "id": 10000001,
44      "displayId": "sample_displayId",
45      "status": {
46        "name": "ACTIVE",
47        "captionKey": "enum.objectStatus.active",
48        "active": true,
49        "caption": "Active"
50      },
51      "name": "Sample Name"
52    },
53    "contractGroup1": {
54      "id": 400001,
55      "displayId": "CG1-01",
56      "status": {
57        "name": "ACTIVE",
58        "captionKey": "enum.objectStatus.active",
59        "active": true,
60        "caption": "Active"
61      },
62      "name": "Real Estate Contracts"
63    },
64    "contractGroup2": {
65      "id": 500001,
66      "displayId": "CG2-01",
67      "status": {
68        "name": "ACTIVE",
69        "captionKey": "enum.objectStatus.active",
70        "active": true,
71        "caption": "Active"
72      },
73      "name": "Equipment Leasing Contracts"
74    },
75    "group3": "Group3-Value",
76    "group4": "Group4-Value",
77    "signingPerson": "John Doe",
78    "placeOfSignature": "Montreal, Canada",
79    "dateOfSignature": "2019-08-24T14:15:22Z",
80    "numberRangeIdentifierValue": "0001",
81    "numberRangeIdentifierType": {
82      "name": "COMPANY_CODE"
83    },
84    "numberRangeType": {
85      "name": "CONTRACT"
86    },
87    "allowsSystemGenerateNewId": true
88  }
89]

Responses

Status

Meaning

Description

Schema

200

OK

All contract revisions successfully updated.

ResponseListContractRevisionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 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": {
22        "name": "LESSEE",
23        "captionKey": "enum.principalpositiontype.lessee",
24        "caption": "Lessee"
25      },
26      "mlaId": 30000001,
27      "companyId": 40000001,
28      "description": "Revision to adjust payment terms.",
29      "externalReference": "EXT-REF-001",
30      "internalReference": "INT-REF-001",
31      "formOfLease": "FULL",
32      "jointVentureLeaseType": "GROSS_LEASE",
33      "businessPlace": "New York Office",
34      "tradingPartner": {
35        "id": 50000001,
36        "displayId": "TP-0001",
37        "status": {
38          "name": "ACTIVE",
39          "captionKey": "enum.objectStatus.active",
40          "active": true,
41          "caption": "Active"
42        },
43        "name": "ABC Real Estate Partners",
44        "erpSystemId": 60000001,
45        "erpSystemDisplayId": "ERP-SYS-01"
46      },
47      "contractCategoryGroup": {
48        "id": 10000001,
49        "displayId": "sample_displayId",
50        "status": {
51          "name": "ACTIVE",
52          "captionKey": "enum.objectStatus.active",
53          "active": true,
54          "caption": "Active"
55        },
56        "name": "Sample Name"
57      },
58      "contractGroup1": {
59        "id": 400001,
60        "displayId": "CG1-01",
61        "status": {
62          "name": "ACTIVE",
63          "captionKey": "enum.objectStatus.active",
64          "active": true,
65          "caption": "Active"
66        },
67        "name": "Real Estate Contracts"
68      },
69      "contractGroup2": {
70        "id": 500001,
71        "displayId": "CG2-01",
72        "status": {
73          "name": "ACTIVE",
74          "captionKey": "enum.objectStatus.active",
75          "active": true,
76          "caption": "Active"
77        },
78        "name": "Equipment Leasing Contracts"
79      },
80      "group3": "Group3-Value",
81      "group4": "Group4-Value",
82      "signingPerson": "John Doe",
83      "placeOfSignature": "Montreal, Canada",
84      "dateOfSignature": "2019-08-24T14:15:22Z",
85      "numberRangeIdentifierValue": "0001",
86      "numberRangeIdentifierType": {
87        "name": "COMPANY_CODE"
88      },
89      "numberRangeType": {
90        "name": "CONTRACT"
91      },
92      "allowsSystemGenerateNewId": true
93    }
94  ]
95}

Search Contract Revisions

HTTP Request

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

📋 Description: Submits a search request for contract revisions within the Nakisa Lease Accounting Suite, enabling users to identify and analyze lease-related financial obligations and accounting entries efficiently.

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|desc). Default sort order is ascending. Multiple sort criteria are supported.

body

body

ContractRevisionDtoFilter

false

Request body containing search criteria for contract revisions, including lease details, financial obligations, and relevant accounting entries.

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

Modify Contract Revision (After Being Approved)

HTTP Request

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

📋 Description: Submits modifications to existing contract revisions within the Nakisa Lease Accounting Suite, ensuring accurate updates to lease agreements and associated financial obligations for streamlined accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

ContractModificationRequest

false

Request body containing the details of the contract revision modification, including lease terms, financial obligations, and associated accounting entries.

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  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000008,
 8    "displayId": "CR-0001",
 9    "name": "Initial Revision",
10    "inception": "2019-08-24",
11    "revisionType": "ACTIVE",
12    "state": "LC_DEFINE",
13    "approvedBy": "manager.user@company.com",
14    "approvedAt": "2019-08-24T14:15:22Z",
15    "parentRevisionId": 10000010,
16    "approverComment": "Approved with changes.",
17    "contractId": 20000001,
18    "contractDisplayId": "C-0001",
19    "contractName": "Office Lease Contract",
20    "principalPositionType": {
21      "name": "LESSEE",
22      "captionKey": "enum.principalpositiontype.lessee",
23      "caption": "Lessee"
24    },
25    "mlaId": 30000001,
26    "companyId": 40000001,
27    "description": "Revision to adjust payment terms.",
28    "externalReference": "EXT-REF-001",
29    "internalReference": "INT-REF-001",
30    "formOfLease": "FULL",
31    "jointVentureLeaseType": "GROSS_LEASE",
32    "businessPlace": "New York Office",
33    "tradingPartner": {
34      "id": 50000001,
35      "displayId": "TP-0001",
36      "status": {
37        "name": "ACTIVE",
38        "captionKey": "enum.objectStatus.active",
39        "active": true,
40        "caption": "Active"
41      },
42      "name": "ABC Real Estate Partners",
43      "erpSystemId": 60000001,
44      "erpSystemDisplayId": "ERP-SYS-01"
45    },
46    "contractCategoryGroup": {
47      "id": 10000001,
48      "displayId": "sample_displayId",
49      "status": {
50        "name": "ACTIVE",
51        "captionKey": "enum.objectStatus.active",
52        "active": true,
53        "caption": "Active"
54      },
55      "name": "Sample Name"
56    },
57    "contractGroup1": {
58      "id": 400001,
59      "displayId": "CG1-01",
60      "status": {
61        "name": "ACTIVE",
62        "captionKey": "enum.objectStatus.active",
63        "active": true,
64        "caption": "Active"
65      },
66      "name": "Real Estate Contracts"
67    },
68    "contractGroup2": {
69      "id": 500001,
70      "displayId": "CG2-01",
71      "status": {
72        "name": "ACTIVE",
73        "captionKey": "enum.objectStatus.active",
74        "active": true,
75        "caption": "Active"
76      },
77      "name": "Equipment Leasing Contracts"
78    },
79    "group3": "Group3-Value",
80    "group4": "Group4-Value",
81    "signingPerson": "John Doe",
82    "placeOfSignature": "Montreal, Canada",
83    "dateOfSignature": "2019-08-24T14:15:22Z",
84    "numberRangeIdentifierValue": "0001",
85    "numberRangeIdentifierType": {
86      "name": "COMPANY_CODE"
87    },
88    "numberRangeType": {
89      "name": "CONTRACT"
90    },
91    "allowsSystemGenerateNewId": true
92  }
93}

List All Contracts Events

HTTP Request

GET /api/v1/events/contract-revisions

📋 Description: Retrieves a list of contract revisions related to lease agreements, providing insights into financial obligations and accounting entries for effective lease management.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Indicates whether the results of the contract revisions query should be paginated, facilitating efficient retrieval of lease-related financial obligations and accounting entries.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of Contracts.

PageContractRevisionDto

Example Responses

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

Get Contract Revision

HTTP Request

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

📋 Description: Retrieves detailed information about contract revisions associated with a specific contract, facilitating effective management of lease agreements and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

contractId

path

integer

true

Unique identifier for the contract

pageable

query

Pageable

false

Indicates whether the response should be paginated, allowing for efficient retrieval of contract revision data related to lease and financial obligations.

Example Values

Parameter

Example

Type

contractId

10000004

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of revisions.

PageContractRevisionDto

Example Responses

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