NFS Report Profile

NFS Report Profile - Search

HTTP Request

POST /api/v1/nfs-reports/profile/search

Interactive Demo

📋 Description: Submits a request to search for NFS reports related to leases and contracts, enabling users to identify financial obligations and accounting entries efficiently.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing search criteria for lease and contract profiles, including relevant financial obligations and accounting entries.
» filter	body	ReportProfileDtoFilter	false	Data transfer object representing filters for generating reports within the Nakisa Lease Accounting Suite, focusing on lease, contract, financial obligation, and accounting entry data to enhance financial analysis and compliance.
»» 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
»» createdAtGreaterThanOrEqual	body	string(date-time)	false	Filter where created at is greater than or equal to specified value
»» createdAtLessThanOrEqual	body	string(date-time)	false	Filter where created at is less than or equal to specified value
»» createdByLike	body	string	false	Filter by partial match of created by
»» createdByEqual	body	string	false	Filter by exact match of created by
»» modifiedAtGreaterThanOrEqual	body	string(date-time)	false	Filter where modified at is greater than or equal to specified value
»» modifiedAtLessThanOrEqual	body	string(date-time)	false	Filter where modified at is less than or equal to specified value
»» modifiedByLike	body	string	false	Filter by partial match of modified by
»» modifiedByEqual	body	string	false	Filter by exact match of modified by
»» nameLike	body	string	false	Filter by partial match of name
»» principalPositionTypeEqual	body	string	false	Filter by exact match of principal position type
»» erpSystemFilterTypeIn	body	[string]	false	Filter by multiple values of erp system filter type
»» erpSystemsIn	body	[ErpSystemLiteDto]	false	Filter by multiple values of erp systems
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»»» name	body	string	false	Enum name representing the object status.
»»»» captionKey	body	string	false	Localization key for the object status caption.
»»»» active	body	boolean	false	Indicates whether the status is active.
»»»» caption	body	string	false	Localized caption of the object status.
»»» name	body	string	false	Name of the resource
»» leaseAreaFilterTypeIn	body	[string]	false	Filter by multiple values of lease area filter type
»» leaseAreasIn	body	[LeaseAreaLiteDto]	false	Filter by multiple values of lease areas
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» businessUnitFilterTypeIn	body	[string]	false	Filter by multiple values of business unit filter type
»» businessUnitsIn	body	[BusinessUnitLiteDto]	false	Filter by multiple values of business units
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» companyFilterTypeIn	body	[string]	false	Filter by multiple values of company filter type
»» companyCodesIn	body	[CompanyLiteDto]	false	Filter by multiple values of company codes
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» erpSystemId	body	integer(int64)	false	Unique identifier for the erp system
»»» erpSystemDisplayId	body	string	false	Unique identifier for the erp system display
»»» countryId	body	integer(int64)	false	Unique identifier for the country
»»» countryDisplayId	body	string	false	Unique identifier for the country display
»»» name	body	string	false	none
»» departmentFilterTypeIn	body	[string]	false	Filter by multiple values of department filter type
»» leaseDepartmentsIn	body	[DepartmentLiteDto]	false	Filter by multiple values of lease departments
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» leaseGroupFilterTypeIn	body	[string]	false	Filter by multiple values of lease group filter type
»» leaseGroupsIn	body	[LeaseGroupLiteDto]	false	Filter by multiple values of lease groups
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» costCenterFilterTypeIn	body	[string]	false	Filter by multiple values of cost center filter type
»» costCentersIn	body	[CostCenterLiteDto]	false	Filter by multiple values of cost centers
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» profitCenterFilterTypeIn	body	[string]	false	Filter by multiple values of profit center filter type
»» profitCentersIn	body	[ProfitCenterLiteDto]	false	Filter by multiple values of profit centers
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»»» validTo	body	string(date)	false	Date until which the resource is valid
»»» erpSystemId	body	integer(int64)	false	Unique identifier for the erp system
»»» erpSystemDisplayId	body	string	false	Unique identifier for the erp system display
»» workBreakdownStructureFilterTypeIn	body	[string]	false	Filter by multiple values of work breakdown structure filter type
»» workBreakdownStructuresIn	body	[WorkBreakdownStructureLiteDto]	false	Filter by multiple values of work breakdown structures
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» name	body	string	false	Name of the resource
»» objectStatusIn	body	[string]	false	Filter by multiple values of object status
»» securityProfileIdLike	body	string	false	Filter by partial match of security profile id
»» calendarTypeEqual	body	string	false	Filter by exact match of calendar type
»» fiscalVariantEqual	body	FiscalVariantLiteDto	false	Data transfer object representing a simplified fiscal variant within the Nakisa Lease Accounting Suite, encompassing essential details related to leases, contracts, financial obligations, and accounting entries.
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	Status	false	Represents the object status with localized captions and activity state.
»»» isCalendarYear	body	boolean	false	Whether the resource is calendar year
»»» yearDependent	body	boolean	false	Boolean flag indicating yearDependent status
»»» erpSystemDisplayId	body	string	false	Unique identifier for the erp system display
» 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
»»» id	10000001	body
»»» displayId	sample_displayId	body
»»»» name	ACTIVE	body
»»»» captionKey	enum.objectStatus.active	body
»»»» active	true	body
»»»» caption	Active	body
»»» name	Sample Name	body
»»» id	10000001	body
»»» displayId	sample_displayId	body
»»» name	Sample Name	body
»»» id	10000001	body
»»» displayId	sample_displayId	body
»»» name	Sample Name	body
»»» id	10000001	body
»»» displayId	sample_displayId	body
»»» erpSystemId	10000001	body
»»» erpSystemDisplayId	sample_erpSystemDisplayId	body
»»» countryId	10000001	body
»»» countryDisplayId	sample_countryDisplayId	body
»»» id	10000001	body
»»» displayId	sample_displayId	body
»»» name	Sample Name	body
»»» id	10000001	body
»»» displayId	sample_displayId	body
»»» name	Sample Name	body
»»» id	10000001	body
»»» displayId	sample_displayId	body
»»» name	Sample Name	body
»»» id	10000001	body
»»» displayId	sample_displayId	body
»»» name	Sample Name	body
»»» validTo	2025-01-01	body
»»» erpSystemId	10000001	body
»»» erpSystemDisplayId	sample_erpSystemDisplayId	body
»»» id	10000001	body
»»» displayId	sample_displayId	body
»»» name	Sample Name	body
»»» id	10000001	body
»»» displayId	sample_displayId	body
»»» isCalendarYear	true	body
»»» yearDependent	false	body
»»» erpSystemDisplayId	sample_erpSystemDisplayId	body
»» page	0	body
»» size	10	body
»» sort	["id,asc","name,desc"]	body

Enumerated Values

Attribute	Value
»» businessUnitFilterTypeIn	ALL, LIST
»» calendarTypeEqual	FISCAL_VARIANT, REGULAR_CALENDAR, _360
»» companyFilterTypeIn	ALL, LIST
»» costCenterFilterTypeIn	ALL, LIST
»» departmentFilterTypeIn	ALL, LIST
»» erpSystemFilterTypeIn	ALL, LIST
»» leaseAreaFilterTypeIn	ALL, LIST
»» leaseGroupFilterTypeIn	ALL, LIST
»» objectStatusIn	ACTIVE, CREATED, DECOMMISSIONED, DISABLED
»» principalPositionTypeEqual	LESSEE, LESSOR
»» profitCenterFilterTypeIn	ALL, LIST
»» workBreakdownStructureFilterTypeIn	ALL, LIST
»»»» name	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Parameter Constraints

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "filter": {
    "idIn": [
      0
    ],
    "idEqual": 0,
    "idLike": "string",
    "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "createdByLike": "string",
    "createdByEqual": "string",
    "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedByLike": "string",
    "modifiedByEqual": "string",
    "nameLike": "string",
    "principalPositionTypeEqual": "LESSEE",
    "erpSystemFilterTypeIn": [
      "ALL"
    ],
    "erpSystemsIn": [
      {
        "id": 10000001,
        "displayId": "sample_displayId",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Sample Name"
      }
    ],
    "leaseAreaFilterTypeIn": [
      "ALL"
    ],
    "leaseAreasIn": [
      {
        "id": 10000001,
        "displayId": "sample_displayId",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Sample Name"
      }
    ],
    "businessUnitFilterTypeIn": [
      "ALL"
    ],
    "businessUnitsIn": [
      {
        "id": 10000001,
        "displayId": "sample_displayId",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Sample Name"
      }
    ],
    "companyFilterTypeIn": [
      "ALL"
    ],
    "companyCodesIn": [
      {
        "id": 10000001,
        "displayId": "sample_displayId",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "erpSystemId": 10000001,
        "erpSystemDisplayId": "sample_erpSystemDisplayId",
        "countryId": 10000001,
        "countryDisplayId": "sample_countryDisplayId",
        "name": "string"
      }
    ],
    "departmentFilterTypeIn": [
      "ALL"
    ],
    "leaseDepartmentsIn": [
      {
        "id": 10000001,
        "displayId": "sample_displayId",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Sample Name"
      }
    ],
    "leaseGroupFilterTypeIn": [
      "ALL"
    ],
    "leaseGroupsIn": [
      {
        "id": 10000001,
        "displayId": "sample_displayId",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Sample Name"
      }
    ],
    "costCenterFilterTypeIn": [
      "ALL"
    ],
    "costCentersIn": [
      {
        "id": 10000001,
        "displayId": "sample_displayId",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Sample Name"
      }
    ],
    "profitCenterFilterTypeIn": [
      "ALL"
    ],
    "profitCentersIn": [
      {
        "id": 10000001,
        "displayId": "sample_displayId",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Sample Name",
        "validTo": "2025-01-01",
        "erpSystemId": 10000001,
        "erpSystemDisplayId": "sample_erpSystemDisplayId"
      }
    ],
    "workBreakdownStructureFilterTypeIn": [
      "ALL"
    ],
    "workBreakdownStructuresIn": [
      {
        "id": 10000001,
        "displayId": "sample_displayId",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "name": "Sample Name"
      }
    ],
    "objectStatusIn": [
      "CREATED"
    ],
    "securityProfileIdLike": "string",
    "calendarTypeEqual": "REGULAR_CALENDAR",
    "fiscalVariantEqual": {
      "id": 10000001,
      "displayId": "sample_displayId",
      "status": {
        "name": "ACTIVE",
        "captionKey": "enum.objectStatus.active",
        "active": true,
        "caption": "Active"
      },
      "isCalendarYear": true,
      "yearDependent": false,
      "erpSystemDisplayId": "sample_erpSystemDisplayId"
    }
  },
  "pageable": {
    "page": 0,
    "size": 10,
    "sort": [
      "id,asc",
      "name,desc"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageReportProfileDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 10000001,
      "name": "Sample Name",
      "principalPositionType": {
        "name": "LESSEE",
        "captionKey": "enum.principalpositiontype.lessee",
        "caption": "Lessee"
      },
      "erpSystemFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "erpSystems": [],
      "leaseAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseAreas": [],
      "businessUnitFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "businessUnits": [],
      "companyFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "companyCodes": [],
      "departmentFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseDepartments": [],
      "leaseGroupFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseGroups": [],
      "costCenterFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "costCenters": [],
      "profitCenterFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "profitCenters": [],
      "workBreakdownStructureFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "workBreakdownStructures": [],
      "objectStatus": {
        "name": "ACTIVE",
        "captionKey": "enum.objectStatus.active",
        "active": true,
        "caption": "Active"
      },
      "securityProfileId": 10000001,
      "calendarType": {
        "name": "_360",
        "captionKey": "enum.calendarType.360",
        "caption": "360 Convention"
      },
      "fiscalVariant": {
        "id": 10000001,
        "displayId": "sample_displayId",
        "status": {
          "name": "ACTIVE",
          "captionKey": "enum.objectStatus.active",
          "active": true,
          "caption": "Active"
        },
        "isCalendarYear": true,
        "yearDependent": false,
        "erpSystemDisplayId": "sample_erpSystemDisplayId"
      },
      "assetClassFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "assetClasses": [],
      "functionalAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "functionalAreas": [],
      "businessAreaFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "businessAreas": [],
      "vendorFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "vendors": [],
      "leaseClassificationFilterType": {
        "name": "ALL",
        "captionKey": "enum.filterType.all",
        "caption": "All"
      },
      "leaseClassifications": "sample_leaseClassifications",
      "accountingStandardType": "TYPE_VALUE",
      "filterObjectDto": {
        "id": 10000001,
        "profileId": 10000001,
        "displayId": "sample_displayId",
        "objectType": "TYPE_VALUE"
      },
      "scriptProfile": false
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---