Contract Subscription

Retrieves A Contract Subscription

HTTP Request

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

📋 Description: Retrieves detailed information about a specific contract subscription by its unique identifier, 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

10000044

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved a contract subscription

ResponseContractSubscriptionDto

400

Bad Request

Invalid input

None

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "topic": {
 9      "enCaption": "Lease Component Updated",
10      "frCaption": "Composant de bail mis à jour",
11      "name": "LEASE_COMPONENT_UPDATED",
12      "priority": "HIGH"
13    },
14    "username": "super.admin@nakisa.com",
15    "contractId": 10000001,
16    "contractDisplayId": "CT-100000000",
17    "targetId": "CT-100000000",
18    "targetType": "CONTRACT"
19  }
20}

Response Schema

Updates A Contract Subscription

HTTP Request

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

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

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

ContractSubscriptionDto

false

Request body containing the updated contract subscription details, including lease terms, financial obligations, and accounting entry adjustments.

Example Values

Parameter

Example

Type

id

10000001

path

Body Parameters

 1{
 2  "id": 10000001,
 3  "topic": {
 4    "enCaption": "Lease Component Updated",
 5    "frCaption": "Composant de bail mis à jour",
 6    "name": "LEASE_COMPONENT_UPDATED",
 7    "priority": "HIGH"
 8  },
 9  "username": "super.admin@nakisa.com",
10  "contractId": 10000001,
11  "contractDisplayId": "CT-100000000",
12  "targetId": "CT-100000000",
13  "targetType": "CONTRACT"
14}

Responses

Status

Meaning

Description

Schema

200

OK

contract subscription successfully updated.

ResponseContractSubscriptionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "topic": {
 9      "enCaption": "Lease Component Updated",
10      "frCaption": "Composant de bail mis à jour",
11      "name": "LEASE_COMPONENT_UPDATED",
12      "priority": "HIGH"
13    },
14    "username": "super.admin@nakisa.com",
15    "contractId": 10000001,
16    "contractDisplayId": "CT-100000000",
17    "targetId": "CT-100000000",
18    "targetType": "CONTRACT"
19  }
20}

Create Or Update A Contract Subscription

HTTP Request

PUT /api/v1/contract-subscription/createOrUpdate

📋 Description: Creates or updates a contract subscription within the Nakisa Lease Accounting Suite, ensuring accurate management of lease agreements and associated financial obligations for effective accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

ContractSubscriptionDto

false

Request body containing the lease contract subscription details, including financial obligations and accounting entries, for creation or updates within the Nakisa Lease Accounting Suite.

Body Parameters

 1{
 2  "id": 10000001,
 3  "topic": {
 4    "enCaption": "Lease Component Updated",
 5    "frCaption": "Composant de bail mis à jour",
 6    "name": "LEASE_COMPONENT_UPDATED",
 7    "priority": "HIGH"
 8  },
 9  "username": "super.admin@nakisa.com",
10  "contractId": 10000001,
11  "contractDisplayId": "CT-100000000",
12  "targetId": "CT-100000000",
13  "targetType": "CONTRACT"
14}

Responses

Status

Meaning

Description

Schema

200

OK

Successfully created or updated the contract subscription.

ResponseContractSubscriptionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "topic": {
 9      "enCaption": "Lease Component Updated",
10      "frCaption": "Composant de bail mis à jour",
11      "name": "LEASE_COMPONENT_UPDATED",
12      "priority": "HIGH"
13    },
14    "username": "super.admin@nakisa.com",
15    "contractId": 10000001,
16    "contractDisplayId": "CT-100000000",
17    "targetId": "CT-100000000",
18    "targetType": "CONTRACT"
19  }
20}

Creates Or Updates Contract Subscriptions In Bulk

HTTP Request

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

📋 Description: Creates or updates multiple contract subscriptions in bulk within the Nakisa Lease Accounting Suite, streamlining the management of lease-related financial obligations and accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

ContractSubscriptionDto

false

Request body containing bulk lease contract subscription data, including financial obligations and accounting entries, for creation or updates within the Nakisa Lease Accounting Suite.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "topic": {
 5      "enCaption": "Lease Component Updated",
 6      "frCaption": "Composant de bail mis à jour",
 7      "name": "LEASE_COMPONENT_UPDATED",
 8      "priority": "HIGH"
 9    },
10    "username": "super.admin@nakisa.com",
11    "contractId": 10000001,
12    "contractDisplayId": "CT-100000000",
13    "targetId": "CT-100000000",
14    "targetType": "CONTRACT"
15  }
16]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all contract subscription.

ResponseListContractSubscriptionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000001,
 9      "topic": {
10        "enCaption": "Lease Component Updated",
11        "frCaption": "Composant de bail mis à jour",
12        "name": "LEASE_COMPONENT_UPDATED",
13        "priority": "HIGH"
14      },
15      "username": "super.admin@nakisa.com",
16      "contractId": 10000001,
17      "contractDisplayId": "CT-100000000",
18      "targetId": "CT-100000000",
19      "targetType": "CONTRACT"
20    }
21  ]
22}

