Contract Partner

Retrieves A Contract Partner

HTTP Request

GET /api/v1/contract-partners/{id}

📋 Description: Retrieves detailed information about a specific contract partner identified by the provided ID, facilitating effective management of leases and 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

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved contract partner.

ResponseContractPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000010,
 8    "displayId": "1382331350-20250820-173902",
 9    "partner": {
10      "id": 10000012,
11      "displayId": "0000100003",
12      "status": {
13        "name": "ACTIVE",
14        "captionKey": "enum.objectStatus.active",
15        "active": true,
16        "caption": "Active"
17      },
18      "name": "TEST VENDOR GB",
19      "erpSystemDisplayId": "FINQ8S-300"
20    },
21    "partnerRole": {
22      "id": 10000004,
23      "displayId": "40",
24      "status": {
25        "name": "ACTIVE",
26        "captionKey": "enum.objectStatus.active",
27        "active": true,
28        "caption": "Active"
29      },
30      "name": "Lessor"
31    },
32    "fromDate": "2019-08-24",
33    "toDate": "2019-08-24",
34    "masterAgreementPartnerId": 50000001,
35    "replacedPartner": {},
36    "replacedByPartner": {},
37    "parentContractPartnerId": 60000000,
38    "contractRevisionId": 10000044,
39    "contractId": 10000010,
40    "contractDisplayId": "CTR-0001",
41    "numberRangeIdentifierValue": "0001",
42    "numberRangeIdentifierType": {
43      "name": "COMPANY_CODE"
44    },
45    "numberRangeType": {
46      "name": "CONTRACT"
47    },
48    "allowsSystemGenerateNewId": false
49  }
50}

Update A Contract Partner

HTTP Request

PUT /api/v1/contract-partners/{id}

📋 Description: Updates the details of a specified contract partner within the Nakisa Lease Accounting Suite, ensuring accurate representation of lease agreements and financial obligations in accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

ContractPartnerDto

false

Request body containing updated contract partner information, including financial obligations and accounting entries, essential for accurate lease management within the Nakisa Lease Accounting Suite.

Example Values

Parameter

Example

Type

id

10000001

path

Body Parameters

  1{
  2  "id": 10000010,
  3  "displayId": "1382331350-20250820-173902",
  4  "partner": {
  5    "id": 10000012,
  6    "displayId": "0000100003",
  7    "status": {
  8      "name": "ACTIVE",
  9      "captionKey": "enum.objectStatus.active",
 10      "active": true,
 11      "caption": "Active"
 12    },
 13    "name": "TEST VENDOR GB",
 14    "erpSystemDisplayId": "FINQ8S-300"
 15  },
 16  "partnerRole": {
 17    "id": 10000004,
 18    "displayId": "40",
 19    "status": {
 20      "name": "ACTIVE",
 21      "captionKey": "enum.objectStatus.active",
 22      "active": true,
 23      "caption": "Active"
 24    },
 25    "name": "Lessor"
 26  },
 27  "fromDate": "2019-08-24",
 28  "toDate": "2019-08-24",
 29  "masterAgreementPartnerId": 50000001,
 30  "replacedPartner": {
 31    "id": 10000010,
 32    "displayId": "1382331350-20250820-173902",
 33    "partner": {
 34      "id": 10000012,
 35      "displayId": "0000100003",
 36      "status": {
 37        "name": "ACTIVE",
 38        "captionKey": "enum.objectStatus.active",
 39        "active": true,
 40        "caption": "Active"
 41      },
 42      "name": "TEST VENDOR GB",
 43      "erpSystemDisplayId": "FINQ8S-300"
 44    },
 45    "partnerRole": {
 46      "id": 10000004,
 47      "displayId": "40",
 48      "status": {
 49        "name": "ACTIVE",
 50        "captionKey": "enum.objectStatus.active",
 51        "active": true,
 52        "caption": "Active"
 53      },
 54      "name": "Lessor"
 55    },
 56    "fromDate": "2019-08-24",
 57    "toDate": "2019-08-24",
 58    "masterAgreementPartnerId": 50000001,
 59    "replacedPartner": {},
 60    "replacedByPartner": {},
 61    "parentContractPartnerId": 60000000,
 62    "contractRevisionId": 10000044,
 63    "contractId": 10000010,
 64    "contractDisplayId": "CTR-0001",
 65    "numberRangeIdentifierValue": "0001",
 66    "numberRangeIdentifierType": {
 67      "name": "COMPANY_CODE"
 68    },
 69    "numberRangeType": {
 70      "name": "CONTRACT"
 71    },
 72    "allowsSystemGenerateNewId": false
 73  },
 74  "replacedByPartner": {
 75    "id": 10000010,
 76    "displayId": "1382331350-20250820-173902",
 77    "partner": {
 78      "id": 10000012,
 79      "displayId": "0000100003",
 80      "status": {
 81        "name": "ACTIVE",
 82        "captionKey": "enum.objectStatus.active",
 83        "active": true,
 84        "caption": "Active"
 85      },
 86      "name": "TEST VENDOR GB",
 87      "erpSystemDisplayId": "FINQ8S-300"
 88    },
 89    "partnerRole": {
 90      "id": 10000004,
 91      "displayId": "40",
 92      "status": {
 93        "name": "ACTIVE",
 94        "captionKey": "enum.objectStatus.active",
 95        "active": true,
 96        "caption": "Active"
 97      },
 98      "name": "Lessor"
 99    },
100    "fromDate": "2019-08-24",
101    "toDate": "2019-08-24",
102    "masterAgreementPartnerId": 50000001,
103    "replacedPartner": {},
104    "replacedByPartner": {},
105    "parentContractPartnerId": 60000000,
106    "contractRevisionId": 10000044,
107    "contractId": 10000010,
108    "contractDisplayId": "CTR-0001",
109    "numberRangeIdentifierValue": "0001",
110    "numberRangeIdentifierType": {
111      "name": "COMPANY_CODE"
112    },
113    "numberRangeType": {
114      "name": "CONTRACT"
115    },
116    "allowsSystemGenerateNewId": false
117  },
118  "parentContractPartnerId": 60000000,
119  "contractRevisionId": 10000044,
120  "contractId": 10000010,
121  "contractDisplayId": "CTR-0001",
122  "numberRangeIdentifierValue": "0001",
123  "numberRangeIdentifierType": {
124    "name": "COMPANY_CODE"
125  },
126  "numberRangeType": {
127    "name": "CONTRACT"
128  },
129  "allowsSystemGenerateNewId": false
130}

Responses

Status

Meaning

Description

Schema

200

OK

Master agreement successfully updated.

ResponseContractPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000010,
 8    "displayId": "1382331350-20250820-173902",
 9    "partner": {
10      "id": 10000012,
11      "displayId": "0000100003",
12      "status": {
13        "name": "ACTIVE",
14        "captionKey": "enum.objectStatus.active",
15        "active": true,
16        "caption": "Active"
17      },
18      "name": "TEST VENDOR GB",
19      "erpSystemDisplayId": "FINQ8S-300"
20    },
21    "partnerRole": {
22      "id": 10000004,
23      "displayId": "40",
24      "status": {
25        "name": "ACTIVE",
26        "captionKey": "enum.objectStatus.active",
27        "active": true,
28        "caption": "Active"
29      },
30      "name": "Lessor"
31    },
32    "fromDate": "2019-08-24",
33    "toDate": "2019-08-24",
34    "masterAgreementPartnerId": 50000001,
35    "replacedPartner": {},
36    "replacedByPartner": {},
37    "parentContractPartnerId": 60000000,
38    "contractRevisionId": 10000044,
39    "contractId": 10000010,
40    "contractDisplayId": "CTR-0001",
41    "numberRangeIdentifierValue": "0001",
42    "numberRangeIdentifierType": {
43      "name": "COMPANY_CODE"
44    },
45    "numberRangeType": {
46      "name": "CONTRACT"
47    },
48    "allowsSystemGenerateNewId": false
49  }
50}

Deletes A Specified Contract Partner

HTTP Request

DELETE /api/v1/contract-partners/{id}

📋 Description: Deletes a specified contract partner from the Nakisa Lease Accounting Suite, thereby removing associated financial obligations and accounting entries linked to the lease contract.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Example Values

Parameter

Example

Type

id

10000013

path

Responses

Status

Meaning

Description

Schema

200

OK

Contract Partner successfully deleted.

ResponseVoid

Example Responses

1{
2  "code": "OK",
3  "errors": {
4    "all": []
5  },
6  "object": {}
7}

Updates A Contract Partner

HTTP Request

PATCH /api/v1/contract-partners/{id}

📋 Description: Updates the details of a specified contract partner within the Nakisa Lease Accounting Suite, enabling users to modify lease-related information and financial obligations associated with accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

JsonPatch

false

Request body containing updated contract partner information, including lease details and financial obligations, to ensure accurate accounting entries within the Nakisa Lease Accounting Suite.

Example Values

Parameter

Example

Type

id

10000081

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 partner.

ResponseContractPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000010,
 8    "displayId": "1382331350-20250820-173902",
 9    "partner": {
10      "id": 10000012,
11      "displayId": "0000100003",
12      "status": {
13        "name": "ACTIVE",
14        "captionKey": "enum.objectStatus.active",
15        "active": true,
16        "caption": "Active"
17      },
18      "name": "TEST VENDOR GB",
19      "erpSystemDisplayId": "FINQ8S-300"
20    },
21    "partnerRole": {
22      "id": 10000004,
23      "displayId": "40",
24      "status": {
25        "name": "ACTIVE",
26        "captionKey": "enum.objectStatus.active",
27        "active": true,
28        "caption": "Active"
29      },
30      "name": "Lessor"
31    },
32    "fromDate": "2019-08-24",
33    "toDate": "2019-08-24",
34    "masterAgreementPartnerId": 50000001,
35    "replacedPartner": {},
36    "replacedByPartner": {},
37    "parentContractPartnerId": 60000000,
38    "contractRevisionId": 10000044,
39    "contractId": 10000010,
40    "contractDisplayId": "CTR-0001",
41    "numberRangeIdentifierValue": "0001",
42    "numberRangeIdentifierType": {
43      "name": "COMPANY_CODE"
44    },
45    "numberRangeType": {
46      "name": "CONTRACT"
47    },
48    "allowsSystemGenerateNewId": false
49  }
50}

Creates Or Updates A Contract Partner

HTTP Request

PUT /api/v1/contract-partners/createOrUpdate

📋 Description: Updates or creates contract partner records within the Nakisa Lease Accounting Suite, ensuring accurate management of lease-related financial obligations and accounting entries. This operation facilitates the seamless integration of contract partner data into the lease management process.

Parameters

Name

In

Type

Required

Description

body

body

ContractPartnerDto

false

Request body containing the lease and contract partner information, including financial obligations and accounting entry details, for creating or updating records in the Nakisa Lease Accounting Suite.

