Contact

Retrieve A Specific Contact

HTTP Request

GET /api/v1/contacts/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific contact associated with lease agreements and 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	10000001	path

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved contact details.	ResponseContactDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000001,
    "displayId": "CONT-0001",
    "name": "Jane Doe",
    "position": "Procurement Manager",
    "email": "jane.doe@example.com",
    "phone": "+49 123 456 7890",
    "address": "123 Business St, Berlin, Germany",
    "description": "Main point of contact for vendor negotiations.",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
}

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

Update A Specific Contact

HTTP Request

PUT /api/v1/contacts/{id}

Interactive Demo

📋 Description: Updates the details of a specific contact identified by the provided ID, ensuring accurate representation of lease-related information within the Nakisa Lease Accounting Suite for effective contract and financial obligation management.

Parameters

Name	In	Type	Required	Description
id	path	integer	true	Unique identifier for the resource
body	body	ContactDto	false	Request body containing the updated contact information, including lease and contract details, relevant to financial obligations and accounting entries.

Example Values

Parameter	Example	Type
id	10000001	path

Body Parameters

{
  "id": 10000001,
  "displayId": "CONT-0001",
  "name": "Jane Doe",
  "position": "Procurement Manager",
  "email": "jane.doe@example.com",
  "phone": "+49 123 456 7890",
  "address": "123 Business St, Berlin, Germany",
  "description": "Main point of contact for vendor negotiations.",
  "group": "string",
  "buildingName": "string",
  "fax": "string",
  "numberRangeIdentifierValue": "BU-01",
  "numberRangeIdentifierType": {
    "name": "COMPANY_CODE"
  },
  "numberRangeType": {
    "name": "CONTRACT"
  },
  "allowsSystemGenerateNewId": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Contact successfully updated.	ResponseContactDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000001,
    "displayId": "CONT-0001",
    "name": "Jane Doe",
    "position": "Procurement Manager",
    "email": "jane.doe@example.com",
    "phone": "+49 123 456 7890",
    "address": "123 Business St, Berlin, Germany",
    "description": "Main point of contact for vendor negotiations.",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
}

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

Delete A Specific Contact

HTTP Request

DELETE /api/v1/contacts/{id}

Interactive Demo

📋 Description: Deletes a specified contact from the Nakisa Lease Accounting Suite, ensuring the removal of associated lease and contract financial obligations from the system.

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	Contact successfully deleted.	ResponseVoid

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {}
}

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

Partially Update A Contact

HTTP Request

PATCH /api/v1/contacts/{id}

Interactive Demo

📋 Description: Updates the details of a specific contact within the Nakisa Lease Accounting Suite, enabling users to modify information related to leases, contracts, and financial obligations efficiently. This operation ensures that accounting entries reflect the most current and accurate contact data.

Parameters

Name	In	Type	Required	Description
id	path	integer	true	Unique identifier for the resource
body	body	JsonPatch	false	Request body containing updated contact information, including lease-related details and financial obligations, for the specified contact ID in the Nakisa Lease Accounting Suite.

Example Values

Parameter	Example	Type
id	10000001	path
body	{"op":"replace","path":"/name","value":"patched contract"}	body

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	Successfully patched contact.	ResponseContactDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000001,
    "displayId": "CONT-0001",
    "name": "Jane Doe",
    "position": "Procurement Manager",
    "email": "jane.doe@example.com",
    "phone": "+49 123 456 7890",
    "address": "123 Business St, Berlin, Germany",
    "description": "Main point of contact for vendor negotiations.",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
}

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

Create Or Update A Contact

HTTP Request

PUT /api/v1/contacts/createOrUpdate

Interactive Demo

📋 Description: Updates or creates a contact record within the Nakisa Lease Accounting Suite, ensuring accurate management of lease-related financial obligations and accounting entries. This operation streamlines the maintenance of contract information essential for effective lease administration.

Parameters

Name	In	Type	Required	Description
body	body	ContactDto	false	Request body containing the lease and contract details, including financial obligations and accounting entry information for creating or updating contact records.

Body Parameters

{
  "id": 10000001,
  "displayId": "CONT-0001",
  "name": "Jane Doe",
  "position": "Procurement Manager",
  "email": "jane.doe@example.com",
  "phone": "+49 123 456 7890",
  "address": "123 Business St, Berlin, Germany",
  "description": "Main point of contact for vendor negotiations.",
  "group": "string",
  "buildingName": "string",
  "fax": "string",
  "numberRangeIdentifierValue": "BU-01",
  "numberRangeIdentifierType": {
    "name": "COMPANY_CODE"
  },
  "numberRangeType": {
    "name": "CONTRACT"
  },
  "allowsSystemGenerateNewId": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Contact successfully created or updated.	ResponseContactDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000001,
    "displayId": "CONT-0001",
    "name": "Jane Doe",
    "position": "Procurement Manager",
    "email": "jane.doe@example.com",
    "phone": "+49 123 456 7890",
    "address": "123 Business St, Berlin, Germany",
    "description": "Main point of contact for vendor negotiations.",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
}

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

Bulk Create Or Update Contacts

HTTP Request

PUT /api/v1/contacts/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple contacts in the Nakisa Lease Accounting Suite, ensuring that lease, contract, and financial obligation information is accurately reflected in the system. This operation streamlines the management of accounting entries by allowing bulk modifications.

Parameters

Name	In	Type	Required	Description
body	body	ContactDto	false	Request body containing a bulk array of contact records, including lease and contract details, to facilitate the creation or updating of financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

[
  {
    "id": 10000001,
    "displayId": "CONT-0001",
    "name": "Jane Doe",
    "position": "Procurement Manager",
    "email": "jane.doe@example.com",
    "phone": "+49 123 456 7890",
    "address": "123 Business St, Berlin, Germany",
    "description": "Main point of contact for vendor negotiations.",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Contacts successfully created or updated in bulk.	ResponseListContactDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": [
    {
      "id": 10000001,
      "displayId": "CONT-0001",
      "name": "Jane Doe",
      "position": "Procurement Manager",
      "email": "jane.doe@example.com",
      "phone": "+49 123 456 7890",
      "address": "123 Business St, Berlin, Germany",
      "description": "Main point of contact for vendor negotiations.",
      "group": "string",
      "buildingName": "string",
      "fax": "string",
      "numberRangeIdentifierValue": "BU-01",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "allowsSystemGenerateNewId": true
    }
  ]
}

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

Update Contacts In Bulk

HTTP Request

PUT /api/v1/contacts/bulk

Interactive Demo

📋 Description: Updates multiple contact records in the Nakisa Lease Accounting Suite, enabling efficient management of lease-related stakeholders and ensuring accurate financial obligation tracking.

Parameters

Name	In	Type	Required	Description
body	body	ContactDto	false	Request body containing an array of contact records for bulk updates, including lease-related information and financial obligations pertinent to accounting entries.

Body Parameters

[
  {
    "id": 10000001,
    "displayId": "CONT-0001",
    "name": "Jane Doe",
    "position": "Procurement Manager",
    "email": "jane.doe@example.com",
    "phone": "+49 123 456 7890",
    "address": "123 Business St, Berlin, Germany",
    "description": "Main point of contact for vendor negotiations.",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Contacts successfully updated in bulk.	ResponseListContactDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": [
    {
      "id": 10000001,
      "displayId": "CONT-0001",
      "name": "Jane Doe",
      "position": "Procurement Manager",
      "email": "jane.doe@example.com",
      "phone": "+49 123 456 7890",
      "address": "123 Business St, Berlin, Germany",
      "description": "Main point of contact for vendor negotiations.",
      "group": "string",
      "buildingName": "string",
      "fax": "string",
      "numberRangeIdentifierValue": "BU-01",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "allowsSystemGenerateNewId": true
    }
  ]
}

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

Create Contacts In Bulk

HTTP Request

POST /api/v1/contacts/bulk

Interactive Demo

📋 Description: Uploads multiple contact records in bulk to the Nakisa Lease Accounting Suite, facilitating efficient management of lease-related financial obligations and accounting entries.

Parameters

Name	In	Type	Required	Description
body	body	ContactDto	false	Request body containing a collection of contact records, including lease and contract details, to facilitate bulk processing of financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

[
  {
    "id": 10000001,
    "displayId": "CONT-0001",
    "name": "Jane Doe",
    "position": "Procurement Manager",
    "email": "jane.doe@example.com",
    "phone": "+49 123 456 7890",
    "address": "123 Business St, Berlin, Germany",
    "description": "Main point of contact for vendor negotiations.",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Contacts successfully created in bulk.	ResponseListContactDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": [
    {
      "id": 10000001,
      "displayId": "CONT-0001",
      "name": "Jane Doe",
      "position": "Procurement Manager",
      "email": "jane.doe@example.com",
      "phone": "+49 123 456 7890",
      "address": "123 Business St, Berlin, Germany",
      "description": "Main point of contact for vendor negotiations.",
      "group": "string",
      "buildingName": "string",
      "fax": "string",
      "numberRangeIdentifierValue": "BU-01",
      "numberRangeIdentifierType": {
        "name": "COMPANY_CODE"
      },
      "numberRangeType": {
        "name": "CONTRACT"
      },
      "allowsSystemGenerateNewId": true
    }
  ]
}

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

