Activation Group

Get Resource By ID

HTTP Request

GET /api/v1/activation-groups/{id}

📋 Description: Retrieves detailed information about a specific activation group identified by its unique ID, facilitating effective management of leases, 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

10000004

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved activation group

ResponseActivationGroupDto

Update Resource

HTTP Request

PUT /api/v1/activation-groups/{id}

📋 Description: Updates the specified activation group within the Nakisa Lease Accounting Suite, allowing users to modify lease, contract, and financial obligation details associated with accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

ActivationGroupDto

false

Request body containing the updated activation group details, including lease and contract information, to reflect changes in financial obligations and accounting entries.

Example Values

Parameter

Example

Type

id

10000004

path

Responses

Status

Meaning

Description

Schema

200

OK

Activation group successfully updated.

ResponseActivationGroupDto

Partially Update Resource

HTTP Request

PATCH /api/v1/activation-groups/{id}

📋 Description: Updates the specified activation group in the Nakisa Lease Accounting Suite, allowing for modifications to lease-related contracts and financial obligations to ensure accurate accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

JsonPatch

false

Request body containing the updated activation group details, including lease and contract information relevant to financial obligations and accounting entries.

Example Values

Parameter

Example

Type

id

10000048

path

body

{"op":"replace","path":"/name","value":"patched contract"}

body

Responses

Status

Meaning

Description

Schema

200

OK

Successfully patched activation group.

ResponseActivationGroupDto

Update Activation Groups In Bulk

HTTP Request

PUT /api/v1/activation-groups/bulk

📋 Description: Updates multiple activation groups in the Nakisa Lease Accounting Suite, enabling efficient management of lease contracts and associated financial obligations within a single operation.

Parameters

Name

In

Type

Required

Description

body

body

ActivationGroupDto

false

Request body containing a collection of activation group data, including lease details, contract identifiers, and associated financial obligations for bulk processing within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

All activation groups successfully updated.

ResponseListActivationGroupDto

Search Activation Group

HTTP Request

POST /api/v1/activation-groups/search

📋 Description: Submits a request to search for activation groups within the Nakisa Lease Accounting Suite, enabling users to efficiently locate lease-related contracts 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

ActivationGroupDtoFilter

false

Request body containing search criteria for activation groups, including relevant lease, contract, and financial obligation details to facilitate 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

Responses

Status

Meaning

Description

Schema

200

OK

Search results successfully returned.

PageActivationGroupDto

List All Activation Groups

HTTP Request

GET /api/v1/activation-groups

📋 Description: Retrieves a list of activation groups within the Nakisa Lease Accounting Suite, providing essential data for managing leases, contracts, and associated financial obligations.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Indicates whether the results of the activation groups query should be returned in a paginated format, facilitating efficient data retrieval for lease and contract management.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of activation groups.

PageActivationGroupDto

Retrieves An Activation Group

HTTP Request

GET /api/v1/activation-groups/revision/{revisionId}

📋 Description: Retrieves the details of a specific activation group revision identified by the provided revision ID, facilitating effective management of lease contracts and associated financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

revisionId

path

integer

true

Unique identifier for the revision

Example Values

Parameter

Example

Type

revisionId

10000004

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved activation group

ResponseActivationGroupDto