NFS Application Default Value ConfigΒΆ

NFS Application Default Value Config - GetΒΆ

HTTP Request

GET /api/v1/application-default-values-config/{id}

πŸ“‹ Description: Retrieves the configuration of default values for a specified application identified by its unique ID, facilitating accurate lease, contract, and financial obligation management within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNfsDvConfigDto

NFS Application Default Value Config - UpdateΒΆ

HTTP Request

PUT /api/v1/application-default-values-config/{id}

πŸ“‹ Description: Updates the default values configuration for a specified application within the Nakisa Lease Accounting Suite, enabling users to manage lease, contract, and financial obligation settings effectively. This operation ensures that accounting entries are aligned with the latest business requirements.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

NfsDvConfigDto

true

Request body containing the updated default values configuration for lease, contract, and financial obligation management within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNfsDvConfigDto

NFS Application Default Value Config - DeleteΒΆ

HTTP Request

DELETE /api/v1/application-default-values-config/{id}

πŸ“‹ Description: Deletes the specified application default values configuration, ensuring that outdated or unnecessary settings are removed from the Nakisa Lease Accounting Suite, thereby maintaining accurate lease and contract management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

NFS Application Default Value Config - PatchΒΆ

HTTP Request

PATCH /api/v1/application-default-values-config/{id}

πŸ“‹ Description: Updates the default values configuration for a specified application within the Nakisa Lease Accounting Suite, enabling users to adjust lease, contract, and financial obligation parameters to align with accounting requirements.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

JsonPatch

true

Request body containing the updated default values configuration for lease, contract, and financial obligation management within the Nakisa Lease Accounting Suite.

Example ValuesΒΆ

Parameter

Example

Type

body

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

body

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNfsDvConfigDto

NFS Application Default Value Config - Create Or Update BulkΒΆ

HTTP Request

PUT /api/v1/application-default-values-config/createOrUpdate/bulk

πŸ“‹ Description: Creates or updates multiple application default values configurations in the Nakisa Lease Accounting Suite, ensuring accurate management of lease, contract, financial obligation, and accounting entry data.

Parameters

Name

In

Type

Required

Description

body

body

NfsDvConfigDto

true

Request body containing bulk configuration data for lease, contract, and financial obligation default values, including relevant accounting entry parameters.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListNfsDvConfigDto

NFS Application Default Value Config - Create Or UpdateΒΆ

HTTP Request

PUT /api/v1/application-default-values-config/createOrUpdate

πŸ“‹ Description: Updates or creates default values configuration for lease accounting entries, ensuring accurate financial obligations and contract management within the Nakisa Lease Accounting Suite. This operation streamlines the setup process, enhancing the efficiency of accounting entries related to leases.

Parameters

Name

In

Type

Required

Description

body

body

NfsDvConfigDto

true

Request body containing the lease and contract configuration data, including financial obligations and accounting entry parameters for creating or updating application default values.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNfsDvConfigDto

NFS Application Default Value Config - Bulk UpdateΒΆ

HTTP Request

PUT /api/v1/application-default-values-config/bulk

πŸ“‹ Description: Updates multiple application default values configurations in bulk for lease, contract, financial obligation, and accounting entry management within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

NfsDvConfigDto

true

Request body containing bulk configuration data for default values related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListNfsDvConfigDto

NFS Application Default Value Config - Bulk DeleteΒΆ

HTTP Request

DELETE /api/v1/application-default-values-config/bulk

πŸ“‹ Description: Deletes multiple application default values configurations in the Nakisa Lease Accounting Suite, streamlining the management of lease, contract, and financial obligation data to ensure accurate accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of identifiers for lease and contract entries to be deleted in bulk from the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

NFS Application Default Value Config - Search Field EntityΒΆ

HTTP Request

POST /api/v1/application-default-values-config/search-entity

πŸ“‹ Description: Submits a request to search for entity configurations related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

object

false

Request body containing the search criteria and filters for retrieving default values related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.

Β» filter

body

NfsDvFieldDtoFilter

false

Data transfer object representing a filter for NFS DV fields within the Nakisa Lease Accounting Suite, facilitating the identification and management of lease, contract, financial obligation, and accounting entry data.

»» idIn

body

[integer]

false

Filter by multiple values of id

»» idEqual

body

integer(int64)

false

Filter by exact match of id

»» idLike

body

string

false

Filter by partial match of id

»» searchTerm

body

string

false

Search term used to filter and retrieve relevant leases, contracts, financial obligations, or accounting entries within the Nakisa Lease Accounting Suite.

»» typeEqual

body

string

false

Filter by exact match of type

»» contextFilters

body

[NfsDvFieldContextFilter]

false

List of contextFilters items

»»» type

body

string

false

Type of the resource

»»» ids

body

[string]

false

List of ids items

Β» pageable

body

Pageable

false

Data transfer object representing a paginated collection of lease-related records, including contracts, financial obligations, and accounting entries, facilitating efficient data retrieval and management within the Nakisa Lease Accounting Suite.

»» page

body

integer(int32)

true

Page number for pagination

»» size

body

integer(int32)

true

Number of items per page

»» sort

body

[string]

false

Sort order specification

Example ValuesΒΆ

Parameter

Example

Type

»» page

0

body

»» size

10

body

»» sort

["id,asc","name,desc"]

body

Enumerated Values

Attribute

Value

»» typeEqual

