Schedule

Schedule - Search Periods

HTTP Request

POST /api/v1/schedules/{principalPositionType}/{leaseMeasurementId}/periods/search

📋 Description: Submits a request to search for lease periods associated with a specific principal position type and lease measurement ID, facilitating the management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

leaseMeasurementId

path

integer(int64)

true

Unique identifier for the lease measurement

principalPositionType

path

string

true

Type of the principal position

body

body

object

true

Request body containing the search criteria and parameters for identifying lease periods associated with a specific principal position type and lease measurement ID, relevant for managing financial obligations and accounting entries.

» filter

body

any

false

none

»» anonymous

body

SchedulePeriodDtoFilter

false

Data transfer object representing a filter for schedule periods within the Nakisa Lease Accounting Suite, enabling users to refine lease, contract, and financial obligation queries for accurate accounting entry management.

»»» 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

»»» periodGreaterThanOrEqual

body

integer(int32)

false

Filter where period is greater than or equal to specified value

»»» periodLessThanOrEqual

body

integer(int32)

false

Filter where period is less than or equal to specified value

»»» periodStartDateGreaterThanOrEqual

body

StartOfDay

false

Data transfer object representing the initiation of daily processes within the Nakisa Lease Accounting Suite, encompassing lease contracts, financial obligations, and associated accounting entries.

»»»» timing

body

TimingTypeE

false

Represents the timing within a day for executing operations.

»»»»» name

body

string

false

Enum name representing the timing type.

»»»»» captionKey

body

string

false

Localization key for the timing type caption.

»»»»» caption

body

string

false

Localized caption of the timing type.

»»»» year

body

integer(int32)

false

Numeric value representing year

»»»» monthValue

body

integer(int32)

false

Numeric value representing monthValue

»»»» dayOfMonth

body

integer(int32)

false

Numeric value representing dayOfMonth

»»»» leapYear

body

boolean

false

Boolean flag indicating leapYear status

»»»» month

body

MonthE

false

Represents the months of the year.

»»»»» name

body

string

false

Enum name representing the month.

»»»»» captionKey

body

string

false

Localization key for the month caption.

»»»»» caption

body

string

false

Localized caption of the month.

»»»» dayOfWeek

body

DayOfWeekE

false

Represents the days of the week.

»»»»» name

body

string

false

Enum name representing the day of week.

»»»»» captionKey

body

string

false

Localization key for the day of week caption.

»»»»» caption

body

string

false

Localized caption of the day of week.

»»»» dayOfYear

body

integer(int32)

false

Numeric value representing dayOfYear

»»» periodStartDateLessThanOrEqual

body

StartOfDay

false

Data transfer object representing the initiation of daily processes within the Nakisa Lease Accounting Suite, encompassing lease contracts, financial obligations, and associated accounting entries.

»»» periodEndDateGreaterThanOrEqual

body

EndOfDay

false

Data transfer object representing the end-of-day financial summary for lease contracts, capturing accounting entries and financial obligations within the Nakisa Lease Accounting Suite.

»»»» timing

body

TimingTypeE

false

Represents the timing within a day for executing operations.

»»»» year

body

integer(int32)

false

Numeric value representing year

»»»» monthValue

body

integer(int32)

false

Numeric value representing monthValue

»»»» dayOfMonth

body

integer(int32)

false

Numeric value representing dayOfMonth

»»»» leapYear

body

boolean

false

Boolean flag indicating leapYear status

»»»» month

body

MonthE

false

Represents the months of the year.

»»»» dayOfWeek

body

DayOfWeekE

false

Represents the days of the week.

»»»» dayOfYear

body

integer(int32)

false

Numeric value representing dayOfYear

»»» periodEndDateLessThanOrEqual

body

EndOfDay

false

Data transfer object representing the end-of-day financial summary for lease contracts, capturing accounting entries and financial obligations within the Nakisa Lease Accounting Suite.

»»» leaseMeasurementIdIn

body

[integer]

false

Filter by multiple values of lease measurement id

»»» leaseMeasurementIdEqual

body

integer(int64)

false

Filter by exact match of lease measurement id

»»» type

body

string

false

Type of the resource

»» anonymous

body

LesseeSchedulePeriodDtoFilter

false

Data transfer object representing the filtering criteria for lessee schedule periods within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and associated financial obligations in accounting entries.

»»» 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

»»» periodGreaterThanOrEqual

body

integer(int32)

false

Filter where period is greater than or equal to specified value

»»» periodLessThanOrEqual

body

integer(int32)

false

Filter where period is less than or equal to specified value

»»» periodStartDateGreaterThanOrEqual

body

StartOfDay

false

Data transfer object representing the initiation of daily processes within the Nakisa Lease Accounting Suite, encompassing lease contracts, financial obligations, and associated accounting entries.

»»» periodStartDateLessThanOrEqual

body

StartOfDay

false

Data transfer object representing the initiation of daily processes within the Nakisa Lease Accounting Suite, encompassing lease contracts, financial obligations, and associated accounting entries.

»»» periodEndDateGreaterThanOrEqual

body

EndOfDay

false