Updates Contract Subscriptions In Bulk

HTTP Request

PUT /api/v1/contract-subscription/bulk

📋 Description: Updates multiple contract subscriptions in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of lease agreements and associated financial obligations.

Parameters

Name

In

Type

Required

Description

body

body

ContractSubscriptionDto

false

Request body containing an array of contract subscription data, including lease details, financial obligations, and associated accounting entries for bulk processing.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "topic": {
 5      "enCaption": "Lease Component Updated",
 6      "frCaption": "Composant de bail mis à jour",
 7      "name": "LEASE_COMPONENT_UPDATED",
 8      "priority": "HIGH"
 9    },
10    "username": "super.admin@nakisa.com",
11    "contractId": 10000001,
12    "contractDisplayId": "CT-100000000",
13    "targetId": "CT-100000000",
14    "targetType": "CONTRACT"
15  }
16]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all contract subscriptions.

ResponseListContractSubscriptionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000001,
 9      "topic": {
10        "enCaption": "Lease Component Updated",
11        "frCaption": "Composant de bail mis à jour",
12        "name": "LEASE_COMPONENT_UPDATED",
13        "priority": "HIGH"
14      },
15      "username": "super.admin@nakisa.com",
16      "contractId": 10000001,
17      "contractDisplayId": "CT-100000000",
18      "targetId": "CT-100000000",
19      "targetType": "CONTRACT"
20    }
21  ]
22}

Search Contract Subscription

HTTP Request

POST /api/v1/contract-subscription/search

📋 Description: Submits a request to search for contract subscriptions within the Nakisa Lease Accounting Suite, enabling users to identify relevant leases and financial obligations associated with 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

ContractSubscriptionDtoFilter

false

Request body containing the search criteria for lease and contract subscriptions, including relevant financial obligations and accounting entry parameters.

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": "SUB-2025-%",
 9  "createdAtGreaterThanOrEqual": "2025-01-01T00:00:00Z",
10  "createdAtLessThanOrEqual": "2025-12-31T23:59:59Z",
11  "createdByLike": "admin%",
12  "createdByEqual": "adminUser",
13  "modifiedAtGreaterThanOrEqual": "2025-06-01T00:00:00Z",
14  "modifiedAtLessThanOrEqual": "2025-07-01T00:00:00Z",
15  "modifiedByLike": "editor%",
16  "modifiedByEqual": "editorUser",
17  "topicEqual": {
18    "enCaption": "Lease Component Updated",
19    "frCaption": "Composant de bail mis à jour",
20    "name": "LEASE_COMPONENT_UPDATED",
21    "priority": "HIGH"
22  },
23  "usernameLike": "jdoe%",
24  "contractIdEqual": 200045,
25  "contractDisplayIdEqual": "CTR-2025-001",
26  "contractDisplayIdLike": "CTR-2025-%"
27}

Responses

Status

Meaning

Description

Schema

200

OK

Search results successfully returned.

PageContractSubscriptionDto

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": 10000001,
21      "topic": {
22        "enCaption": "Lease Component Updated",
23        "frCaption": "Composant de bail mis à jour",
24        "name": "LEASE_COMPONENT_UPDATED",
25        "priority": "HIGH"
26      },
27      "username": "super.admin@nakisa.com",
28      "contractId": 10000001,
29      "contractDisplayId": "CT-100000000",
30      "targetId": "CT-100000000",
31      "targetType": "CONTRACT"
32    }
33  ],
34  "number": 0,
35  "sort": {
36    "unsorted": false,
37    "sorted": true,
38    "empty": false
39  },
40  "first": true,
41  "last": true,
42  "empty": false
43}

List All Contract Subscriptions

HTTP Request

GET /api/v1/contract-subscription

📋 Description: Fetches contract subscription details related to lease agreements, enabling users to manage financial obligations and accounting entries efficiently within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Indicates whether the results of the contract subscription retrieval should be paginated, facilitating efficient management of lease and contract data within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of contract subscription.

PageContractSubscriptionDto

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": 10000001,
21      "topic": {
22        "enCaption": "Lease Component Updated",
23        "frCaption": "Composant de bail mis à jour",
24        "name": "LEASE_COMPONENT_UPDATED",
25        "priority": "HIGH"
26      },
27      "username": "super.admin@nakisa.com",
28      "contractId": 10000001,
29      "contractDisplayId": "CT-100000000",
30      "targetId": "CT-100000000",
31      "targetType": "CONTRACT"
32    }
33  ],
34  "number": 0,
35  "sort": {
36    "unsorted": false,
37    "sorted": true,
38    "empty": false
39  },
40  "first": true,
41  "last": true,
42  "empty": false
43}