Body Parameters

  1{
  2  "id": 10000010,
  3  "displayId": "1382331350-20250820-173902",
  4  "partner": {
  5    "id": 10000012,
  6    "displayId": "0000100003",
  7    "status": {
  8      "name": "ACTIVE",
  9      "captionKey": "enum.objectStatus.active",
 10      "active": true,
 11      "caption": "Active"
 12    },
 13    "name": "TEST VENDOR GB",
 14    "erpSystemDisplayId": "FINQ8S-300"
 15  },
 16  "partnerRole": {
 17    "id": 10000004,
 18    "displayId": "40",
 19    "status": {
 20      "name": "ACTIVE",
 21      "captionKey": "enum.objectStatus.active",
 22      "active": true,
 23      "caption": "Active"
 24    },
 25    "name": "Lessor"
 26  },
 27  "fromDate": "2019-08-24",
 28  "toDate": "2019-08-24",
 29  "masterAgreementPartnerId": 50000001,
 30  "replacedPartner": {
 31    "id": 10000010,
 32    "displayId": "1382331350-20250820-173902",
 33    "partner": {
 34      "id": 10000012,
 35      "displayId": "0000100003",
 36      "status": {
 37        "name": "ACTIVE",
 38        "captionKey": "enum.objectStatus.active",
 39        "active": true,
 40        "caption": "Active"
 41      },
 42      "name": "TEST VENDOR GB",
 43      "erpSystemDisplayId": "FINQ8S-300"
 44    },
 45    "partnerRole": {
 46      "id": 10000004,
 47      "displayId": "40",
 48      "status": {
 49        "name": "ACTIVE",
 50        "captionKey": "enum.objectStatus.active",
 51        "active": true,
 52        "caption": "Active"
 53      },
 54      "name": "Lessor"
 55    },
 56    "fromDate": "2019-08-24",
 57    "toDate": "2019-08-24",
 58    "masterAgreementPartnerId": 50000001,
 59    "replacedPartner": {},
 60    "replacedByPartner": {},
 61    "parentContractPartnerId": 60000000,
 62    "contractRevisionId": 10000044,
 63    "contractId": 10000010,
 64    "contractDisplayId": "CTR-0001",
 65    "numberRangeIdentifierValue": "0001",
 66    "numberRangeIdentifierType": {
 67      "name": "COMPANY_CODE"
 68    },
 69    "numberRangeType": {
 70      "name": "CONTRACT"
 71    },
 72    "allowsSystemGenerateNewId": false
 73  },
 74  "replacedByPartner": {
 75    "id": 10000010,
 76    "displayId": "1382331350-20250820-173902",
 77    "partner": {
 78      "id": 10000012,
 79      "displayId": "0000100003",
 80      "status": {
 81        "name": "ACTIVE",
 82        "captionKey": "enum.objectStatus.active",
 83        "active": true,
 84        "caption": "Active"
 85      },
 86      "name": "TEST VENDOR GB",
 87      "erpSystemDisplayId": "FINQ8S-300"
 88    },
 89    "partnerRole": {
 90      "id": 10000004,
 91      "displayId": "40",
 92      "status": {
 93        "name": "ACTIVE",
 94        "captionKey": "enum.objectStatus.active",
 95        "active": true,
 96        "caption": "Active"
 97      },
 98      "name": "Lessor"
 99    },
100    "fromDate": "2019-08-24",
101    "toDate": "2019-08-24",
102    "masterAgreementPartnerId": 50000001,
103    "replacedPartner": {},
104    "replacedByPartner": {},
105    "parentContractPartnerId": 60000000,
106    "contractRevisionId": 10000044,
107    "contractId": 10000010,
108    "contractDisplayId": "CTR-0001",
109    "numberRangeIdentifierValue": "0001",
110    "numberRangeIdentifierType": {
111      "name": "COMPANY_CODE"
112    },
113    "numberRangeType": {
114      "name": "CONTRACT"
115    },
116    "allowsSystemGenerateNewId": false
117  },
118  "parentContractPartnerId": 60000000,
119  "contractRevisionId": 10000044,
120  "contractId": 10000010,
121  "contractDisplayId": "CTR-0001",
122  "numberRangeIdentifierValue": "0001",
123  "numberRangeIdentifierType": {
124    "name": "COMPANY_CODE"
125  },
126  "numberRangeType": {
127    "name": "CONTRACT"
128  },
129  "allowsSystemGenerateNewId": false
130}

Responses

Status

Meaning

Description

Schema

200

OK

Successfully created or updated the contract partner.

ResponseContractPartnerDto

400

Bad Request

Invalid input

None

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000010,
 8    "displayId": "1382331350-20250820-173902",
 9    "partner": {
10      "id": 10000012,
11      "displayId": "0000100003",
12      "status": {
13        "name": "ACTIVE",
14        "captionKey": "enum.objectStatus.active",
15        "active": true,
16        "caption": "Active"
17      },
18      "name": "TEST VENDOR GB",
19      "erpSystemDisplayId": "FINQ8S-300"
20    },
21    "partnerRole": {
22      "id": 10000004,
23      "displayId": "40",
24      "status": {
25        "name": "ACTIVE",
26        "captionKey": "enum.objectStatus.active",
27        "active": true,
28        "caption": "Active"
29      },
30      "name": "Lessor"
31    },
32    "fromDate": "2019-08-24",
33    "toDate": "2019-08-24",
34    "masterAgreementPartnerId": 50000001,
35    "replacedPartner": {},
36    "replacedByPartner": {},
37    "parentContractPartnerId": 60000000,
38    "contractRevisionId": 10000044,
39    "contractId": 10000010,
40    "contractDisplayId": "CTR-0001",
41    "numberRangeIdentifierValue": "0001",
42    "numberRangeIdentifierType": {
43      "name": "COMPANY_CODE"
44    },
45    "numberRangeType": {
46      "name": "CONTRACT"
47    },
48    "allowsSystemGenerateNewId": false
49  }
50}

Response Schema

Creates Or Updates Multiple Contract Partners In Bulk.

HTTP Request

PUT /api/v1/contract-partners/createOrUpdate/bulk

📋 Description: Creates or updates multiple contract partner records in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of lease agreements and financial obligations.

Parameters

Name

In

Type

Required

Description

body

body

ContractPartnerDto

false

Request body containing a bulk array of contract partner data, including lease details, financial obligations, and associated accounting entries for creation or update within the Nakisa Lease Accounting Suite.

Body Parameters

 1[
 2  {
 3    "id": 10000010,
 4    "displayId": "1382331350-20250820-173902",
 5    "partner": {
 6      "id": 10000012,
 7      "displayId": "0000100003",
 8      "status": {
 9        "name": "ACTIVE",
10        "captionKey": "enum.objectStatus.active",
11        "active": true,
12        "caption": "Active"
13      },
14      "name": "TEST VENDOR GB",
15      "erpSystemDisplayId": "FINQ8S-300"
16    },
17    "partnerRole": {
18      "id": 10000004,
19      "displayId": "40",
20      "status": {
21        "name": "ACTIVE",
22        "captionKey": "enum.objectStatus.active",
23        "active": true,
24        "caption": "Active"
25      },
26      "name": "Lessor"
27    },
28    "fromDate": "2019-08-24",
29    "toDate": "2019-08-24",
30    "masterAgreementPartnerId": 50000001,
31    "replacedPartner": {},
32    "replacedByPartner": {},
33    "parentContractPartnerId": 60000000,
34    "contractRevisionId": 10000044,
35    "contractId": 10000010,
36    "contractDisplayId": "CTR-0001",
37    "numberRangeIdentifierValue": "0001",
38    "numberRangeIdentifierType": {
39      "name": "COMPANY_CODE"
40    },
41    "numberRangeType": {
42      "name": "CONTRACT"
43    },
44    "allowsSystemGenerateNewId": false
45  }
46]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all contract partners.

ResponseListContractPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000010,
 9      "displayId": "1382331350-20250820-173902",
10      "partner": {
11        "id": 10000012,
12        "displayId": "0000100003",
13        "status": {
14          "name": "ACTIVE",
15          "captionKey": "enum.objectStatus.active",
16          "active": true,
17          "caption": "Active"
18        },
19        "name": "TEST VENDOR GB",
20        "erpSystemDisplayId": "FINQ8S-300"
21      },
22      "partnerRole": {
23        "id": 10000004,
24        "displayId": "40",
25        "status": {
26          "name": "ACTIVE",
27          "captionKey": "enum.objectStatus.active",
28          "active": true,
29          "caption": "Active"
30        },
31        "name": "Lessor"
32      },
33      "fromDate": "2019-08-24",
34      "toDate": "2019-08-24",
35      "masterAgreementPartnerId": 50000001,
36      "replacedPartner": {},
37      "replacedByPartner": {},
38      "parentContractPartnerId": 60000000,
39      "contractRevisionId": 10000044,
40      "contractId": 10000010,
41      "contractDisplayId": "CTR-0001",
42      "numberRangeIdentifierValue": "0001",
43      "numberRangeIdentifierType": {
44        "name": "COMPANY_CODE"
45      },
46      "numberRangeType": {
47        "name": "CONTRACT"
48      },
49      "allowsSystemGenerateNewId": false
50    }
51  ]
52}

Updates Multiple Contract Partners In Bulk.

HTTP Request

PUT /api/v1/contract-partners/bulk

📋 Description: Updates multiple contract partner records in the Nakisa Lease Accounting Suite, facilitating efficient management of lease-related financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

ContractPartnerDto

false

Request body containing a collection of contract partner data, including lease details, financial obligations, and associated accounting entries for bulk updates.

Body Parameters

 1[
 2  {
 3    "id": 10000010,
 4    "displayId": "1382331350-20250820-173902",
 5    "partner": {
 6      "id": 10000012,
 7      "displayId": "0000100003",
 8      "status": {
 9        "name": "ACTIVE",
10        "captionKey": "enum.objectStatus.active",
11        "active": true,
12        "caption": "Active"
13      },
14      "name": "TEST VENDOR GB",
15      "erpSystemDisplayId": "FINQ8S-300"
16    },
17    "partnerRole": {
18      "id": 10000004,
19      "displayId": "40",
20      "status": {
21        "name": "ACTIVE",
22        "captionKey": "enum.objectStatus.active",
23        "active": true,
24        "caption": "Active"
25      },
26      "name": "Lessor"
27    },
28    "fromDate": "2019-08-24",
29    "toDate": "2019-08-24",
30    "masterAgreementPartnerId": 50000001,
31    "replacedPartner": {},
32    "replacedByPartner": {},
33    "parentContractPartnerId": 60000000,
34    "contractRevisionId": 10000044,
35    "contractId": 10000010,
36    "contractDisplayId": "CTR-0001",
37    "numberRangeIdentifierValue": "0001",
38    "numberRangeIdentifierType": {
39      "name": "COMPANY_CODE"
40    },
41    "numberRangeType": {
42      "name": "CONTRACT"
43    },
44    "allowsSystemGenerateNewId": false
45  }
46]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all contract partners.

ResponseListContractPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000010,
 9      "displayId": "1382331350-20250820-173902",
10      "partner": {
11        "id": 10000012,
12        "displayId": "0000100003",
13        "status": {
14          "name": "ACTIVE",
15          "captionKey": "enum.objectStatus.active",
16          "active": true,
17          "caption": "Active"
18        },
19        "name": "TEST VENDOR GB",
20        "erpSystemDisplayId": "FINQ8S-300"
21      },
22      "partnerRole": {
23        "id": 10000004,
24        "displayId": "40",
25        "status": {
26          "name": "ACTIVE",
27          "captionKey": "enum.objectStatus.active",
28          "active": true,
29          "caption": "Active"
30        },
31        "name": "Lessor"
32      },
33      "fromDate": "2019-08-24",
34      "toDate": "2019-08-24",
35      "masterAgreementPartnerId": 50000001,
36      "replacedPartner": {},
37      "replacedByPartner": {},
38      "parentContractPartnerId": 60000000,
39      "contractRevisionId": 10000044,
40      "contractId": 10000010,
41      "contractDisplayId": "CTR-0001",
42      "numberRangeIdentifierValue": "0001",
43      "numberRangeIdentifierType": {
44        "name": "COMPANY_CODE"
45      },
46      "numberRangeType": {
47        "name": "CONTRACT"
48      },
49      "allowsSystemGenerateNewId": false
50    }
51  ]
52}

Creates Multiple Contract Partners In Bulk.

HTTP Request

POST /api/v1/contract-partners/bulk

📋 Description: Facilitates the bulk creation of contract partner records within the Nakisa Lease Accounting Suite, enabling efficient management of lease-related financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

ContractPartnerDto

false

Request body containing bulk data for lease contract partners, including essential details for financial obligations and accounting entries.

Body Parameters

 1[
 2  {
 3    "id": 10000010,
 4    "displayId": "1382331350-20250820-173902",
 5    "partner": {
 6      "id": 10000012,
 7      "displayId": "0000100003",
 8      "status": {
 9        "name": "ACTIVE",
10        "captionKey": "enum.objectStatus.active",
11        "active": true,
12        "caption": "Active"
13      },
14      "name": "TEST VENDOR GB",
15      "erpSystemDisplayId": "FINQ8S-300"
16    },
17    "partnerRole": {
18      "id": 10000004,
19      "displayId": "40",
20      "status": {
21        "name": "ACTIVE",
22        "captionKey": "enum.objectStatus.active",
23        "active": true,
24        "caption": "Active"
25      },
26      "name": "Lessor"
27    },
28    "fromDate": "2019-08-24",
29    "toDate": "2019-08-24",
30    "masterAgreementPartnerId": 50000001,
31    "replacedPartner": {},
32    "replacedByPartner": {},
33    "parentContractPartnerId": 60000000,
34    "contractRevisionId": 10000044,
35    "contractId": 10000010,
36    "contractDisplayId": "CTR-0001",
37    "numberRangeIdentifierValue": "0001",
38    "numberRangeIdentifierType": {
39      "name": "COMPANY_CODE"
40    },
41    "numberRangeType": {
42      "name": "CONTRACT"
43    },
44    "allowsSystemGenerateNewId": false
45  }
46]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully created all contract partners.

ResponseListContractPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000010,
 9      "displayId": "1382331350-20250820-173902",
10      "partner": {
11        "id": 10000012,
12        "displayId": "0000100003",
13        "status": {
14          "name": "ACTIVE",
15          "captionKey": "enum.objectStatus.active",
16          "active": true,
17          "caption": "Active"
18        },
19        "name": "TEST VENDOR GB",
20        "erpSystemDisplayId": "FINQ8S-300"
21      },
22      "partnerRole": {
23        "id": 10000004,
24        "displayId": "40",
25        "status": {
26          "name": "ACTIVE",
27          "captionKey": "enum.objectStatus.active",
28          "active": true,
29          "caption": "Active"
30        },
31        "name": "Lessor"
32      },
33      "fromDate": "2019-08-24",
34      "toDate": "2019-08-24",
35      "masterAgreementPartnerId": 50000001,
36      "replacedPartner": {},
37      "replacedByPartner": {},
38      "parentContractPartnerId": 60000000,
39      "contractRevisionId": 10000044,
40      "contractId": 10000010,
41      "contractDisplayId": "CTR-0001",
42      "numberRangeIdentifierValue": "0001",
43      "numberRangeIdentifierType": {
44        "name": "COMPANY_CODE"
45      },
46      "numberRangeType": {
47        "name": "CONTRACT"
48      },
49      "allowsSystemGenerateNewId": false
50    }
51  ]
52}

Deletes Multiple Contract Partners By Their IDs.

HTTP Request

DELETE /api/v1/contract-partners/bulk

📋 Description: Deletes multiple contract partner entries in the Nakisa Lease Accounting Suite, facilitating the management of lease-related financial obligations and ensuring accurate accounting records.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

Request body containing an array of contract partner identifiers to facilitate the bulk deletion of associated lease and financial obligation records within the Nakisa Lease Accounting Suite.

Body Parameters

1[
2  10000013
3]

Responses

Status

Meaning

Description

Schema

200

OK

Contract partners deleted.

ResponseVoid

Example Responses

1{
2  "code": "OK",
3  "errors": {
4    "all": []
5  },
6  "object": {}
7}

List All Contract Partners

HTTP Request

GET /api/v1/contract-partners

📋 Description: Retrieves a list of contract partners associated with lease agreements, providing essential information for managing financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Indicates whether the response should be paginated, allowing for efficient retrieval of contract partner data within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of contract Partners.

PageContractPartnerDto

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": 10000010,
21      "displayId": "1382331350-20250820-173902",
22      "partner": {
23        "id": 10000012,
24        "displayId": "0000100003",
25        "status": {
26          "name": "ACTIVE",
27          "captionKey": "enum.objectStatus.active",
28          "active": true,
29          "caption": "Active"
30        },
31        "name": "TEST VENDOR GB",
32        "erpSystemDisplayId": "FINQ8S-300"
33      },
34      "partnerRole": {
35        "id": 10000004,
36        "displayId": "40",
37        "status": {
38          "name": "ACTIVE",
39          "captionKey": "enum.objectStatus.active",
40          "active": true,
41          "caption": "Active"
42        },
43        "name": "Lessor"
44      },
45      "fromDate": "2019-08-24",
46      "toDate": "2019-08-24",
47      "masterAgreementPartnerId": 50000001,
48      "replacedPartner": {},
49      "replacedByPartner": {},
50      "parentContractPartnerId": 60000000,
51      "contractRevisionId": 10000044,
52      "contractId": 10000010,
53      "contractDisplayId": "CTR-0001",
54      "numberRangeIdentifierValue": "0001",
55      "numberRangeIdentifierType": {
56        "name": "COMPANY_CODE"
57      },
58      "numberRangeType": {
59        "name": "CONTRACT"
60      },
61      "allowsSystemGenerateNewId": false
62    }
63  ],
64  "number": 0,
65  "sort": {
66    "unsorted": false,
67    "sorted": true,
68    "empty": false
69  },
70  "first": true,
71  "last": false,
72  "empty": false
73}

Create Contract Partners

HTTP Request

POST /api/v1/contract-partners

📋 Description: Creates a new contract partner within the Nakisa Lease Accounting Suite, facilitating the management of lease agreements and associated financial obligations for accurate accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

ContractPartnerDto

false

Request body containing the contract partner details, including lease terms, financial obligations, and associated accounting entries essential for effective lease management.