Data transfer object representing the end-of-day financial summary for lease contracts, capturing accounting entries and financial obligations within the Nakisa Lease Accounting Suite.

»»» periodEndDateLessThanOrEqual

body

EndOfDay

false

Data transfer object representing the end-of-day financial summary for lease contracts, capturing accounting entries and financial obligations within the Nakisa Lease Accounting Suite.

»»» leaseMeasurementIdIn

body

[integer]

false

Filter by multiple values of lease measurement id

»»» leaseMeasurementIdEqual

body

integer(int64)

false

Filter by exact match of lease measurement id

»»» type

body

string

false

Type of the resource

»» anonymous

body

LessorSchedulePeriodDtoFilter

false

Data transfer object representing a filter for scheduling periods related to lessor agreements within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and associated financial obligations.

»»» 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

»»» periodGreaterThanOrEqual

body

integer(int32)

false

Filter where period is greater than or equal to specified value

»»» periodLessThanOrEqual

body

integer(int32)

false

Filter where period is less than or equal to specified value

»»» periodStartDateGreaterThanOrEqual

body

StartOfDay

false

Data transfer object representing the initiation of daily processes within the Nakisa Lease Accounting Suite, encompassing lease contracts, financial obligations, and associated accounting entries.

»»» periodStartDateLessThanOrEqual

body

StartOfDay

false

Data transfer object representing the initiation of daily processes within the Nakisa Lease Accounting Suite, encompassing lease contracts, financial obligations, and associated accounting entries.

»»» periodEndDateGreaterThanOrEqual

body

EndOfDay

false

Data transfer object representing the end-of-day financial summary for lease contracts, capturing accounting entries and financial obligations within the Nakisa Lease Accounting Suite.

»»» periodEndDateLessThanOrEqual

body

EndOfDay

false

Data transfer object representing the end-of-day financial summary for lease contracts, capturing accounting entries and financial obligations within the Nakisa Lease Accounting Suite.

»»» leaseMeasurementIdIn

body

[integer]

false

Filter by multiple values of lease measurement id

»»» leaseMeasurementIdEqual

body

integer(int64)

false

Filter by exact match of lease measurement id

»»» type

body

string

false

Type of the resource

» 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

»»»»» name

START_OF_DAY

body

»»»»» captionKey

enum.timingType.startOfDay

body

»»»»» caption

Start Of Day

body

»»»» year

100

body

»»»» monthValue

100

body

»»»» dayOfMonth

100

body

»»»» leapYear

false

body

»»»»» name

JANUARY

body

»»»»» captionKey

enum.month.january

body

»»»»» caption

January

body

»»»»» name

MONDAY

body

»»»»» captionKey

enum.dayOfWeek.monday

body

»»»»» caption

Monday

body

»»»» dayOfYear

100

body

»»»» year

100

body

»»»» monthValue

100

body

»»»» dayOfMonth

100

body

»»»» leapYear

false

body

»»»» dayOfYear

100

body

»» page

0

body

»» size

10

body

»» sort

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

body

Enumerated Values

Attribute

Value

»»»»» name

APRIL, AUGUST, DECEMBER, END_OF_DAY, FEBRUARY, FRIDAY, JANUARY, JULY, JUNE, MARCH, MAY, MONDAY, NOVEMBER, OCTOBER, SATURDAY, SEPTEMBER, START_OF_DAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageSchedulePeriodDto

Schedule - Get Remaining Balances

HTTP Request

POST /api/v1/schedules/remaining-balances

📋 Description: Submits a request to retrieve the remaining balances for leases and contracts, facilitating accurate tracking of financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

RemainingBalancesRequest

true

Request body containing the lease contract details and associated financial obligations necessary for calculating remaining balances in the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

RemainingBalancesResponse

Schedule - Get All

HTTP Request

GET /api/v1/schedules/{principalPositionType}

📋 Description: Retrieves schedules associated with a specified principal position type, facilitating effective management of leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

principalPositionType

path

string

true

Type of the principal position

pageable

query

Pageable

true

Indicates whether the results of the lease schedules query should be returned in a paginated format, facilitating efficient data retrieval and management of financial obligations and accounting entries.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageScheduleDto

Schedule - Get

HTTP Request

GET /api/v1/schedules/{principalPositionType}/{leaseMeasurementId}

📋 Description: Retrieves lease schedules associated with a specific principal position type and lease measurement ID, facilitating the management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

principalPositionType

path

string

true

Type of the principal position

leaseMeasurementId

path

integer(int64)

true

Unique identifier for the lease measurement

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseScheduleDto

Schedule - Get All Periods

HTTP Request

GET /api/v1/schedules/{principalPositionType}/{leaseMeasurementId}/periods

📋 Description: Retrieves lease periods associated with a specified principal position type and lease measurement ID, facilitating the management of financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

leaseMeasurementId

path

integer(int64)

true

Unique identifier for the lease measurement

principalPositionType

path

string

true

Type of the principal position

pageable

query

Pageable

true

Indicates whether the response should be paginated, facilitating efficient retrieval of lease period data within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageSchedulePeriodDto