[PREVIEW] Get concept private rent contracts filtered and paged
- 30 Dec 2024
- 3 Minutes to read
- Print
- DarkLight
[PREVIEW] Get concept private rent contracts filtered and paged
- Updated on 30 Dec 2024
- 3 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Post
/api/v1/contracts/conceptprivaterent/filter
[PREVIEW] Get a paged list of existing concept private rent contracts, optionally filtered to the given parameters.
Description
Retrieve a paged list of existing concepts of private rent contracts, optionally filtered to the given parameters.
This endpoint can only be used to retrieve a list of concept contracts before they are finalised in the Bloxs application.
Private rent contracts pertains to contracts concerning real estate objects in the private sector. It is generated for each prospect, with the remaining details to be filled in in the Bloxs application. The draft contract can (optionally) be signed digitally. Once signed, the first invoice can be issued immediately. Please note that the concept contract is not a template; it is a draft with only one mandatory field.
Use Case
Through this operation the user can display a paged list of concept contracts. This operation can be used if the user wants to display multiple concept contracs rather than just a specific one. If the user wants to display a single concept contract the preference is to use the GET (concept private rent contracts) operation.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| pageSize | The maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number). |
| pageNumber | This allows the requesting party to specify which of the pages they want to receive. |
| columnName | De data field based on which sorting will be applied. For example, if the user wants to sort the results based on ascending name, the value 'name' should be given here. |
| order | Based on this value, the property defined in 'columnName' will either be sorted ascending (a-z) or descending (z-a). |
| externalIdentifier | The unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. |
| name | The free name field of the contract. Intended as clarification for search purposes. |
| ownerReference | This pertains to the reference of the owner of the object. Please note, a reference must be included here. |
| relationReference | This pertains to the primary tenant who is financially responsible. Please note, a reference must be included here. |
| indexationMethod | The method of indexation that should be applied to this specific contract. The available methods consist of a predefined list by Bloxs, which can be customized by the user in the Bloxs application. In order to retrieve the available methods, the following endpoint can be used: Get a list of private rent indexation methods Get a list of private rent indexation methods. Examples of indexation methods are a fixed yearly amount (eg. 2%) or a percentage linked to the inflation numbers. The inflation numbers are automatically processed by Bloxs, the user does not need to upload these numbers manually. |
| startDate.from | Start date of the contract. This defines the lower border of the range. |
| startDate.to | Start date of the contract. This defines the upper border of the range. |
| endDate.from | End date of the contract. This defines the lower border of the range. |
| endDate.to | End date of the contract. This defines the upper border of the range. |
| nexIndexDate.from | The next date from which the indexation method will be applied. Further indexations will be applied on an annual basis, starting from the 'nextIndexDate'. For example the nextIndexDate is 2025-01-01. This means subsequent dates for indexation are 2026-01-01, 2027-01-01 etc. This defines the lower border of the range. |
| nextIndexDate.to | The next date from which the indexation method will be applied. Further indexations will be applied on an annual basis, starting from the 'nextIndexDate'. For example the nextIndexDate is 2025-01-01. This means subsequent dates for indexation are 2026-01-01, 2027-01-01 etc. This defines the lower border of the range. |
Security
HTTP
Type Bearer
Please enter a valid token
Body parameters
object
paging
object (PagingInfo)
pageSize
integer (int32) | null
Minimum1
Maximum1000
pageNumber
integer (int32) | null
Minimum1
Maximum9999
sorting
object (SortingInfo)
columnName
string | null
order
integer (int32)
0 = Ascending
1 = Descending
Valid values[ \0\, \1\ ]
filter
object (FilterConceptSalesContractRequestDTO)
externalIdentifier
string | null
name
string | null
ownerReference
string | null
relationReference
string | null
indexationMethod
string | null
startDate
object (CompareFilterModelDateTime)
from
string (date-time) | null
to
string (date-time) | null
endDate
object (CompareFilterModelDateTime)
from
string (date-time) | null
to
string (date-time) | null
nextIndexDate
object (CompareFilterModelDateTime)
from
string (date-time) | null
to
string (date-time) | null
Responses
200
OK
object
paging
object (PagingInfo)
pageSize
integer (int32) | null
Minimum1
Maximum1000
pageNumber
integer (int32) | null
Minimum1
Maximum9999
sorting
object (SortingInfo)
columnName
string | null
order
integer (int32)
0 = Ascending
1 = Descending
Valid values[ \0\, \1\ ]
conceptSalesContracts
Array of object (FilterConceptSalesContractResponseDTO) | null
object
externalIdentifier
string | null
name
string | null
ownerReference
string | null
relationReference
string | null
paymentTerm
string | null
indexationMethod
string | null
startDate
string (date) | null
endDate
string (date) | null
nextIndexDate
string (date) | null