Body Parameters

  1{
  2  "id": 10000010,
  3  "displayId": "1382331350-20250820-173902",
  4  "partner": {
  5    "id": 10000012,
  6    "displayId": "0000100003",
  7    "status": {
  8      "name": "ACTIVE",
  9      "captionKey": "enum.objectStatus.active",
 10      "active": true,
 11      "caption": "Active"
 12    },
 13    "name": "TEST VENDOR GB",
 14    "erpSystemDisplayId": "FINQ8S-300"
 15  },
 16  "partnerRole": {
 17    "id": 10000004,
 18    "displayId": "40",
 19    "status": {
 20      "name": "ACTIVE",
 21      "captionKey": "enum.objectStatus.active",
 22      "active": true,
 23      "caption": "Active"
 24    },
 25    "name": "Lessor"
 26  },
 27  "fromDate": "2019-08-24",
 28  "toDate": "2019-08-24",
 29  "masterAgreementPartnerId": 50000001,
 30  "replacedPartner": {
 31    "id": 10000010,
 32    "displayId": "1382331350-20250820-173902",
 33    "partner": {
 34      "id": 10000012,
 35      "displayId": "0000100003",
 36      "status": {
 37        "name": "ACTIVE",
 38        "captionKey": "enum.objectStatus.active",
 39        "active": true,
 40        "caption": "Active"
 41      },
 42      "name": "TEST VENDOR GB",
 43      "erpSystemDisplayId": "FINQ8S-300"
 44    },
 45    "partnerRole": {
 46      "id": 10000004,
 47      "displayId": "40",
 48      "status": {
 49        "name": "ACTIVE",
 50        "captionKey": "enum.objectStatus.active",
 51        "active": true,
 52        "caption": "Active"
 53      },
 54      "name": "Lessor"
 55    },
 56    "fromDate": "2019-08-24",
 57    "toDate": "2019-08-24",
 58    "masterAgreementPartnerId": 50000001,
 59    "replacedPartner": {},
 60    "replacedByPartner": {},
 61    "parentContractPartnerId": 60000000,
 62    "contractRevisionId": 10000044,
 63    "contractId": 10000010,
 64    "contractDisplayId": "CTR-0001",
 65    "numberRangeIdentifierValue": "0001",
 66    "numberRangeIdentifierType": {
 67      "name": "COMPANY_CODE"
 68    },
 69    "numberRangeType": {
 70      "name": "CONTRACT"
 71    },
 72    "allowsSystemGenerateNewId": false
 73  },
 74  "replacedByPartner": {
 75    "id": 10000010,
 76    "displayId": "1382331350-20250820-173902",
 77    "partner": {
 78      "id": 10000012,
 79      "displayId": "0000100003",
 80      "status": {
 81        "name": "ACTIVE",
 82        "captionKey": "enum.objectStatus.active",
 83        "active": true,
 84        "caption": "Active"
 85      },
 86      "name": "TEST VENDOR GB",
 87      "erpSystemDisplayId": "FINQ8S-300"
 88    },
 89    "partnerRole": {
 90      "id": 10000004,
 91      "displayId": "40",
 92      "status": {
 93        "name": "ACTIVE",
 94        "captionKey": "enum.objectStatus.active",
 95        "active": true,
 96        "caption": "Active"
 97      },
 98      "name": "Lessor"
 99    },
100    "fromDate": "2019-08-24",
101    "toDate": "2019-08-24",
102    "masterAgreementPartnerId": 50000001,
103    "replacedPartner": {},
104    "replacedByPartner": {},
105    "parentContractPartnerId": 60000000,
106    "contractRevisionId": 10000044,
107    "contractId": 10000010,
108    "contractDisplayId": "CTR-0001",
109    "numberRangeIdentifierValue": "0001",
110    "numberRangeIdentifierType": {
111      "name": "COMPANY_CODE"
112    },
113    "numberRangeType": {
114      "name": "CONTRACT"
115    },
116    "allowsSystemGenerateNewId": false
117  },
118  "parentContractPartnerId": 60000000,
119  "contractRevisionId": 10000044,
120  "contractId": 10000010,
121  "contractDisplayId": "CTR-0001",
122  "numberRangeIdentifierValue": "0001",
123  "numberRangeIdentifierType": {
124    "name": "COMPANY_CODE"
125  },
126  "numberRangeType": {
127    "name": "CONTRACT"
128  },
129  "allowsSystemGenerateNewId": false
130}

Responses

Status

Meaning

Description

Schema

200

OK

Contract Partner successfully created.

ResponseContractPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000010,
 8    "displayId": "1382331350-20250820-173902",
 9    "partner": {
10      "id": 10000012,
11      "displayId": "0000100003",
12      "status": {
13        "name": "ACTIVE",
14        "captionKey": "enum.objectStatus.active",
15        "active": true,
16        "caption": "Active"
17      },
18      "name": "TEST VENDOR GB",
19      "erpSystemDisplayId": "FINQ8S-300"
20    },
21    "partnerRole": {
22      "id": 10000004,
23      "displayId": "40",
24      "status": {
25        "name": "ACTIVE",
26        "captionKey": "enum.objectStatus.active",
27        "active": true,
28        "caption": "Active"
29      },
30      "name": "Lessor"
31    },
32    "fromDate": "2019-08-24",
33    "toDate": "2019-08-24",
34    "masterAgreementPartnerId": 50000001,
35    "replacedPartner": {},
36    "replacedByPartner": {},
37    "parentContractPartnerId": 60000000,
38    "contractRevisionId": 10000044,
39    "contractId": 10000010,
40    "contractDisplayId": "CTR-0001",
41    "numberRangeIdentifierValue": "0001",
42    "numberRangeIdentifierType": {
43      "name": "COMPANY_CODE"
44    },
45    "numberRangeType": {
46      "name": "CONTRACT"
47    },
48    "allowsSystemGenerateNewId": false
49  }
50}

Get Contract Partner Contacts

HTTP Request

GET /api/v1/contract-partners/{id}/contacts

📋 Description: Retrieves a list of contacts associated with a specific contract partner, facilitating effective management of lease-related financial obligations and accounting entries 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 Partner contacts.

ResponseListContactDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000001,
 9      "displayId": "CONT-0001",
10      "name": "Jane Doe",
11      "position": "Procurement Manager",
12      "email": "jane.doe@example.com",
13      "phone": "+49 123 456 7890",
14      "address": "123 Business St, Berlin, Germany",
15      "description": "Main point of contact for vendor negotiations.",
16      "group": "string",
17      "buildingName": "string",
18      "fax": "string",
19      "numberRangeIdentifierValue": "BU-01",
20      "numberRangeIdentifierType": {
21        "name": "COMPANY_CODE"
22      },
23      "numberRangeType": {
24        "name": "CONTRACT"
25      },
26      "allowsSystemGenerateNewId": true
27    }
28  ]
29}

Adds Contact To Contract Partner

HTTP Request

POST /api/v1/contract-partners/{id}/contacts

📋 Description: Creates a new contact associated with a specified contract partner, facilitating the management of lease-related communications and enhancing the accuracy of financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

ContactDto

false

Request body containing the contact information and details for the specified contract partner, essential for managing lease-related communications and financial obligations within the Nakisa Lease Accounting Suite.

Example Values

Parameter

Example

Type

id

10000001

path