AG_CONSUMER_PRICE_INDEX, AG_CONSUMER_PRICE_INDEX_CATEGORY, AG_CONSUMER_PRICE_INDEX_CATEGORY_NON_LEASE, AG_CONSUMER_PRICE_INDEX_NON_LEASE, AG_EVENT_DISCOUNT_RATE_REVISION, AG_EVENT_MODIFICATION_REASONS, AG_REVISION_END_OF_TERM_INTENTION, CT_ASSET_VALUE_CURRENCY_TYPE, CT_BUSINESS_UNIT, CT_CALENDAR_TYPE, CT_COMPANY, CT_COMPOUNDING_FREQUENCY, CT_CURRENCY, CT_INDEXED_CURRENCY, CT_LEASE_AREA, CT_LEASE_DEPARTMENT, CT_LEASE_GROUP, CT_PRINCIPAL_POSITION_TYPE, CT_USE_IBR_RATE, FOS_ERP_SYSTEM, FOS_PRINCIPAL_POSITION_MODE, LC_INTERNAL_ASSET_CLASS, LC_UNIT_OF_MEASURE, LD_LEASE_TYPE, MA_BUSINESS_UNIT, MA_COMPANY, MA_LEASE_AREA, MA_LEASE_DEPARTMENT, MA_LEASE_GROUP, MICT_SKIP_ITEMS_WITH_OPEN_DRAFTS, MIJ_INDEXATION_DATE_TYPE, MIJ_INDEXATION_DATE_TYPE_NON_LEASE, MIJ_JOB_INDEXATION_TYPE, MIJ_JOB_INDEXATION_TYPE_NON_LEASE, MIJ_SKIP_ACTIVATION_GROUPS_WITH_OPEN_DRAFTS, MMJ_SKIP_ITEMS_WITH_OPEN_DRAFT, MPJ_SKIP_ACTIVATION_GROUPS_WITH_OPEN_DRAFTS, MWJ_ACCEPTS_HITCHHICKERS, MWJ_USE_DEFAULT_WORKBOOK_INPUT, TNC_AMOUNT_FREQUENCY, TNC_TERM_TYPE

»»» type

AG_CONSUMER_PRICE_INDEX, AG_CONSUMER_PRICE_INDEX_CATEGORY, AG_CONSUMER_PRICE_INDEX_CATEGORY_NON_LEASE, AG_CONSUMER_PRICE_INDEX_NON_LEASE, AG_EVENT_DISCOUNT_RATE_REVISION, AG_EVENT_MODIFICATION_REASONS, AG_REVISION_END_OF_TERM_INTENTION, CT_ASSET_VALUE_CURRENCY_TYPE, CT_BUSINESS_UNIT, CT_CALENDAR_TYPE, CT_COMPANY, CT_COMPOUNDING_FREQUENCY, CT_CURRENCY, CT_INDEXED_CURRENCY, CT_LEASE_AREA, CT_LEASE_DEPARTMENT, CT_LEASE_GROUP, CT_PRINCIPAL_POSITION_TYPE, CT_USE_IBR_RATE, FOS_ERP_SYSTEM, FOS_PRINCIPAL_POSITION_MODE, LC_INTERNAL_ASSET_CLASS, LC_UNIT_OF_MEASURE, LD_LEASE_TYPE, MA_BUSINESS_UNIT, MA_COMPANY, MA_LEASE_AREA, MA_LEASE_DEPARTMENT, MA_LEASE_GROUP, MICT_SKIP_ITEMS_WITH_OPEN_DRAFTS, MIJ_INDEXATION_DATE_TYPE, MIJ_INDEXATION_DATE_TYPE_NON_LEASE, MIJ_JOB_INDEXATION_TYPE, MIJ_JOB_INDEXATION_TYPE_NON_LEASE, MIJ_SKIP_ACTIVATION_GROUPS_WITH_OPEN_DRAFTS, MMJ_SKIP_ITEMS_WITH_OPEN_DRAFT, MPJ_SKIP_ACTIVATION_GROUPS_WITH_OPEN_DRAFTS, MWJ_ACCEPTS_HITCHHICKERS, MWJ_USE_DEFAULT_WORKBOOK_INPUT, TNC_AMOUNT_FREQUENCY, TNC_TERM_TYPE

Parameter ConstraintsΒΆ

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageDvFieldDto

NFS Application Default Value Config - Find AllΒΆ

HTTP Request

GET /api/v1/application-default-values-config

πŸ“‹ Description: Retrieves the default configuration values for lease accounting applications, facilitating the management of contracts and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the lease, contract, financial obligation, and accounting entry configurations should be returned in a paginated format.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageNfsDvConfigDto

NFS Application Default Value Config - CreateΒΆ

HTTP Request

POST /api/v1/application-default-values-config

πŸ“‹ Description: Creates and configures default values for lease accounting applications, ensuring accurate financial obligations and accounting entries are established for contracts.

Parameters

Name

In

Type

Required

Description

body

body

NfsDvConfigDto

true

Request body containing the configuration data for default values related to leases, contracts, financial obligations, and accounting entries within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNfsDvConfigDto

NFS Application Default Value Config - Get Default Values Config Status TypesΒΆ

HTTP Request

GET /api/v1/application-default-values-config/status-types

πŸ“‹ Description: Retrieves the status types for application default values configuration within the Nakisa Lease Accounting Suite, facilitating effective management of leases, contracts, financial obligations, and accounting entries.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListDvConfigStatusType

NFS Application Default Value Config - Get Default Values Allowed TypesΒΆ

HTTP Request

GET /api/v1/application-default-values-config/default-values-allowed-types

πŸ“‹ Description: Retrieves the allowed types of default values for lease, contract, financial obligation, and accounting entry configurations within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListIDvFieldType

NFS Application Default Value Config - Get Default Values Config Control TypesΒΆ

HTTP Request

GET /api/v1/application-default-values-config/control-types

πŸ“‹ Description: Retrieves the default configuration values for control types used in lease and contract management within the Nakisa Lease Accounting Suite, supporting accurate financial obligation tracking and accounting entries.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListDvConfigControlType