Lease Component Subscription

Retrieves A Specific Lease Component Subscription

HTTP Request

GET /api/v1/lease-component-subscription/{id}

📋 Description: Retrieves detailed information about a specific lease component subscription by its unique identifier, facilitating effective management of 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 lease component subscription.

ResponseLeaseComponentSubscriptionDto

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    "leaseComponentId": 10000006,
16    "leaseComponentDisplayId": "LC-100000100",
17    "targetId": "10000001",
18    "targetType": "LEASE_COMPONENT"
19  }
20}

Update A Specified Lease Component Subscription

HTTP Request

PUT /api/v1/lease-component-subscription/{id}

📋 Description: Updates the details of a specific lease component subscription identified by the provided ID, allowing for modifications to financial obligations and accounting entries within the Nakisa Lease Accounting Suite. This operation ensures that lease and contract information remains accurate and up-to-date.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

LeaseComponentSubscriptionDto

false

Request body containing the updated lease component subscription details, including financial obligations and contract terms relevant to accounting entries.

Example Values

Parameter

Example

Type

id

10000086

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  "leaseComponentId": 10000006,
11  "leaseComponentDisplayId": "LC-100000100",
12  "targetId": "10000001",
13  "targetType": "LEASE_COMPONENT"
14}

Responses

Status

Meaning

Description

Schema

200

OK

lease component subscription successfully updated.

ResponseLeaseComponentSubscriptionDto

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    "leaseComponentId": 10000006,
16    "leaseComponentDisplayId": "LC-100000100",
17    "targetId": "10000001",
18    "targetType": "LEASE_COMPONENT"
19  }
20}

Create Or Update A Lease Component Subscription

HTTP Request

PUT /api/v1/lease-component-subscription/createOrUpdate

📋 Description: Creates or updates a lease component subscription within the Nakisa Lease Accounting Suite, ensuring accurate management of financial obligations and accounting entries associated with lease contracts.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentSubscriptionDto

false

Request body containing the lease component subscription data, including details of the lease, associated contracts, financial obligations, and accounting entries for creation or update purposes.

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  "leaseComponentId": 10000006,
11  "leaseComponentDisplayId": "LC-100000100",
12  "targetId": "10000001",
13  "targetType": "LEASE_COMPONENT"
14}

Responses

Status

Meaning

Description

Schema

200

OK

Successfully created or updated the lease component subscription.

ResponseLeaseComponentSubscriptionDto

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    "leaseComponentId": 10000006,
16    "leaseComponentDisplayId": "LC-100000100",
17    "targetId": "10000001",
18    "targetType": "LEASE_COMPONENT"
19  }
20}

Creates Or Updates Lease Component Subscription In Bulk

HTTP Request

PUT /api/v1/lease-component-subscription/createOrUpdate/bulk

📋 Description: Creates or updates multiple lease component subscriptions in bulk, facilitating efficient management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentSubscriptionDto

false

Request body containing bulk lease component subscription data, including details on contracts, financial obligations, and associated accounting entries for efficient processing 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    "leaseComponentId": 10000006,
12    "leaseComponentDisplayId": "LC-100000100",
13    "targetId": "10000001",
14    "targetType": "LEASE_COMPONENT"
15  }
16]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all lease component subscriptions.

ResponseListLeaseComponentSubscriptionDto

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      "leaseComponentId": 10000006,
17      "leaseComponentDisplayId": "LC-100000100",
18      "targetId": "10000001",
19      "targetType": "LEASE_COMPONENT"
20    }
21  ]
22}

Updates Lease Component Subscriptions In Bulk

HTTP Request

PUT /api/v1/lease-component-subscription/bulk

📋 Description: Updates multiple lease component subscriptions in bulk, allowing for efficient management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

LeaseComponentSubscriptionDto

false

Request body containing a bulk array of lease component subscription data, including details on financial obligations and accounting entries related to lease contracts.

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    "leaseComponentId": 10000006,
12    "leaseComponentDisplayId": "LC-100000100",
13    "targetId": "10000001",
14    "targetType": "LEASE_COMPONENT"
15  }
16]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all lease component subscriptions.

ResponseListLeaseComponentSubscriptionDto

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      "leaseComponentId": 10000006,
17      "leaseComponentDisplayId": "LC-100000100",
18      "targetId": "10000001",
19      "targetType": "LEASE_COMPONENT"
20    }
21  ]
22}

Search Lease Component Subscription

HTTP Request

POST /api/v1/lease-component-subscription/search

📋 Description: Submits a search request for lease component subscriptions within the Nakisa Lease Accounting Suite, enabling users to identify relevant leases, 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

LeaseComponentSubscriptionDtoFilter

false

Request body containing search criteria for lease component subscriptions, including relevant contract details and financial obligations for accurate accounting entry retrieval.

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    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "topicEqual": {
16    "enCaption": "Lease Component Updated",
17    "frCaption": "Composant de bail mis à jour",
18    "name": "LEASE_COMPONENT_UPDATED",
19    "priority": "HIGH"
20  },
21  "usernameLike": "string",
22  "leaseComponentIdEqual": 0,
23  "leaseComponentDisplayIdEqual": "string",
24  "leaseComponentDisplayIdLike": "string"
25}

Responses

Status

Meaning

Description

Schema

200

OK

Search results successfully returned.

PageLeaseComponentSubscriptionDto

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      "leaseComponentId": 10000006,
29      "leaseComponentDisplayId": "LC-100000100",
30      "targetId": "10000001",
31      "targetType": "LEASE_COMPONENT"
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 Lease Component Subscriptions

HTTP Request

GET /api/v1/lease-component-subscription

📋 Description: Retrieves lease component subscription details, providing insights into financial obligations and accounting entries associated with lease contracts within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Indicates whether the results of the lease component subscription query should be paginated, facilitating efficient retrieval of large datasets related to leases and financial obligations.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of lease component subscriptions.

PageLeaseComponentSubscriptionDto

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      "leaseComponentId": 10000006,
29      "leaseComponentDisplayId": "LC-100000100",
30      "targetId": "10000001",
31      "targetType": "LEASE_COMPONENT"
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}