Body Parameters

 1{
 2  "id": 10000001,
 3  "displayId": "CONT-0001",
 4  "name": "Jane Doe",
 5  "position": "Procurement Manager",
 6  "email": "jane.doe@example.com",
 7  "phone": "+49 123 456 7890",
 8  "address": "123 Business St, Berlin, Germany",
 9  "description": "Main point of contact for vendor negotiations.",
10  "group": "string",
11  "buildingName": "string",
12  "fax": "string",
13  "numberRangeIdentifierValue": "BU-01",
14  "numberRangeIdentifierType": {
15    "name": "COMPANY_CODE"
16  },
17  "numberRangeType": {
18    "name": "CONTRACT"
19  },
20  "allowsSystemGenerateNewId": true
21}

Responses

Status

Meaning

Description

Schema

200

OK

Contract Partner successfully created.

ResponseContactDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "CONT-0001",
 9    "name": "Jane Doe",
10    "position": "Procurement Manager",
11    "email": "jane.doe@example.com",
12    "phone": "+49 123 456 7890",
13    "address": "123 Business St, Berlin, Germany",
14    "description": "Main point of contact for vendor negotiations.",
15    "group": "string",
16    "buildingName": "string",
17    "fax": "string",
18    "numberRangeIdentifierValue": "BU-01",
19    "numberRangeIdentifierType": {
20      "name": "COMPANY_CODE"
21    },
22    "numberRangeType": {
23      "name": "CONTRACT"
24    },
25    "allowsSystemGenerateNewId": true
26  }
27}

Submits Contact To Contract Partner In Bulk

HTTP Request

POST /api/v1/contract-partners/{id}/contacts/bulk

📋 Description: Uploads multiple contact entries for a specified contract partner, facilitating efficient management of lease-related communications and ensuring accurate accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

ContactDto

true

Request body containing a collection of contact information for contract partners, facilitating the management of lease-related financial obligations and accounting entries.

Example Values

Parameter

Example

Type

id

10000001

path

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "displayId": "CONT-0001",
 5    "name": "Jane Doe",
 6    "position": "Procurement Manager",
 7    "email": "jane.doe@example.com",
 8    "phone": "+49 123 456 7890",
 9    "address": "123 Business St, Berlin, Germany",
10    "description": "Main point of contact for vendor negotiations.",
11    "group": "string",
12    "buildingName": "string",
13    "fax": "string",
14    "numberRangeIdentifierValue": "BU-01",
15    "numberRangeIdentifierType": {
16      "name": "COMPANY_CODE"
17    },
18    "numberRangeType": {
19      "name": "CONTRACT"
20    },
21    "allowsSystemGenerateNewId": true
22  }
23]

Responses

Status

Meaning

Description

Schema

200

OK

Contract Partner contacts successfully added.

ResponseListContactDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000001,
 9      "displayId": "CONT-0001",
10      "name": "Jane Doe",
11      "position": "Procurement Manager",
12      "email": "jane.doe@example.com",
13      "phone": "+49 123 456 7890",
14      "address": "123 Business St, Berlin, Germany",
15      "description": "Main point of contact for vendor negotiations.",
16      "group": "string",
17      "buildingName": "string",
18      "fax": "string",
19      "numberRangeIdentifierValue": "BU-01",
20      "numberRangeIdentifierType": {
21        "name": "COMPANY_CODE"
22      },
23      "numberRangeType": {
24        "name": "CONTRACT"
25      },
26      "allowsSystemGenerateNewId": true
27    }
28  ]
29}

Delete Contract Partner Contacts

HTTP Request

DELETE /api/v1/contract-partners/{id}/contacts/bulk

📋 Description: Deletes multiple contact entries associated with a specified contract partner, streamlining the management of lease-related financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

array[integer]

false

Request body containing an array of contact identifiers to be removed in bulk for the specified contract partner, facilitating efficient management of lease-related financial obligations within the Nakisa Lease Accounting Suite.

Example Values

Parameter

Example

Type

id

10000001

path

Body Parameters

1[
2  10000013
3]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully deleted Contract Partner contacts.

ResponseVoid

Example Responses

1{
2  "code": "OK",
3  "errors": {
4    "all": []
5  },
6  "object": {}
7}

Search Contract Partner

HTTP Request

POST /api/v1/contract-partners/search

📋 Description: Submits a search request for contract partners within the Nakisa Lease Accounting Suite, enabling users to identify relevant lease and financial obligation details 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

ContractPartnerDtoExtendedFilter

false

Request body containing search criteria and filters for identifying contract partners related to lease agreements and financial obligations within the Nakisa Lease Accounting Suite.

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    101,
 4    102,
 5    103
 6  ],
 7  "idEqual": 101,
 8  "idLike": "10%",
 9  "createdAtGreaterThanOrEqual": "2025-01-01T00:00:00Z",
10  "createdAtLessThanOrEqual": "2025-12-31T23:59:59Z",
11  "createdByLike": "admin%",
12  "createdByEqual": "system",
13  "modifiedAtGreaterThanOrEqual": "2025-03-01T00:00:00Z",
14  "modifiedAtLessThanOrEqual": "2025-03-31T23:59:59Z",
15  "modifiedByLike": "user%",
16  "modifiedByEqual": "jane.doe",
17  "displayIdIn": [
18    "CP-001",
19    "CP-002"
20  ],
21  "displayIdLike": "CP-%",
22  "partnerIdIn": [
23    2001,
24    2002
25  ],
26  "partnerDisplayIdIn": [
27    "P-001",
28    "P-002"
29  ],
30  "partnerRoleIdIn": [
31    3001,
32    3002
33  ],
34  "partnerRoleDisplayIdIn": [
35    "ROLE-01",
36    "ROLE-02"
37  ],
38  "replacedPartnerIdIn": [
39    4001,
40    4002
41  ],
42  "replacedPartnerIdEqual": 4001,
43  "replacedPartnerIdLike": "400%",
44  "replacedByPartnerIdIn": [
45    5001,
46    5002
47  ],
48  "replacedByPartnerIdEqual": 5001,
49  "replacedByPartnerIdLike": "500%",
50  "contractRevisionIdIn": [
51    6001,
52    6002
53  ],
54  "contractIdIn": [
55    7001,
56    7002
57  ],
58  "contractDisplayIdIn": [
59    "C-001",
60    "C-002"
61  ],
62  "effectiveDateRanges": [
63    {
64      "fromDate": "2019-08-24",
65      "toDate": "2019-08-24"
66    }
67  ]
68}

Responses

Status

Meaning

Description

Schema

200

OK

Search results successfully returned.

PageContractPartnerDto

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": 10000010,
21      "displayId": "1382331350-20250820-173902",
22      "partner": {
23        "id": 10000012,
24        "displayId": "0000100003",
25        "status": {
26          "name": "ACTIVE",
27          "captionKey": "enum.objectStatus.active",
28          "active": true,
29          "caption": "Active"
30        },
31        "name": "TEST VENDOR GB",
32        "erpSystemDisplayId": "FINQ8S-300"
33      },
34      "partnerRole": {
35        "id": 10000004,
36        "displayId": "40",
37        "status": {
38          "name": "ACTIVE",
39          "captionKey": "enum.objectStatus.active",
40          "active": true,
41          "caption": "Active"
42        },
43        "name": "Lessor"
44      },
45      "fromDate": "2019-08-24",
46      "toDate": "2019-08-24",
47      "masterAgreementPartnerId": 50000001,
48      "replacedPartner": {},
49      "replacedByPartner": {},
50      "parentContractPartnerId": 60000000,
51      "contractRevisionId": 10000044,
52      "contractId": 10000010,
53      "contractDisplayId": "CTR-0001",
54      "numberRangeIdentifierValue": "0001",
55      "numberRangeIdentifierType": {
56        "name": "COMPANY_CODE"
57      },
58      "numberRangeType": {
59        "name": "CONTRACT"
60      },
61      "allowsSystemGenerateNewId": false
62    }
63  ],
64  "number": 0,
65  "sort": {
66    "unsorted": false,
67    "sorted": true,
68    "empty": false
69  },
70  "first": true,
71  "last": false,
72  "empty": false
73}

Get Resource By ID (With Effective Dates)

HTTP Request

GET /api/v1/contract-partners/effective-dates/{contractRevisionId}

📋 Description: Retrieves the effective dates associated with a specific contract revision, providing essential information for managing lease agreements and ensuring accurate financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

contractRevisionId

path

integer

true

Unique identifier for the contract revision

Example Values

Parameter

Example

Type

contractRevisionId

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved Contract Partner effective dates .

Inline

Example Responses

1[
2  {
3    "fromDate": "2019-08-24",
4    "toDate": "2019-08-24"
5  }
6]

Response Schema

Status Code 200

ContractAccountingDto

Name

Type

Required

Restrictions

Description

anonymous

[ContractPartnerEffectiveDateRange]

false

none

ContractAccountingDto

» fromDate

string(date)

false

none

Date of the from

» toDate

string(date)

false

none

Date of the to

Get Resource By ID

HTTP Request

GET /api/v1/contract-partners/contract/{contractRevisionId}

📋 Description: Retrieves detailed information about contract partners associated with a specific contract revision, facilitating insights into lease agreements and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

contractRevisionId

path

integer

true

Unique identifier for the contract revision

pageable

query

Pageable

false

Indicates whether the results should be returned in a paginated format, facilitating efficient retrieval of contract partner data related to lease and financial obligations.

Example Values

Parameter

Example

Type

contractRevisionId

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved Contract Partner effective dates .

PageContractPartnerDto

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": 10000010,
21      "displayId": "1382331350-20250820-173902",
22      "partner": {
23        "id": 10000012,
24        "displayId": "0000100003",
25        "status": {
26          "name": "ACTIVE",
27          "captionKey": "enum.objectStatus.active",
28          "active": true,
29          "caption": "Active"
30        },
31        "name": "TEST VENDOR GB",
32        "erpSystemDisplayId": "FINQ8S-300"
33      },
34      "partnerRole": {
35        "id": 10000004,
36        "displayId": "40",
37        "status": {
38          "name": "ACTIVE",
39          "captionKey": "enum.objectStatus.active",
40          "active": true,
41          "caption": "Active"
42        },
43        "name": "Lessor"
44      },
45      "fromDate": "2019-08-24",
46      "toDate": "2019-08-24",
47      "masterAgreementPartnerId": 50000001,
48      "replacedPartner": {},
49      "replacedByPartner": {},
50      "parentContractPartnerId": 60000000,
51      "contractRevisionId": 10000044,
52      "contractId": 10000010,
53      "contractDisplayId": "CTR-0001",
54      "numberRangeIdentifierValue": "0001",
55      "numberRangeIdentifierType": {
56        "name": "COMPANY_CODE"
57      },
58      "numberRangeType": {
59        "name": "CONTRACT"
60      },
61      "allowsSystemGenerateNewId": false
62    }
63  ],
64  "number": 0,
65  "sort": {
66    "unsorted": false,
67    "sorted": true,
68    "empty": false
69  },
70  "first": true,
71  "last": false,
72  "empty": false
73}

Delete Contract

HTTP Request

DELETE /api/v1/contract-partners/contract/{contractRevisionId}

📋 Description: Deletes a specified contract revision from the Nakisa Lease Accounting Suite, thereby removing the associated financial obligations and accounting entries linked to the contract partner.

Parameters

Name

In

Type

Required

Description

contractRevisionId

path

integer

true

Unique identifier for the contract revision

Example Values

Parameter

Example

Type

contractRevisionId

10000013

path

Responses

Status

Meaning

Description

Schema

200

OK

Contract Partner successfully deleted.

ResponseVoid

Example Responses

1{
2  "code": "OK",
3  "errors": {
4    "all": []
5  },
6  "object": {}
7}

Remove A Contact From A Contract Partner

HTTP Request

DELETE /api/v1/contract-partners/{id}/contacts/{contactId}

📋 Description: Deletes a specific contact associated with a contract partner in the Nakisa Lease Accounting Suite, ensuring accurate management of lease-related financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

contactId

path

integer(int64)

true

Unique identifier for the contact

Responses

Status

Meaning

Description

Schema

200

OK

Contact successfully removed from contract partner.

ResponseVoid

Example Responses

1{
2  "code": "OK",
3  "errors": {
4    "all": []
5  },
6  "object": {}
7}