Master Agreement¶
Retrieves A Specific Master Agreement¶
HTTP Request
GET /api/v1/master-agreements/{id}
📋 Description: Retrieves detailed information about a specific master agreement identified by the provided ID, facilitating the management of lease contracts and associated financial obligations 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 |
|
path |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved master agreement. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000086,
8 "displayId": "MA-2025-0001",
9 "year": 2023,
10 "name": "Global HQ Lease Agreement",
11 "description": "Master lease agreement for HQ premises.",
12 "validFrom": "2019-08-24",
13 "validTo": "2019-08-24",
14 "targetValue": 1000000,
15 "legalJurisdiction": "Germany",
16 "approverComment": "Reviewed and approved by legal team.",
17 "signingPerson": "John Doe",
18 "placeOfSignature": "Berlin, Germany",
19 "dateOfSignature": "2019-08-24",
20 "state": {
21 "name": "MLA_ACTIVE",
22 "captionKey": "enum.mlaStatus.mlaActive",
23 "caption": "Active"
24 },
25 "dataCreationInfo": {
26 "id": 10000001,
27 "idGenerationType": {
28 "name": "AUTO",
29 "captionKey": "enum.idGenerationType.auto",
30 "caption": "Auto"
31 },
32 "source": "sample_source",
33 "type": {
34 "name": "MIGRATION",
35 "captionKey": "enum.dataType.migration",
36 "caption": "Migration"
37 },
38 "startDateTime": "2025-01-01T10:00:00Z",
39 "endDateTime": "2025-01-01T10:00:00Z"
40 },
41 "agreementGroup": {
42 "id": 20000001,
43 "displayId": "AG-001",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "name": "Global Agreement Group"
51 },
52 "currency": {
53 "id": 840,
54 "displayId": "USD",
55 "status": {
56 "name": "ACTIVE",
57 "captionKey": "enum.objectStatus.active",
58 "active": true,
59 "caption": "Active"
60 },
61 "name": "United States Dollar",
62 "decimalPoints": 2
63 },
64 "internalAssetClass": {
65 "id": 10000001,
66 "displayId": "IAC-001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Machinery and Equipment",
74 "assetClassType": "PROPERTY",
75 "infiniteUsefulLife": false
76 },
77 "leaseArea": {
78 "id": 10000001,
79 "displayId": "0001",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Global Lease Area"
87 },
88 "businessUnit": {
89 "id": 10000001,
90 "displayId": "BU0001",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "North America Business Unit"
98 },
99 "companyCode": {
100 "id": 10000006,
101 "displayId": "1005",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "erpSystemId": 10000001,
109 "erpSystemDisplayId": "FINQ8S-300",
110 "countryId": 10000095,
111 "countryDisplayId": "CA",
112 "name": "string",
113 "postingPeriodVariantId": 0,
114 "fiscalVariantId": 0
115 },
116 "department": {
117 "id": 300001,
118 "displayId": "DEP-01",
119 "status": {
120 "name": "ACTIVE",
121 "captionKey": "enum.objectStatus.active",
122 "active": true,
123 "caption": "Active"
124 },
125 "name": "Finance Department"
126 },
127 "leaseGroup": {
128 "id": 60000001,
129 "displayId": "LG-001",
130 "status": {
131 "name": "ACTIVE",
132 "captionKey": "enum.objectStatus.active",
133 "active": true,
134 "caption": "Active"
135 },
136 "name": "Global Lease Group"
137 },
138 "allowsSystemGenerateNewId": true,
139 "numberRangeIdentifierValue": "0001",
140 "numberRangeIdentifierType": {
141 "name": "COMPANY_CODE"
142 },
143 "numberRangeType": {
144 "name": "CONTRACT"
145 }
146 }
147}
Update A Specified Master Agreement¶
HTTP Request
PUT /api/v1/master-agreements/{id}
📋 Description: Updates the specified master agreement in the Nakisa Lease Accounting Suite, allowing for modifications to lease terms, financial obligations, and related accounting entries to ensure accurate contract management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
body |
body |
false |
Request body containing the updated master agreement details, including lease terms, financial obligations, and associated accounting entries. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Body Parameters
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": {
16 "name": "MLA_ACTIVE",
17 "captionKey": "enum.mlaStatus.mlaActive",
18 "caption": "Active"
19 },
20 "dataCreationInfo": {
21 "id": 10000001,
22 "idGenerationType": {
23 "name": "AUTO",
24 "captionKey": "enum.idGenerationType.auto",
25 "caption": "Auto"
26 },
27 "source": "sample_source",
28 "type": {
29 "name": "MIGRATION",
30 "captionKey": "enum.dataType.migration",
31 "caption": "Migration"
32 },
33 "startDateTime": "2025-01-01T10:00:00Z",
34 "endDateTime": "2025-01-01T10:00:00Z"
35 },
36 "agreementGroup": {
37 "id": 20000001,
38 "displayId": "AG-001",
39 "status": {
40 "name": "ACTIVE",
41 "captionKey": "enum.objectStatus.active",
42 "active": true,
43 "caption": "Active"
44 },
45 "name": "Global Agreement Group"
46 },
47 "currency": {
48 "id": 840,
49 "displayId": "USD",
50 "status": {
51 "name": "ACTIVE",
52 "captionKey": "enum.objectStatus.active",
53 "active": true,
54 "caption": "Active"
55 },
56 "name": "United States Dollar",
57 "decimalPoints": 2
58 },
59 "internalAssetClass": {
60 "id": 10000001,
61 "displayId": "IAC-001",
62 "status": {
63 "name": "ACTIVE",
64 "captionKey": "enum.objectStatus.active",
65 "active": true,
66 "caption": "Active"
67 },
68 "name": "Machinery and Equipment",
69 "assetClassType": "PROPERTY",
70 "infiniteUsefulLife": false
71 },
72 "leaseArea": {
73 "id": 10000001,
74 "displayId": "0001",
75 "status": {
76 "name": "ACTIVE",
77 "captionKey": "enum.objectStatus.active",
78 "active": true,
79 "caption": "Active"
80 },
81 "name": "Global Lease Area"
82 },
83 "businessUnit": {
84 "id": 10000001,
85 "displayId": "BU0001",
86 "status": {
87 "name": "ACTIVE",
88 "captionKey": "enum.objectStatus.active",
89 "active": true,
90 "caption": "Active"
91 },
92 "name": "North America Business Unit"
93 },
94 "companyCode": {
95 "id": 10000006,
96 "displayId": "1005",
97 "status": {
98 "name": "ACTIVE",
99 "captionKey": "enum.objectStatus.active",
100 "active": true,
101 "caption": "Active"
102 },
103 "erpSystemId": 10000001,
104 "erpSystemDisplayId": "FINQ8S-300",
105 "countryId": 10000095,
106 "countryDisplayId": "CA",
107 "name": "string",
108 "postingPeriodVariantId": 0,
109 "fiscalVariantId": 0
110 },
111 "department": {
112 "id": 300001,
113 "displayId": "DEP-01",
114 "status": {
115 "name": "ACTIVE",
116 "captionKey": "enum.objectStatus.active",
117 "active": true,
118 "caption": "Active"
119 },
120 "name": "Finance Department"
121 },
122 "leaseGroup": {
123 "id": 60000001,
124 "displayId": "LG-001",
125 "status": {
126 "name": "ACTIVE",
127 "captionKey": "enum.objectStatus.active",
128 "active": true,
129 "caption": "Active"
130 },
131 "name": "Global Lease Group"
132 },
133 "allowsSystemGenerateNewId": true,
134 "numberRangeIdentifierValue": "0001",
135 "numberRangeIdentifierType": {
136 "name": "COMPANY_CODE"
137 },
138 "numberRangeType": {
139 "name": "CONTRACT"
140 }
141}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Master agreement successfully updated. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000086,
8 "displayId": "MA-2025-0001",
9 "year": 2023,
10 "name": "Global HQ Lease Agreement",
11 "description": "Master lease agreement for HQ premises.",
12 "validFrom": "2019-08-24",
13 "validTo": "2019-08-24",
14 "targetValue": 1000000,
15 "legalJurisdiction": "Germany",
16 "approverComment": "Reviewed and approved by legal team.",
17 "signingPerson": "John Doe",
18 "placeOfSignature": "Berlin, Germany",
19 "dateOfSignature": "2019-08-24",
20 "state": {
21 "name": "MLA_ACTIVE",
22 "captionKey": "enum.mlaStatus.mlaActive",
23 "caption": "Active"
24 },
25 "dataCreationInfo": {
26 "id": 10000001,
27 "idGenerationType": {
28 "name": "AUTO",
29 "captionKey": "enum.idGenerationType.auto",
30 "caption": "Auto"
31 },
32 "source": "sample_source",
33 "type": {
34 "name": "MIGRATION",
35 "captionKey": "enum.dataType.migration",
36 "caption": "Migration"
37 },
38 "startDateTime": "2025-01-01T10:00:00Z",
39 "endDateTime": "2025-01-01T10:00:00Z"
40 },
41 "agreementGroup": {
42 "id": 20000001,
43 "displayId": "AG-001",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "name": "Global Agreement Group"
51 },
52 "currency": {
53 "id": 840,
54 "displayId": "USD",
55 "status": {
56 "name": "ACTIVE",
57 "captionKey": "enum.objectStatus.active",
58 "active": true,
59 "caption": "Active"
60 },
61 "name": "United States Dollar",
62 "decimalPoints": 2
63 },
64 "internalAssetClass": {
65 "id": 10000001,
66 "displayId": "IAC-001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Machinery and Equipment",
74 "assetClassType": "PROPERTY",
75 "infiniteUsefulLife": false
76 },
77 "leaseArea": {
78 "id": 10000001,
79 "displayId": "0001",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Global Lease Area"
87 },
88 "businessUnit": {
89 "id": 10000001,
90 "displayId": "BU0001",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "North America Business Unit"
98 },
99 "companyCode": {
100 "id": 10000006,
101 "displayId": "1005",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "erpSystemId": 10000001,
109 "erpSystemDisplayId": "FINQ8S-300",
110 "countryId": 10000095,
111 "countryDisplayId": "CA",
112 "name": "string",
113 "postingPeriodVariantId": 0,
114 "fiscalVariantId": 0
115 },
116 "department": {
117 "id": 300001,
118 "displayId": "DEP-01",
119 "status": {
120 "name": "ACTIVE",
121 "captionKey": "enum.objectStatus.active",
122 "active": true,
123 "caption": "Active"
124 },
125 "name": "Finance Department"
126 },
127 "leaseGroup": {
128 "id": 60000001,
129 "displayId": "LG-001",
130 "status": {
131 "name": "ACTIVE",
132 "captionKey": "enum.objectStatus.active",
133 "active": true,
134 "caption": "Active"
135 },
136 "name": "Global Lease Group"
137 },
138 "allowsSystemGenerateNewId": true,
139 "numberRangeIdentifierValue": "0001",
140 "numberRangeIdentifierType": {
141 "name": "COMPANY_CODE"
142 },
143 "numberRangeType": {
144 "name": "CONTRACT"
145 }
146 }
147}
Delete A Master Agreement¶
HTTP Request
DELETE /api/v1/master-agreements/{id}
📋 Description: Deletes a specified master agreement from the Nakisa Lease Accounting Suite, effectively removing the associated lease, contract, and financial obligation records from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Master agreement successfully deleted. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {}
7}
Updates Specified Master Agreement¶
HTTP Request
PATCH /api/v1/master-agreements/{id}
📋 Description: Updates the specified master agreement in the Nakisa Lease Accounting Suite, allowing for modifications to lease terms, financial obligations, or accounting entries to ensure accurate contract management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
body |
body |
false |
Request body containing the updated lease contract details and financial obligations for the specified master agreement, enabling accurate accounting entries. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
body |
|
body |
Body Parameters
1{
2 "op": "replace",
3 "path": "/name",
4 "value": "patched contract"
5}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully patched master agreement. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000086,
8 "displayId": "MA-2025-0001",
9 "year": 2023,
10 "name": "Global HQ Lease Agreement",
11 "description": "Master lease agreement for HQ premises.",
12 "validFrom": "2019-08-24",
13 "validTo": "2019-08-24",
14 "targetValue": 1000000,
15 "legalJurisdiction": "Germany",
16 "approverComment": "Reviewed and approved by legal team.",
17 "signingPerson": "John Doe",
18 "placeOfSignature": "Berlin, Germany",
19 "dateOfSignature": "2019-08-24",
20 "state": {
21 "name": "MLA_ACTIVE",
22 "captionKey": "enum.mlaStatus.mlaActive",
23 "caption": "Active"
24 },
25 "dataCreationInfo": {
26 "id": 10000001,
27 "idGenerationType": {
28 "name": "AUTO",
29 "captionKey": "enum.idGenerationType.auto",
30 "caption": "Auto"
31 },
32 "source": "sample_source",
33 "type": {
34 "name": "MIGRATION",
35 "captionKey": "enum.dataType.migration",
36 "caption": "Migration"
37 },
38 "startDateTime": "2025-01-01T10:00:00Z",
39 "endDateTime": "2025-01-01T10:00:00Z"
40 },
41 "agreementGroup": {
42 "id": 20000001,
43 "displayId": "AG-001",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "name": "Global Agreement Group"
51 },
52 "currency": {
53 "id": 840,
54 "displayId": "USD",
55 "status": {
56 "name": "ACTIVE",
57 "captionKey": "enum.objectStatus.active",
58 "active": true,
59 "caption": "Active"
60 },
61 "name": "United States Dollar",
62 "decimalPoints": 2
63 },
64 "internalAssetClass": {
65 "id": 10000001,
66 "displayId": "IAC-001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Machinery and Equipment",
74 "assetClassType": "PROPERTY",
75 "infiniteUsefulLife": false
76 },
77 "leaseArea": {
78 "id": 10000001,
79 "displayId": "0001",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Global Lease Area"
87 },
88 "businessUnit": {
89 "id": 10000001,
90 "displayId": "BU0001",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "North America Business Unit"
98 },
99 "companyCode": {
100 "id": 10000006,
101 "displayId": "1005",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "erpSystemId": 10000001,
109 "erpSystemDisplayId": "FINQ8S-300",
110 "countryId": 10000095,
111 "countryDisplayId": "CA",
112 "name": "string",
113 "postingPeriodVariantId": 0,
114 "fiscalVariantId": 0
115 },
116 "department": {
117 "id": 300001,
118 "displayId": "DEP-01",
119 "status": {
120 "name": "ACTIVE",
121 "captionKey": "enum.objectStatus.active",
122 "active": true,
123 "caption": "Active"
124 },
125 "name": "Finance Department"
126 },
127 "leaseGroup": {
128 "id": 60000001,
129 "displayId": "LG-001",
130 "status": {
131 "name": "ACTIVE",
132 "captionKey": "enum.objectStatus.active",
133 "active": true,
134 "caption": "Active"
135 },
136 "name": "Global Lease Group"
137 },
138 "allowsSystemGenerateNewId": true,
139 "numberRangeIdentifierValue": "0001",
140 "numberRangeIdentifierType": {
141 "name": "COMPANY_CODE"
142 },
143 "numberRangeType": {
144 "name": "CONTRACT"
145 }
146 }
147}
Create Or Update A Master Agreements¶
HTTP Request
PUT /api/v1/master-agreements/createOrUpdate
📋 Description: Updates or creates master agreements within the Nakisa Lease Accounting Suite, ensuring accurate management of leases, contracts, and associated financial obligations for streamlined accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the lease and contract details, including financial obligations and accounting entries, for creating or updating master agreements. |
Body Parameters
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": {
16 "name": "MLA_ACTIVE",
17 "captionKey": "enum.mlaStatus.mlaActive",
18 "caption": "Active"
19 },
20 "dataCreationInfo": {
21 "id": 10000001,
22 "idGenerationType": {
23 "name": "AUTO",
24 "captionKey": "enum.idGenerationType.auto",
25 "caption": "Auto"
26 },
27 "source": "sample_source",
28 "type": {
29 "name": "MIGRATION",
30 "captionKey": "enum.dataType.migration",
31 "caption": "Migration"
32 },
33 "startDateTime": "2025-01-01T10:00:00Z",
34 "endDateTime": "2025-01-01T10:00:00Z"
35 },
36 "agreementGroup": {
37 "id": 20000001,
38 "displayId": "AG-001",
39 "status": {
40 "name": "ACTIVE",
41 "captionKey": "enum.objectStatus.active",
42 "active": true,
43 "caption": "Active"
44 },
45 "name": "Global Agreement Group"
46 },
47 "currency": {
48 "id": 840,
49 "displayId": "USD",
50 "status": {
51 "name": "ACTIVE",
52 "captionKey": "enum.objectStatus.active",
53 "active": true,
54 "caption": "Active"
55 },
56 "name": "United States Dollar",
57 "decimalPoints": 2
58 },
59 "internalAssetClass": {
60 "id": 10000001,
61 "displayId": "IAC-001",
62 "status": {
63 "name": "ACTIVE",
64 "captionKey": "enum.objectStatus.active",
65 "active": true,
66 "caption": "Active"
67 },
68 "name": "Machinery and Equipment",
69 "assetClassType": "PROPERTY",
70 "infiniteUsefulLife": false
71 },
72 "leaseArea": {
73 "id": 10000001,
74 "displayId": "0001",
75 "status": {
76 "name": "ACTIVE",
77 "captionKey": "enum.objectStatus.active",
78 "active": true,
79 "caption": "Active"
80 },
81 "name": "Global Lease Area"
82 },
83 "businessUnit": {
84 "id": 10000001,
85 "displayId": "BU0001",
86 "status": {
87 "name": "ACTIVE",
88 "captionKey": "enum.objectStatus.active",
89 "active": true,
90 "caption": "Active"
91 },
92 "name": "North America Business Unit"
93 },
94 "companyCode": {
95 "id": 10000006,
96 "displayId": "1005",
97 "status": {
98 "name": "ACTIVE",
99 "captionKey": "enum.objectStatus.active",
100 "active": true,
101 "caption": "Active"
102 },
103 "erpSystemId": 10000001,
104 "erpSystemDisplayId": "FINQ8S-300",
105 "countryId": 10000095,
106 "countryDisplayId": "CA",
107 "name": "string",
108 "postingPeriodVariantId": 0,
109 "fiscalVariantId": 0
110 },
111 "department": {
112 "id": 300001,
113 "displayId": "DEP-01",
114 "status": {
115 "name": "ACTIVE",
116 "captionKey": "enum.objectStatus.active",
117 "active": true,
118 "caption": "Active"
119 },
120 "name": "Finance Department"
121 },
122 "leaseGroup": {
123 "id": 60000001,
124 "displayId": "LG-001",
125 "status": {
126 "name": "ACTIVE",
127 "captionKey": "enum.objectStatus.active",
128 "active": true,
129 "caption": "Active"
130 },
131 "name": "Global Lease Group"
132 },
133 "allowsSystemGenerateNewId": true,
134 "numberRangeIdentifierValue": "0001",
135 "numberRangeIdentifierType": {
136 "name": "COMPANY_CODE"
137 },
138 "numberRangeType": {
139 "name": "CONTRACT"
140 }
141}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully created or updated the agreement. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000086,
8 "displayId": "MA-2025-0001",
9 "year": 2023,
10 "name": "Global HQ Lease Agreement",
11 "description": "Master lease agreement for HQ premises.",
12 "validFrom": "2019-08-24",
13 "validTo": "2019-08-24",
14 "targetValue": 1000000,
15 "legalJurisdiction": "Germany",
16 "approverComment": "Reviewed and approved by legal team.",
17 "signingPerson": "John Doe",
18 "placeOfSignature": "Berlin, Germany",
19 "dateOfSignature": "2019-08-24",
20 "state": {
21 "name": "MLA_ACTIVE",
22 "captionKey": "enum.mlaStatus.mlaActive",
23 "caption": "Active"
24 },
25 "dataCreationInfo": {
26 "id": 10000001,
27 "idGenerationType": {
28 "name": "AUTO",
29 "captionKey": "enum.idGenerationType.auto",
30 "caption": "Auto"
31 },
32 "source": "sample_source",
33 "type": {
34 "name": "MIGRATION",
35 "captionKey": "enum.dataType.migration",
36 "caption": "Migration"
37 },
38 "startDateTime": "2025-01-01T10:00:00Z",
39 "endDateTime": "2025-01-01T10:00:00Z"
40 },
41 "agreementGroup": {
42 "id": 20000001,
43 "displayId": "AG-001",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "name": "Global Agreement Group"
51 },
52 "currency": {
53 "id": 840,
54 "displayId": "USD",
55 "status": {
56 "name": "ACTIVE",
57 "captionKey": "enum.objectStatus.active",
58 "active": true,
59 "caption": "Active"
60 },
61 "name": "United States Dollar",
62 "decimalPoints": 2
63 },
64 "internalAssetClass": {
65 "id": 10000001,
66 "displayId": "IAC-001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Machinery and Equipment",
74 "assetClassType": "PROPERTY",
75 "infiniteUsefulLife": false
76 },
77 "leaseArea": {
78 "id": 10000001,
79 "displayId": "0001",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Global Lease Area"
87 },
88 "businessUnit": {
89 "id": 10000001,
90 "displayId": "BU0001",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "North America Business Unit"
98 },
99 "companyCode": {
100 "id": 10000006,
101 "displayId": "1005",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "erpSystemId": 10000001,
109 "erpSystemDisplayId": "FINQ8S-300",
110 "countryId": 10000095,
111 "countryDisplayId": "CA",
112 "name": "string",
113 "postingPeriodVariantId": 0,
114 "fiscalVariantId": 0
115 },
116 "department": {
117 "id": 300001,
118 "displayId": "DEP-01",
119 "status": {
120 "name": "ACTIVE",
121 "captionKey": "enum.objectStatus.active",
122 "active": true,
123 "caption": "Active"
124 },
125 "name": "Finance Department"
126 },
127 "leaseGroup": {
128 "id": 60000001,
129 "displayId": "LG-001",
130 "status": {
131 "name": "ACTIVE",
132 "captionKey": "enum.objectStatus.active",
133 "active": true,
134 "caption": "Active"
135 },
136 "name": "Global Lease Group"
137 },
138 "allowsSystemGenerateNewId": true,
139 "numberRangeIdentifierValue": "0001",
140 "numberRangeIdentifierType": {
141 "name": "COMPANY_CODE"
142 },
143 "numberRangeType": {
144 "name": "CONTRACT"
145 }
146 }
147}
Create Or Update Multiple Master Agreements¶
HTTP Request
PUT /api/v1/master-agreements/createOrUpdate/bulk
📋 Description: Creates or updates multiple master agreements in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of leases, contracts, and associated financial obligations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing bulk data for creating or updating master agreements, including lease details, contract terms, financial obligations, and associated accounting entries. |
Body Parameters
1[
2 {
3 "id": 10000086,
4 "displayId": "MA-2025-0001",
5 "year": 2023,
6 "name": "Global HQ Lease Agreement",
7 "description": "Master lease agreement for HQ premises.",
8 "validFrom": "2019-08-24",
9 "validTo": "2019-08-24",
10 "targetValue": 1000000,
11 "legalJurisdiction": "Germany",
12 "approverComment": "Reviewed and approved by legal team.",
13 "signingPerson": "John Doe",
14 "placeOfSignature": "Berlin, Germany",
15 "dateOfSignature": "2019-08-24",
16 "state": {
17 "name": "MLA_ACTIVE",
18 "captionKey": "enum.mlaStatus.mlaActive",
19 "caption": "Active"
20 },
21 "dataCreationInfo": {
22 "id": 10000001,
23 "idGenerationType": {
24 "name": "AUTO",
25 "captionKey": "enum.idGenerationType.auto",
26 "caption": "Auto"
27 },
28 "source": "sample_source",
29 "type": {
30 "name": "MIGRATION",
31 "captionKey": "enum.dataType.migration",
32 "caption": "Migration"
33 },
34 "startDateTime": "2025-01-01T10:00:00Z",
35 "endDateTime": "2025-01-01T10:00:00Z"
36 },
37 "agreementGroup": {
38 "id": 20000001,
39 "displayId": "AG-001",
40 "status": {
41 "name": "ACTIVE",
42 "captionKey": "enum.objectStatus.active",
43 "active": true,
44 "caption": "Active"
45 },
46 "name": "Global Agreement Group"
47 },
48 "currency": {
49 "id": 840,
50 "displayId": "USD",
51 "status": {
52 "name": "ACTIVE",
53 "captionKey": "enum.objectStatus.active",
54 "active": true,
55 "caption": "Active"
56 },
57 "name": "United States Dollar",
58 "decimalPoints": 2
59 },
60 "internalAssetClass": {
61 "id": 10000001,
62 "displayId": "IAC-001",
63 "status": {
64 "name": "ACTIVE",
65 "captionKey": "enum.objectStatus.active",
66 "active": true,
67 "caption": "Active"
68 },
69 "name": "Machinery and Equipment",
70 "assetClassType": "PROPERTY",
71 "infiniteUsefulLife": false
72 },
73 "leaseArea": {
74 "id": 10000001,
75 "displayId": "0001",
76 "status": {
77 "name": "ACTIVE",
78 "captionKey": "enum.objectStatus.active",
79 "active": true,
80 "caption": "Active"
81 },
82 "name": "Global Lease Area"
83 },
84 "businessUnit": {
85 "id": 10000001,
86 "displayId": "BU0001",
87 "status": {
88 "name": "ACTIVE",
89 "captionKey": "enum.objectStatus.active",
90 "active": true,
91 "caption": "Active"
92 },
93 "name": "North America Business Unit"
94 },
95 "companyCode": {
96 "id": 10000006,
97 "displayId": "1005",
98 "status": {
99 "name": "ACTIVE",
100 "captionKey": "enum.objectStatus.active",
101 "active": true,
102 "caption": "Active"
103 },
104 "erpSystemId": 10000001,
105 "erpSystemDisplayId": "FINQ8S-300",
106 "countryId": 10000095,
107 "countryDisplayId": "CA",
108 "name": "string",
109 "postingPeriodVariantId": 0,
110 "fiscalVariantId": 0
111 },
112 "department": {
113 "id": 300001,
114 "displayId": "DEP-01",
115 "status": {
116 "name": "ACTIVE",
117 "captionKey": "enum.objectStatus.active",
118 "active": true,
119 "caption": "Active"
120 },
121 "name": "Finance Department"
122 },
123 "leaseGroup": {
124 "id": 60000001,
125 "displayId": "LG-001",
126 "status": {
127 "name": "ACTIVE",
128 "captionKey": "enum.objectStatus.active",
129 "active": true,
130 "caption": "Active"
131 },
132 "name": "Global Lease Group"
133 },
134 "allowsSystemGenerateNewId": true,
135 "numberRangeIdentifierValue": "0001",
136 "numberRangeIdentifierType": {
137 "name": "COMPANY_CODE"
138 },
139 "numberRangeType": {
140 "name": "CONTRACT"
141 }
142 }
143]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully processed all master agreements. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 10000086,
9 "displayId": "MA-2025-0001",
10 "year": 2023,
11 "name": "Global HQ Lease Agreement",
12 "description": "Master lease agreement for HQ premises.",
13 "validFrom": "2019-08-24",
14 "validTo": "2019-08-24",
15 "targetValue": 1000000,
16 "legalJurisdiction": "Germany",
17 "approverComment": "Reviewed and approved by legal team.",
18 "signingPerson": "John Doe",
19 "placeOfSignature": "Berlin, Germany",
20 "dateOfSignature": "2019-08-24",
21 "state": {
22 "name": "MLA_ACTIVE",
23 "captionKey": "enum.mlaStatus.mlaActive",
24 "caption": "Active"
25 },
26 "dataCreationInfo": {
27 "id": 10000001,
28 "idGenerationType": {
29 "name": "AUTO",
30 "captionKey": "enum.idGenerationType.auto",
31 "caption": "Auto"
32 },
33 "source": "sample_source",
34 "type": {
35 "name": "MIGRATION",
36 "captionKey": "enum.dataType.migration",
37 "caption": "Migration"
38 },
39 "startDateTime": "2025-01-01T10:00:00Z",
40 "endDateTime": "2025-01-01T10:00:00Z"
41 },
42 "agreementGroup": {
43 "id": 20000001,
44 "displayId": "AG-001",
45 "status": {
46 "name": "ACTIVE",
47 "captionKey": "enum.objectStatus.active",
48 "active": true,
49 "caption": "Active"
50 },
51 "name": "Global Agreement Group"
52 },
53 "currency": {
54 "id": 840,
55 "displayId": "USD",
56 "status": {
57 "name": "ACTIVE",
58 "captionKey": "enum.objectStatus.active",
59 "active": true,
60 "caption": "Active"
61 },
62 "name": "United States Dollar",
63 "decimalPoints": 2
64 },
65 "internalAssetClass": {
66 "id": 10000001,
67 "displayId": "IAC-001",
68 "status": {
69 "name": "ACTIVE",
70 "captionKey": "enum.objectStatus.active",
71 "active": true,
72 "caption": "Active"
73 },
74 "name": "Machinery and Equipment",
75 "assetClassType": "PROPERTY",
76 "infiniteUsefulLife": false
77 },
78 "leaseArea": {
79 "id": 10000001,
80 "displayId": "0001",
81 "status": {
82 "name": "ACTIVE",
83 "captionKey": "enum.objectStatus.active",
84 "active": true,
85 "caption": "Active"
86 },
87 "name": "Global Lease Area"
88 },
89 "businessUnit": {
90 "id": 10000001,
91 "displayId": "BU0001",
92 "status": {
93 "name": "ACTIVE",
94 "captionKey": "enum.objectStatus.active",
95 "active": true,
96 "caption": "Active"
97 },
98 "name": "North America Business Unit"
99 },
100 "companyCode": {
101 "id": 10000006,
102 "displayId": "1005",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "erpSystemId": 10000001,
110 "erpSystemDisplayId": "FINQ8S-300",
111 "countryId": 10000095,
112 "countryDisplayId": "CA",
113 "name": "string",
114 "postingPeriodVariantId": 0,
115 "fiscalVariantId": 0
116 },
117 "department": {
118 "id": 300001,
119 "displayId": "DEP-01",
120 "status": {
121 "name": "ACTIVE",
122 "captionKey": "enum.objectStatus.active",
123 "active": true,
124 "caption": "Active"
125 },
126 "name": "Finance Department"
127 },
128 "leaseGroup": {
129 "id": 60000001,
130 "displayId": "LG-001",
131 "status": {
132 "name": "ACTIVE",
133 "captionKey": "enum.objectStatus.active",
134 "active": true,
135 "caption": "Active"
136 },
137 "name": "Global Lease Group"
138 },
139 "allowsSystemGenerateNewId": true,
140 "numberRangeIdentifierValue": "0001",
141 "numberRangeIdentifierType": {
142 "name": "COMPANY_CODE"
143 },
144 "numberRangeType": {
145 "name": "CONTRACT"
146 }
147 }
148 ]
149}
Update Master Agreements In Bulk¶
HTTP Request
PUT /api/v1/master-agreements/bulk
📋 Description: Updates multiple master agreements in bulk, allowing for efficient management of lease contracts and financial obligations within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing a collection of master agreement data, including lease details, contract terms, and associated financial obligations for bulk processing within the Nakisa Lease Accounting Suite. |
Body Parameters
1[
2 {
3 "id": 10000086,
4 "displayId": "MA-2025-0001",
5 "year": 2023,
6 "name": "Global HQ Lease Agreement",
7 "description": "Master lease agreement for HQ premises.",
8 "validFrom": "2019-08-24",
9 "validTo": "2019-08-24",
10 "targetValue": 1000000,
11 "legalJurisdiction": "Germany",
12 "approverComment": "Reviewed and approved by legal team.",
13 "signingPerson": "John Doe",
14 "placeOfSignature": "Berlin, Germany",
15 "dateOfSignature": "2019-08-24",
16 "state": {
17 "name": "MLA_ACTIVE",
18 "captionKey": "enum.mlaStatus.mlaActive",
19 "caption": "Active"
20 },
21 "dataCreationInfo": {
22 "id": 10000001,
23 "idGenerationType": {
24 "name": "AUTO",
25 "captionKey": "enum.idGenerationType.auto",
26 "caption": "Auto"
27 },
28 "source": "sample_source",
29 "type": {
30 "name": "MIGRATION",
31 "captionKey": "enum.dataType.migration",
32 "caption": "Migration"
33 },
34 "startDateTime": "2025-01-01T10:00:00Z",
35 "endDateTime": "2025-01-01T10:00:00Z"
36 },
37 "agreementGroup": {
38 "id": 20000001,
39 "displayId": "AG-001",
40 "status": {
41 "name": "ACTIVE",
42 "captionKey": "enum.objectStatus.active",
43 "active": true,
44 "caption": "Active"
45 },
46 "name": "Global Agreement Group"
47 },
48 "currency": {
49 "id": 840,
50 "displayId": "USD",
51 "status": {
52 "name": "ACTIVE",
53 "captionKey": "enum.objectStatus.active",
54 "active": true,
55 "caption": "Active"
56 },
57 "name": "United States Dollar",
58 "decimalPoints": 2
59 },
60 "internalAssetClass": {
61 "id": 10000001,
62 "displayId": "IAC-001",
63 "status": {
64 "name": "ACTIVE",
65 "captionKey": "enum.objectStatus.active",
66 "active": true,
67 "caption": "Active"
68 },
69 "name": "Machinery and Equipment",
70 "assetClassType": "PROPERTY",
71 "infiniteUsefulLife": false
72 },
73 "leaseArea": {
74 "id": 10000001,
75 "displayId": "0001",
76 "status": {
77 "name": "ACTIVE",
78 "captionKey": "enum.objectStatus.active",
79 "active": true,
80 "caption": "Active"
81 },
82 "name": "Global Lease Area"
83 },
84 "businessUnit": {
85 "id": 10000001,
86 "displayId": "BU0001",
87 "status": {
88 "name": "ACTIVE",
89 "captionKey": "enum.objectStatus.active",
90 "active": true,
91 "caption": "Active"
92 },
93 "name": "North America Business Unit"
94 },
95 "companyCode": {
96 "id": 10000006,
97 "displayId": "1005",
98 "status": {
99 "name": "ACTIVE",
100 "captionKey": "enum.objectStatus.active",
101 "active": true,
102 "caption": "Active"
103 },
104 "erpSystemId": 10000001,
105 "erpSystemDisplayId": "FINQ8S-300",
106 "countryId": 10000095,
107 "countryDisplayId": "CA",
108 "name": "string",
109 "postingPeriodVariantId": 0,
110 "fiscalVariantId": 0
111 },
112 "department": {
113 "id": 300001,
114 "displayId": "DEP-01",
115 "status": {
116 "name": "ACTIVE",
117 "captionKey": "enum.objectStatus.active",
118 "active": true,
119 "caption": "Active"
120 },
121 "name": "Finance Department"
122 },
123 "leaseGroup": {
124 "id": 60000001,
125 "displayId": "LG-001",
126 "status": {
127 "name": "ACTIVE",
128 "captionKey": "enum.objectStatus.active",
129 "active": true,
130 "caption": "Active"
131 },
132 "name": "Global Lease Group"
133 },
134 "allowsSystemGenerateNewId": true,
135 "numberRangeIdentifierValue": "0001",
136 "numberRangeIdentifierType": {
137 "name": "COMPANY_CODE"
138 },
139 "numberRangeType": {
140 "name": "CONTRACT"
141 }
142 }
143]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
All agreements successfully updated. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 10000086,
9 "displayId": "MA-2025-0001",
10 "year": 2023,
11 "name": "Global HQ Lease Agreement",
12 "description": "Master lease agreement for HQ premises.",
13 "validFrom": "2019-08-24",
14 "validTo": "2019-08-24",
15 "targetValue": 1000000,
16 "legalJurisdiction": "Germany",
17 "approverComment": "Reviewed and approved by legal team.",
18 "signingPerson": "John Doe",
19 "placeOfSignature": "Berlin, Germany",
20 "dateOfSignature": "2019-08-24",
21 "state": {
22 "name": "MLA_ACTIVE",
23 "captionKey": "enum.mlaStatus.mlaActive",
24 "caption": "Active"
25 },
26 "dataCreationInfo": {
27 "id": 10000001,
28 "idGenerationType": {
29 "name": "AUTO",
30 "captionKey": "enum.idGenerationType.auto",
31 "caption": "Auto"
32 },
33 "source": "sample_source",
34 "type": {
35 "name": "MIGRATION",
36 "captionKey": "enum.dataType.migration",
37 "caption": "Migration"
38 },
39 "startDateTime": "2025-01-01T10:00:00Z",
40 "endDateTime": "2025-01-01T10:00:00Z"
41 },
42 "agreementGroup": {
43 "id": 20000001,
44 "displayId": "AG-001",
45 "status": {
46 "name": "ACTIVE",
47 "captionKey": "enum.objectStatus.active",
48 "active": true,
49 "caption": "Active"
50 },
51 "name": "Global Agreement Group"
52 },
53 "currency": {
54 "id": 840,
55 "displayId": "USD",
56 "status": {
57 "name": "ACTIVE",
58 "captionKey": "enum.objectStatus.active",
59 "active": true,
60 "caption": "Active"
61 },
62 "name": "United States Dollar",
63 "decimalPoints": 2
64 },
65 "internalAssetClass": {
66 "id": 10000001,
67 "displayId": "IAC-001",
68 "status": {
69 "name": "ACTIVE",
70 "captionKey": "enum.objectStatus.active",
71 "active": true,
72 "caption": "Active"
73 },
74 "name": "Machinery and Equipment",
75 "assetClassType": "PROPERTY",
76 "infiniteUsefulLife": false
77 },
78 "leaseArea": {
79 "id": 10000001,
80 "displayId": "0001",
81 "status": {
82 "name": "ACTIVE",
83 "captionKey": "enum.objectStatus.active",
84 "active": true,
85 "caption": "Active"
86 },
87 "name": "Global Lease Area"
88 },
89 "businessUnit": {
90 "id": 10000001,
91 "displayId": "BU0001",
92 "status": {
93 "name": "ACTIVE",
94 "captionKey": "enum.objectStatus.active",
95 "active": true,
96 "caption": "Active"
97 },
98 "name": "North America Business Unit"
99 },
100 "companyCode": {
101 "id": 10000006,
102 "displayId": "1005",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "erpSystemId": 10000001,
110 "erpSystemDisplayId": "FINQ8S-300",
111 "countryId": 10000095,
112 "countryDisplayId": "CA",
113 "name": "string",
114 "postingPeriodVariantId": 0,
115 "fiscalVariantId": 0
116 },
117 "department": {
118 "id": 300001,
119 "displayId": "DEP-01",
120 "status": {
121 "name": "ACTIVE",
122 "captionKey": "enum.objectStatus.active",
123 "active": true,
124 "caption": "Active"
125 },
126 "name": "Finance Department"
127 },
128 "leaseGroup": {
129 "id": 60000001,
130 "displayId": "LG-001",
131 "status": {
132 "name": "ACTIVE",
133 "captionKey": "enum.objectStatus.active",
134 "active": true,
135 "caption": "Active"
136 },
137 "name": "Global Lease Group"
138 },
139 "allowsSystemGenerateNewId": true,
140 "numberRangeIdentifierValue": "0001",
141 "numberRangeIdentifierType": {
142 "name": "COMPANY_CODE"
143 },
144 "numberRangeType": {
145 "name": "CONTRACT"
146 }
147 }
148 ]
149}
Create Master Agreements In Bulk¶
HTTP Request
POST /api/v1/master-agreements/bulk
📋 Description: Facilitates the bulk creation of master agreements within the Nakisa Lease Accounting Suite, enabling users to efficiently manage lease contracts and associated financial obligations for streamlined accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing a collection of master agreements, including lease details, contract terms, and associated financial obligations for bulk processing within the Nakisa Lease Accounting Suite. |
Body Parameters
1[
2 {
3 "id": 10000086,
4 "displayId": "MA-2025-0001",
5 "year": 2023,
6 "name": "Global HQ Lease Agreement",
7 "description": "Master lease agreement for HQ premises.",
8 "validFrom": "2019-08-24",
9 "validTo": "2019-08-24",
10 "targetValue": 1000000,
11 "legalJurisdiction": "Germany",
12 "approverComment": "Reviewed and approved by legal team.",
13 "signingPerson": "John Doe",
14 "placeOfSignature": "Berlin, Germany",
15 "dateOfSignature": "2019-08-24",
16 "state": {
17 "name": "MLA_ACTIVE",
18 "captionKey": "enum.mlaStatus.mlaActive",
19 "caption": "Active"
20 },
21 "dataCreationInfo": {
22 "id": 10000001,
23 "idGenerationType": {
24 "name": "AUTO",
25 "captionKey": "enum.idGenerationType.auto",
26 "caption": "Auto"
27 },
28 "source": "sample_source",
29 "type": {
30 "name": "MIGRATION",
31 "captionKey": "enum.dataType.migration",
32 "caption": "Migration"
33 },
34 "startDateTime": "2025-01-01T10:00:00Z",
35 "endDateTime": "2025-01-01T10:00:00Z"
36 },
37 "agreementGroup": {
38 "id": 20000001,
39 "displayId": "AG-001",
40 "status": {
41 "name": "ACTIVE",
42 "captionKey": "enum.objectStatus.active",
43 "active": true,
44 "caption": "Active"
45 },
46 "name": "Global Agreement Group"
47 },
48 "currency": {
49 "id": 840,
50 "displayId": "USD",
51 "status": {
52 "name": "ACTIVE",
53 "captionKey": "enum.objectStatus.active",
54 "active": true,
55 "caption": "Active"
56 },
57 "name": "United States Dollar",
58 "decimalPoints": 2
59 },
60 "internalAssetClass": {
61 "id": 10000001,
62 "displayId": "IAC-001",
63 "status": {
64 "name": "ACTIVE",
65 "captionKey": "enum.objectStatus.active",
66 "active": true,
67 "caption": "Active"
68 },
69 "name": "Machinery and Equipment",
70 "assetClassType": "PROPERTY",
71 "infiniteUsefulLife": false
72 },
73 "leaseArea": {
74 "id": 10000001,
75 "displayId": "0001",
76 "status": {
77 "name": "ACTIVE",
78 "captionKey": "enum.objectStatus.active",
79 "active": true,
80 "caption": "Active"
81 },
82 "name": "Global Lease Area"
83 },
84 "businessUnit": {
85 "id": 10000001,
86 "displayId": "BU0001",
87 "status": {
88 "name": "ACTIVE",
89 "captionKey": "enum.objectStatus.active",
90 "active": true,
91 "caption": "Active"
92 },
93 "name": "North America Business Unit"
94 },
95 "companyCode": {
96 "id": 10000006,
97 "displayId": "1005",
98 "status": {
99 "name": "ACTIVE",
100 "captionKey": "enum.objectStatus.active",
101 "active": true,
102 "caption": "Active"
103 },
104 "erpSystemId": 10000001,
105 "erpSystemDisplayId": "FINQ8S-300",
106 "countryId": 10000095,
107 "countryDisplayId": "CA",
108 "name": "string",
109 "postingPeriodVariantId": 0,
110 "fiscalVariantId": 0
111 },
112 "department": {
113 "id": 300001,
114 "displayId": "DEP-01",
115 "status": {
116 "name": "ACTIVE",
117 "captionKey": "enum.objectStatus.active",
118 "active": true,
119 "caption": "Active"
120 },
121 "name": "Finance Department"
122 },
123 "leaseGroup": {
124 "id": 60000001,
125 "displayId": "LG-001",
126 "status": {
127 "name": "ACTIVE",
128 "captionKey": "enum.objectStatus.active",
129 "active": true,
130 "caption": "Active"
131 },
132 "name": "Global Lease Group"
133 },
134 "allowsSystemGenerateNewId": true,
135 "numberRangeIdentifierValue": "0001",
136 "numberRangeIdentifierType": {
137 "name": "COMPANY_CODE"
138 },
139 "numberRangeType": {
140 "name": "CONTRACT"
141 }
142 }
143]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Master agreements successfully created. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": [
7 {
8 "id": 10000086,
9 "displayId": "MA-2025-0001",
10 "year": 2023,
11 "name": "Global HQ Lease Agreement",
12 "description": "Master lease agreement for HQ premises.",
13 "validFrom": "2019-08-24",
14 "validTo": "2019-08-24",
15 "targetValue": 1000000,
16 "legalJurisdiction": "Germany",
17 "approverComment": "Reviewed and approved by legal team.",
18 "signingPerson": "John Doe",
19 "placeOfSignature": "Berlin, Germany",
20 "dateOfSignature": "2019-08-24",
21 "state": {
22 "name": "MLA_ACTIVE",
23 "captionKey": "enum.mlaStatus.mlaActive",
24 "caption": "Active"
25 },
26 "dataCreationInfo": {
27 "id": 10000001,
28 "idGenerationType": {
29 "name": "AUTO",
30 "captionKey": "enum.idGenerationType.auto",
31 "caption": "Auto"
32 },
33 "source": "sample_source",
34 "type": {
35 "name": "MIGRATION",
36 "captionKey": "enum.dataType.migration",
37 "caption": "Migration"
38 },
39 "startDateTime": "2025-01-01T10:00:00Z",
40 "endDateTime": "2025-01-01T10:00:00Z"
41 },
42 "agreementGroup": {
43 "id": 20000001,
44 "displayId": "AG-001",
45 "status": {
46 "name": "ACTIVE",
47 "captionKey": "enum.objectStatus.active",
48 "active": true,
49 "caption": "Active"
50 },
51 "name": "Global Agreement Group"
52 },
53 "currency": {
54 "id": 840,
55 "displayId": "USD",
56 "status": {
57 "name": "ACTIVE",
58 "captionKey": "enum.objectStatus.active",
59 "active": true,
60 "caption": "Active"
61 },
62 "name": "United States Dollar",
63 "decimalPoints": 2
64 },
65 "internalAssetClass": {
66 "id": 10000001,
67 "displayId": "IAC-001",
68 "status": {
69 "name": "ACTIVE",
70 "captionKey": "enum.objectStatus.active",
71 "active": true,
72 "caption": "Active"
73 },
74 "name": "Machinery and Equipment",
75 "assetClassType": "PROPERTY",
76 "infiniteUsefulLife": false
77 },
78 "leaseArea": {
79 "id": 10000001,
80 "displayId": "0001",
81 "status": {
82 "name": "ACTIVE",
83 "captionKey": "enum.objectStatus.active",
84 "active": true,
85 "caption": "Active"
86 },
87 "name": "Global Lease Area"
88 },
89 "businessUnit": {
90 "id": 10000001,
91 "displayId": "BU0001",
92 "status": {
93 "name": "ACTIVE",
94 "captionKey": "enum.objectStatus.active",
95 "active": true,
96 "caption": "Active"
97 },
98 "name": "North America Business Unit"
99 },
100 "companyCode": {
101 "id": 10000006,
102 "displayId": "1005",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "erpSystemId": 10000001,
110 "erpSystemDisplayId": "FINQ8S-300",
111 "countryId": 10000095,
112 "countryDisplayId": "CA",
113 "name": "string",
114 "postingPeriodVariantId": 0,
115 "fiscalVariantId": 0
116 },
117 "department": {
118 "id": 300001,
119 "displayId": "DEP-01",
120 "status": {
121 "name": "ACTIVE",
122 "captionKey": "enum.objectStatus.active",
123 "active": true,
124 "caption": "Active"
125 },
126 "name": "Finance Department"
127 },
128 "leaseGroup": {
129 "id": 60000001,
130 "displayId": "LG-001",
131 "status": {
132 "name": "ACTIVE",
133 "captionKey": "enum.objectStatus.active",
134 "active": true,
135 "caption": "Active"
136 },
137 "name": "Global Lease Group"
138 },
139 "allowsSystemGenerateNewId": true,
140 "numberRangeIdentifierValue": "0001",
141 "numberRangeIdentifierType": {
142 "name": "COMPANY_CODE"
143 },
144 "numberRangeType": {
145 "name": "CONTRACT"
146 }
147 }
148 ]
149}
Delete Master Agreements In Bulk¶
HTTP Request
DELETE /api/v1/master-agreements/bulk
📋 Description: Deletes multiple master agreements in bulk from the Nakisa Lease Accounting Suite, facilitating the management of leases, contracts, and associated financial obligations within the accounting framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
false |
Request body containing an array of identifiers for master agreements to be deleted, facilitating the management of lease and contract financial obligations within the Nakisa Lease Accounting Suite. |
Body Parameters
1[
2 123
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Master agreements successfully deleted. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {}
7}
List All Master Agreements¶
HTTP Request
GET /api/v1/master-agreements
📋 Description: Retrieves a list of master agreements associated with leases and contracts, providing essential details for managing financial obligations and accounting entries within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
false |
Indicates whether the results of the master agreements query should be paginated, facilitating efficient retrieval of lease and contract data within the Nakisa Lease Accounting Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully retrieved list of master agreements. |
Example Responses
1{
2 "totalElements": 76,
3 "totalPages": 1,
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": 76,
17 "size": 100,
18 "content": [
19 {
20 "id": 10000086,
21 "displayId": "MA-2025-0001",
22 "year": 2023,
23 "name": "Global HQ Lease Agreement",
24 "description": "Master lease agreement for HQ premises.",
25 "validFrom": "2019-08-24",
26 "validTo": "2019-08-24",
27 "targetValue": 1000000,
28 "legalJurisdiction": "Germany",
29 "approverComment": "Reviewed and approved by legal team.",
30 "signingPerson": "John Doe",
31 "placeOfSignature": "Berlin, Germany",
32 "dateOfSignature": "2019-08-24",
33 "state": {
34 "name": "MLA_ACTIVE",
35 "captionKey": "enum.mlaStatus.mlaActive",
36 "caption": "Active"
37 },
38 "dataCreationInfo": {
39 "id": 10000001,
40 "idGenerationType": {
41 "name": "AUTO",
42 "captionKey": "enum.idGenerationType.auto",
43 "caption": "Auto"
44 },
45 "source": "sample_source",
46 "type": {
47 "name": "MIGRATION",
48 "captionKey": "enum.dataType.migration",
49 "caption": "Migration"
50 },
51 "startDateTime": "2025-01-01T10:00:00Z",
52 "endDateTime": "2025-01-01T10:00:00Z"
53 },
54 "agreementGroup": {
55 "id": 20000001,
56 "displayId": "AG-001",
57 "status": {
58 "name": "ACTIVE",
59 "captionKey": "enum.objectStatus.active",
60 "active": true,
61 "caption": "Active"
62 },
63 "name": "Global Agreement Group"
64 },
65 "currency": {
66 "id": 840,
67 "displayId": "USD",
68 "status": {
69 "name": "ACTIVE",
70 "captionKey": "enum.objectStatus.active",
71 "active": true,
72 "caption": "Active"
73 },
74 "name": "United States Dollar",
75 "decimalPoints": 2
76 },
77 "internalAssetClass": {
78 "id": 10000001,
79 "displayId": "IAC-001",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Machinery and Equipment",
87 "assetClassType": "PROPERTY",
88 "infiniteUsefulLife": false
89 },
90 "leaseArea": {
91 "id": 10000001,
92 "displayId": "0001",
93 "status": {
94 "name": "ACTIVE",
95 "captionKey": "enum.objectStatus.active",
96 "active": true,
97 "caption": "Active"
98 },
99 "name": "Global Lease Area"
100 },
101 "businessUnit": {
102 "id": 10000001,
103 "displayId": "BU0001",
104 "status": {
105 "name": "ACTIVE",
106 "captionKey": "enum.objectStatus.active",
107 "active": true,
108 "caption": "Active"
109 },
110 "name": "North America Business Unit"
111 },
112 "companyCode": {
113 "id": 10000006,
114 "displayId": "1005",
115 "status": {
116 "name": "ACTIVE",
117 "captionKey": "enum.objectStatus.active",
118 "active": true,
119 "caption": "Active"
120 },
121 "erpSystemId": 10000001,
122 "erpSystemDisplayId": "FINQ8S-300",
123 "countryId": 10000095,
124 "countryDisplayId": "CA",
125 "name": "string",
126 "postingPeriodVariantId": 0,
127 "fiscalVariantId": 0
128 },
129 "department": {
130 "id": 300001,
131 "displayId": "DEP-01",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "Finance Department"
139 },
140 "leaseGroup": {
141 "id": 60000001,
142 "displayId": "LG-001",
143 "status": {
144 "name": "ACTIVE",
145 "captionKey": "enum.objectStatus.active",
146 "active": true,
147 "caption": "Active"
148 },
149 "name": "Global Lease Group"
150 },
151 "allowsSystemGenerateNewId": true,
152 "numberRangeIdentifierValue": "0001",
153 "numberRangeIdentifierType": {
154 "name": "COMPANY_CODE"
155 },
156 "numberRangeType": {
157 "name": "CONTRACT"
158 }
159 }
160 ],
161 "number": 0,
162 "sort": {
163 "unsorted": false,
164 "sorted": true,
165 "empty": false
166 },
167 "first": true,
168 "last": true,
169 "empty": false
170}
Create Master Agreement¶
HTTP Request
POST /api/v1/master-agreements
📋 Description: Creates a new master agreement within the Nakisa Lease Accounting Suite, establishing a formal lease or contract that outlines financial obligations and accounting entries associated with the agreement.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the master agreement details, including lease terms, contract specifications, and associated financial obligations for accurate accounting entry. |
Body Parameters
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": {
16 "name": "MLA_ACTIVE",
17 "captionKey": "enum.mlaStatus.mlaActive",
18 "caption": "Active"
19 },
20 "dataCreationInfo": {
21 "id": 10000001,
22 "idGenerationType": {
23 "name": "AUTO",
24 "captionKey": "enum.idGenerationType.auto",
25 "caption": "Auto"
26 },
27 "source": "sample_source",
28 "type": {
29 "name": "MIGRATION",
30 "captionKey": "enum.dataType.migration",
31 "caption": "Migration"
32 },
33 "startDateTime": "2025-01-01T10:00:00Z",
34 "endDateTime": "2025-01-01T10:00:00Z"
35 },
36 "agreementGroup": {
37 "id": 20000001,
38 "displayId": "AG-001",
39 "status": {
40 "name": "ACTIVE",
41 "captionKey": "enum.objectStatus.active",
42 "active": true,
43 "caption": "Active"
44 },
45 "name": "Global Agreement Group"
46 },
47 "currency": {
48 "id": 840,
49 "displayId": "USD",
50 "status": {
51 "name": "ACTIVE",
52 "captionKey": "enum.objectStatus.active",
53 "active": true,
54 "caption": "Active"
55 },
56 "name": "United States Dollar",
57 "decimalPoints": 2
58 },
59 "internalAssetClass": {
60 "id": 10000001,
61 "displayId": "IAC-001",
62 "status": {
63 "name": "ACTIVE",
64 "captionKey": "enum.objectStatus.active",
65 "active": true,
66 "caption": "Active"
67 },
68 "name": "Machinery and Equipment",
69 "assetClassType": "PROPERTY",
70 "infiniteUsefulLife": false
71 },
72 "leaseArea": {
73 "id": 10000001,
74 "displayId": "0001",
75 "status": {
76 "name": "ACTIVE",
77 "captionKey": "enum.objectStatus.active",
78 "active": true,
79 "caption": "Active"
80 },
81 "name": "Global Lease Area"
82 },
83 "businessUnit": {
84 "id": 10000001,
85 "displayId": "BU0001",
86 "status": {
87 "name": "ACTIVE",
88 "captionKey": "enum.objectStatus.active",
89 "active": true,
90 "caption": "Active"
91 },
92 "name": "North America Business Unit"
93 },
94 "companyCode": {
95 "id": 10000006,
96 "displayId": "1005",
97 "status": {
98 "name": "ACTIVE",
99 "captionKey": "enum.objectStatus.active",
100 "active": true,
101 "caption": "Active"
102 },
103 "erpSystemId": 10000001,
104 "erpSystemDisplayId": "FINQ8S-300",
105 "countryId": 10000095,
106 "countryDisplayId": "CA",
107 "name": "string",
108 "postingPeriodVariantId": 0,
109 "fiscalVariantId": 0
110 },
111 "department": {
112 "id": 300001,
113 "displayId": "DEP-01",
114 "status": {
115 "name": "ACTIVE",
116 "captionKey": "enum.objectStatus.active",
117 "active": true,
118 "caption": "Active"
119 },
120 "name": "Finance Department"
121 },
122 "leaseGroup": {
123 "id": 60000001,
124 "displayId": "LG-001",
125 "status": {
126 "name": "ACTIVE",
127 "captionKey": "enum.objectStatus.active",
128 "active": true,
129 "caption": "Active"
130 },
131 "name": "Global Lease Group"
132 },
133 "allowsSystemGenerateNewId": true,
134 "numberRangeIdentifierValue": "0001",
135 "numberRangeIdentifierType": {
136 "name": "COMPANY_CODE"
137 },
138 "numberRangeType": {
139 "name": "CONTRACT"
140 }
141}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Master agreement successfully created. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000086,
8 "displayId": "MA-2025-0001",
9 "year": 2023,
10 "name": "Global HQ Lease Agreement",
11 "description": "Master lease agreement for HQ premises.",
12 "validFrom": "2019-08-24",
13 "validTo": "2019-08-24",
14 "targetValue": 1000000,
15 "legalJurisdiction": "Germany",
16 "approverComment": "Reviewed and approved by legal team.",
17 "signingPerson": "John Doe",
18 "placeOfSignature": "Berlin, Germany",
19 "dateOfSignature": "2019-08-24",
20 "state": {
21 "name": "MLA_ACTIVE",
22 "captionKey": "enum.mlaStatus.mlaActive",
23 "caption": "Active"
24 },
25 "dataCreationInfo": {
26 "id": 10000001,
27 "idGenerationType": {
28 "name": "AUTO",
29 "captionKey": "enum.idGenerationType.auto",
30 "caption": "Auto"
31 },
32 "source": "sample_source",
33 "type": {
34 "name": "MIGRATION",
35 "captionKey": "enum.dataType.migration",
36 "caption": "Migration"
37 },
38 "startDateTime": "2025-01-01T10:00:00Z",
39 "endDateTime": "2025-01-01T10:00:00Z"
40 },
41 "agreementGroup": {
42 "id": 20000001,
43 "displayId": "AG-001",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "name": "Global Agreement Group"
51 },
52 "currency": {
53 "id": 840,
54 "displayId": "USD",
55 "status": {
56 "name": "ACTIVE",
57 "captionKey": "enum.objectStatus.active",
58 "active": true,
59 "caption": "Active"
60 },
61 "name": "United States Dollar",
62 "decimalPoints": 2
63 },
64 "internalAssetClass": {
65 "id": 10000001,
66 "displayId": "IAC-001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Machinery and Equipment",
74 "assetClassType": "PROPERTY",
75 "infiniteUsefulLife": false
76 },
77 "leaseArea": {
78 "id": 10000001,
79 "displayId": "0001",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Global Lease Area"
87 },
88 "businessUnit": {
89 "id": 10000001,
90 "displayId": "BU0001",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "North America Business Unit"
98 },
99 "companyCode": {
100 "id": 10000006,
101 "displayId": "1005",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "erpSystemId": 10000001,
109 "erpSystemDisplayId": "FINQ8S-300",
110 "countryId": 10000095,
111 "countryDisplayId": "CA",
112 "name": "string",
113 "postingPeriodVariantId": 0,
114 "fiscalVariantId": 0
115 },
116 "department": {
117 "id": 300001,
118 "displayId": "DEP-01",
119 "status": {
120 "name": "ACTIVE",
121 "captionKey": "enum.objectStatus.active",
122 "active": true,
123 "caption": "Active"
124 },
125 "name": "Finance Department"
126 },
127 "leaseGroup": {
128 "id": 60000001,
129 "displayId": "LG-001",
130 "status": {
131 "name": "ACTIVE",
132 "captionKey": "enum.objectStatus.active",
133 "active": true,
134 "caption": "Active"
135 },
136 "name": "Global Lease Group"
137 },
138 "allowsSystemGenerateNewId": true,
139 "numberRangeIdentifierValue": "0001",
140 "numberRangeIdentifierType": {
141 "name": "COMPANY_CODE"
142 },
143 "numberRangeType": {
144 "name": "CONTRACT"
145 }
146 }
147}
Search Master Agreements¶
HTTP Request
POST /api/v1/master-agreements/search
📋 Description: Submits a search request for master agreements within the Nakisa Lease Accounting Suite, enabling users to efficiently locate lease contracts and associated financial obligations for accurate accounting entries.
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 |
false |
Request body containing search criteria and filters for retrieving master agreements related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 10000001,
6 "idLike": "1000%",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "admin%",
10 "createdByEqual": "super.admin@nakisa.com",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "admin%",
14 "modifiedByEqual": "super.admin@nakisa.com",
15 "displayIdIn": [
16 "MA-100001250",
17 "MA-100001251"
18 ],
19 "displayIdLike": "MA-1000%",
20 "nameOrDisplayIdLike": "Agreement%",
21 "yearGreaterThanOrEqual": 2023,
22 "yearLessThanOrEqual": 2025,
23 "nameLike": "Global%",
24 "stateIn": [
25 "MLA_DEFINE",
26 "MLA_ACTIVE"
27 ],
28 "agreementGroupIdEqual": 10000001,
29 "currencyIdEqual": 100,
30 "internalAssetClassIdEqual": 10000001,
31 "leaseAreaIdIn": [
32 10000001,
33 10000002
34 ],
35 "leaseAreaIdEqual": 10000001,
36 "businessUnitIdIn": [
37 10000001,
38 10000002
39 ],
40 "businessUnitIdEqual": 10000001,
41 "companyCodeIdIn": [
42 10000001,
43 10000002
44 ],
45 "companyCodeIdEqual": 10000001,
46 "departmentIdIn": [
47 10000001,
48 10000002
49 ],
50 "departmentIdEqual": 10000001,
51 "leaseGroupIdIn": [
52 10000001,
53 10000002
54 ],
55 "leaseGroupIdEqual": 10000001
56}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Search results successfully returned. |
Example Responses
1{
2 "totalElements": 76,
3 "totalPages": 1,
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": 76,
17 "size": 100,
18 "content": [
19 {
20 "id": 10000086,
21 "displayId": "MA-2025-0001",
22 "year": 2023,
23 "name": "Global HQ Lease Agreement",
24 "description": "Master lease agreement for HQ premises.",
25 "validFrom": "2019-08-24",
26 "validTo": "2019-08-24",
27 "targetValue": 1000000,
28 "legalJurisdiction": "Germany",
29 "approverComment": "Reviewed and approved by legal team.",
30 "signingPerson": "John Doe",
31 "placeOfSignature": "Berlin, Germany",
32 "dateOfSignature": "2019-08-24",
33 "state": {
34 "name": "MLA_ACTIVE",
35 "captionKey": "enum.mlaStatus.mlaActive",
36 "caption": "Active"
37 },
38 "dataCreationInfo": {
39 "id": 10000001,
40 "idGenerationType": {
41 "name": "AUTO",
42 "captionKey": "enum.idGenerationType.auto",
43 "caption": "Auto"
44 },
45 "source": "sample_source",
46 "type": {
47 "name": "MIGRATION",
48 "captionKey": "enum.dataType.migration",
49 "caption": "Migration"
50 },
51 "startDateTime": "2025-01-01T10:00:00Z",
52 "endDateTime": "2025-01-01T10:00:00Z"
53 },
54 "agreementGroup": {
55 "id": 20000001,
56 "displayId": "AG-001",
57 "status": {
58 "name": "ACTIVE",
59 "captionKey": "enum.objectStatus.active",
60 "active": true,
61 "caption": "Active"
62 },
63 "name": "Global Agreement Group"
64 },
65 "currency": {
66 "id": 840,
67 "displayId": "USD",
68 "status": {
69 "name": "ACTIVE",
70 "captionKey": "enum.objectStatus.active",
71 "active": true,
72 "caption": "Active"
73 },
74 "name": "United States Dollar",
75 "decimalPoints": 2
76 },
77 "internalAssetClass": {
78 "id": 10000001,
79 "displayId": "IAC-001",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Machinery and Equipment",
87 "assetClassType": "PROPERTY",
88 "infiniteUsefulLife": false
89 },
90 "leaseArea": {
91 "id": 10000001,
92 "displayId": "0001",
93 "status": {
94 "name": "ACTIVE",
95 "captionKey": "enum.objectStatus.active",
96 "active": true,
97 "caption": "Active"
98 },
99 "name": "Global Lease Area"
100 },
101 "businessUnit": {
102 "id": 10000001,
103 "displayId": "BU0001",
104 "status": {
105 "name": "ACTIVE",
106 "captionKey": "enum.objectStatus.active",
107 "active": true,
108 "caption": "Active"
109 },
110 "name": "North America Business Unit"
111 },
112 "companyCode": {
113 "id": 10000006,
114 "displayId": "1005",
115 "status": {
116 "name": "ACTIVE",
117 "captionKey": "enum.objectStatus.active",
118 "active": true,
119 "caption": "Active"
120 },
121 "erpSystemId": 10000001,
122 "erpSystemDisplayId": "FINQ8S-300",
123 "countryId": 10000095,
124 "countryDisplayId": "CA",
125 "name": "string",
126 "postingPeriodVariantId": 0,
127 "fiscalVariantId": 0
128 },
129 "department": {
130 "id": 300001,
131 "displayId": "DEP-01",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "Finance Department"
139 },
140 "leaseGroup": {
141 "id": 60000001,
142 "displayId": "LG-001",
143 "status": {
144 "name": "ACTIVE",
145 "captionKey": "enum.objectStatus.active",
146 "active": true,
147 "caption": "Active"
148 },
149 "name": "Global Lease Group"
150 },
151 "allowsSystemGenerateNewId": true,
152 "numberRangeIdentifierValue": "0001",
153 "numberRangeIdentifierType": {
154 "name": "COMPANY_CODE"
155 },
156 "numberRangeType": {
157 "name": "CONTRACT"
158 }
159 }
160 ],
161 "number": 0,
162 "sort": {
163 "unsorted": false,
164 "sorted": true,
165 "empty": false
166 },
167 "first": true,
168 "last": true,
169 "empty": false
170}
Clone Master Agreement¶
HTTP Request
POST /api/v1/master-agreements/clone/{id}
📋 Description: Clones an existing master agreement identified by the specified ID, facilitating the efficient management of lease and contract obligations within the Nakisa Lease Accounting Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer |
true |
Unique identifier for the resource |
body |
body |
false |
Request body containing the details necessary to clone a master agreement, including lease terms, contract specifications, and associated financial obligations. |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
id |
|
path |
Body Parameters
1{
2 "name": "Cloned Agreement 2025",
3 "idGenerationType": "AUTO",
4 "year": 2025,
5 "leaseArea": {
6 "id": 10000001,
7 "displayId": "0001",
8 "status": {
9 "name": "ACTIVE",
10 "captionKey": "enum.objectStatus.active",
11 "active": true,
12 "caption": "Active"
13 },
14 "name": "Global Lease Area"
15 },
16 "businessUnit": {
17 "id": 10000001,
18 "displayId": "BU0001",
19 "status": {
20 "name": "ACTIVE",
21 "captionKey": "enum.objectStatus.active",
22 "active": true,
23 "caption": "Active"
24 },
25 "name": "North America Business Unit"
26 },
27 "internalAssetClass": {
28 "id": 10000001,
29 "displayId": "IAC-001",
30 "status": {
31 "name": "ACTIVE",
32 "captionKey": "enum.objectStatus.active",
33 "active": true,
34 "caption": "Active"
35 },
36 "name": "Machinery and Equipment",
37 "assetClassType": "PROPERTY",
38 "infiniteUsefulLife": false
39 }
40}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Successfully cloned master agreement. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": {
7 "id": 10000086,
8 "displayId": "MA-2025-0001",
9 "year": 2023,
10 "name": "Global HQ Lease Agreement",
11 "description": "Master lease agreement for HQ premises.",
12 "validFrom": "2019-08-24",
13 "validTo": "2019-08-24",
14 "targetValue": 1000000,
15 "legalJurisdiction": "Germany",
16 "approverComment": "Reviewed and approved by legal team.",
17 "signingPerson": "John Doe",
18 "placeOfSignature": "Berlin, Germany",
19 "dateOfSignature": "2019-08-24",
20 "state": {
21 "name": "MLA_ACTIVE",
22 "captionKey": "enum.mlaStatus.mlaActive",
23 "caption": "Active"
24 },
25 "dataCreationInfo": {
26 "id": 10000001,
27 "idGenerationType": {
28 "name": "AUTO",
29 "captionKey": "enum.idGenerationType.auto",
30 "caption": "Auto"
31 },
32 "source": "sample_source",
33 "type": {
34 "name": "MIGRATION",
35 "captionKey": "enum.dataType.migration",
36 "caption": "Migration"
37 },
38 "startDateTime": "2025-01-01T10:00:00Z",
39 "endDateTime": "2025-01-01T10:00:00Z"
40 },
41 "agreementGroup": {
42 "id": 20000001,
43 "displayId": "AG-001",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "name": "Global Agreement Group"
51 },
52 "currency": {
53 "id": 840,
54 "displayId": "USD",
55 "status": {
56 "name": "ACTIVE",
57 "captionKey": "enum.objectStatus.active",
58 "active": true,
59 "caption": "Active"
60 },
61 "name": "United States Dollar",
62 "decimalPoints": 2
63 },
64 "internalAssetClass": {
65 "id": 10000001,
66 "displayId": "IAC-001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Machinery and Equipment",
74 "assetClassType": "PROPERTY",
75 "infiniteUsefulLife": false
76 },
77 "leaseArea": {
78 "id": 10000001,
79 "displayId": "0001",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Global Lease Area"
87 },
88 "businessUnit": {
89 "id": 10000001,
90 "displayId": "BU0001",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "North America Business Unit"
98 },
99 "companyCode": {
100 "id": 10000006,
101 "displayId": "1005",
102 "status": {
103 "name": "ACTIVE",
104 "captionKey": "enum.objectStatus.active",
105 "active": true,
106 "caption": "Active"
107 },
108 "erpSystemId": 10000001,
109 "erpSystemDisplayId": "FINQ8S-300",
110 "countryId": 10000095,
111 "countryDisplayId": "CA",
112 "name": "string",
113 "postingPeriodVariantId": 0,
114 "fiscalVariantId": 0
115 },
116 "department": {
117 "id": 300001,
118 "displayId": "DEP-01",
119 "status": {
120 "name": "ACTIVE",
121 "captionKey": "enum.objectStatus.active",
122 "active": true,
123 "caption": "Active"
124 },
125 "name": "Finance Department"
126 },
127 "leaseGroup": {
128 "id": 60000001,
129 "displayId": "LG-001",
130 "status": {
131 "name": "ACTIVE",
132 "captionKey": "enum.objectStatus.active",
133 "active": true,
134 "caption": "Active"
135 },
136 "name": "Global Lease Group"
137 },
138 "allowsSystemGenerateNewId": true,
139 "numberRangeIdentifierValue": "0001",
140 "numberRangeIdentifierType": {
141 "name": "COMPANY_CODE"
142 },
143 "numberRangeType": {
144 "name": "CONTRACT"
145 }
146 }
147}
Batch Clone Master Agreements¶
HTTP Request
POST /api/v1/master-agreements/batch-clone
📋 Description: Creates multiple cloned master agreements in the Nakisa Lease Accounting Suite, facilitating the efficient management of leases and contracts while ensuring accurate financial obligations and accounting entries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
false |
Request body containing the details of multiple master agreements to be cloned, including associated lease, contract, and financial obligation information for accurate accounting entry processing. |
Body Parameters
1{
2 "masterAgreementIds": [
3 0
4 ],
5 "year": 1900,
6 "leaseArea": {
7 "id": 10000001,
8 "displayId": "0001",
9 "status": {
10 "name": "ACTIVE",
11 "captionKey": "enum.objectStatus.active",
12 "active": true,
13 "caption": "Active"
14 },
15 "name": "Global Lease Area"
16 },
17 "businessUnit": {
18 "id": 10000001,
19 "displayId": "BU0001",
20 "status": {
21 "name": "ACTIVE",
22 "captionKey": "enum.objectStatus.active",
23 "active": true,
24 "caption": "Active"
25 },
26 "name": "North America Business Unit"
27 },
28 "internalAssetClass": {
29 "id": 10000001,
30 "displayId": "IAC-001",
31 "status": {
32 "name": "ACTIVE",
33 "captionKey": "enum.objectStatus.active",
34 "active": true,
35 "caption": "Active"
36 },
37 "name": "Machinery and Equipment",
38 "assetClassType": "PROPERTY",
39 "infiniteUsefulLife": false
40 }
41}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Master agreements successfully cloned in batch. |
Example Responses
1{
2 "code": "OK",
3 "errors": {
4 "all": []
5 },
6 "object": []
7}