Delete Contacts In Bulk

HTTP Request

DELETE /api/v1/contacts/bulk

Interactive Demo

📋 Description: Deletes multiple contacts in bulk from the Nakisa Lease Accounting Suite, ensuring the removal of associated lease, contract, and financial obligation entries for streamlined accounting management.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	false	Request body containing an array of contact identifiers to be deleted in bulk, relevant for managing lease and contract-related financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	Contacts successfully deleted in bulk.	ResponseVoid

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {}
}

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

List All Contacts

HTTP Request

GET /api/v1/contacts

Interactive Demo

📋 Description: Retrieves a list of contacts associated with leases and contracts, providing essential information for managing financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Page number (0-indexed)
size	query	integer	false	Number of items per page
sort	query	array[string]	false	Sorting criteria in format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Default Values

Parameter	Default	Type
page	0	query
size	20	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1, Max: 100

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved list of contacts.	PageContactDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": false,
  "empty": false
}

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

Create A New Contact

HTTP Request

POST /api/v1/contacts

Interactive Demo

📋 Description: Creates a new contact within the Nakisa Lease Accounting Suite, facilitating the management of lease-related contracts and financial obligations essential for accurate accounting entries.

Parameters

Name	In	Type	Required	Description
body	body	ContactDto	false	Request body containing the contact information and associated details necessary for managing leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

{
  "id": 10000001,
  "displayId": "CONT-0001",
  "name": "Jane Doe",
  "position": "Procurement Manager",
  "email": "jane.doe@example.com",
  "phone": "+49 123 456 7890",
  "address": "123 Business St, Berlin, Germany",
  "description": "Main point of contact for vendor negotiations.",
  "group": "string",
  "buildingName": "string",
  "fax": "string",
  "numberRangeIdentifierValue": "BU-01",
  "numberRangeIdentifierType": {
    "name": "COMPANY_CODE"
  },
  "numberRangeType": {
    "name": "CONTRACT"
  },
  "allowsSystemGenerateNewId": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Contact successfully created.	ResponseContactDto

Example Responses

{
  "code": "OK",
  "errors": {
    "all": []
  },
  "object": {
    "id": 10000001,
    "displayId": "CONT-0001",
    "name": "Jane Doe",
    "position": "Procurement Manager",
    "email": "jane.doe@example.com",
    "phone": "+49 123 456 7890",
    "address": "123 Business St, Berlin, Germany",
    "description": "Main point of contact for vendor negotiations.",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "numberRangeIdentifierValue": "BU-01",
    "numberRangeIdentifierType": {
      "name": "COMPANY_CODE"
    },
    "numberRangeType": {
      "name": "CONTRACT"
    },
    "allowsSystemGenerateNewId": true
  }
}

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

Search Contacts With Filters

HTTP Request

POST /api/v1/contacts/search

Interactive Demo

📋 Description: Submits a search query to retrieve contacts related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite, facilitating efficient management of 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	ContactDtoFilter	false	Request body containing search criteria for retrieving contact information related to leases, contracts, and financial obligations within the Nakisa Lease Accounting Suite.

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, Max: 100

Body Parameters

{
  "idIn": [
    10000001,
    10000002
  ],
  "idEqual": 10000001,
  "idLike": "1000%",
  "createdAtGreaterThanOrEqual": "2025-01-01T00:00:00Z",
  "createdAtLessThanOrEqual": "2025-12-31T23:59:59Z",
  "createdByLike": "admin%",
  "createdByEqual": "admin",
  "modifiedAtGreaterThanOrEqual": "2025-01-01T00:00:00Z",
  "modifiedAtLessThanOrEqual": "2025-12-31T23:59:59Z",
  "modifiedByLike": "user%",
  "modifiedByEqual": "admin",
  "displayIdIn": [
    "CONT-0001",
    "CONT-0002"
  ],
  "displayIdLike": "CONT%",
  "nameLike": "%Doe%",
  "positionLike": "%Manager%",
  "emailLike": "%@example.com",
  "phoneLike": "+49%",
  "addressLike": "%Berlin%"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieved filtered list of contacts.	PageContactDto

Example Responses

{
  "totalElements": 10000001,
  "totalPages": 100,
  "pageable": {
    "pageNumber": 0,
    "unpaged": false,
    "paged": true,
    "pageSize": 100,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 100,
  "size": 100,
  "content": [],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "first": true,
  "last": false,
  "empty": false
}

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

---