[PREVIEW] Get a paged list of existing general sales contracts, optionally filtered to the given parameters.
Description
Retrieve a paged list of existing general contracts, optionally filtered to the given parameters.
This endpoint can only be used to retrieve a list of contracts after they are finalised in the Bloxs application.
General sales contracts pertains to 'other contracts', which do not concern rent contracts. An example is a contract in which agreements on maintenance are set. In these contracts the Bloxs user is the invoicing party, hence a sales contract. This endpoint concern finalized contracts.
Use Case
Through this operation the user can display a paged list of finalized general sales contracts. This operation can be used if the user wants to display multiple contracs rather than just a specific one. If the user wants to display a single contract the preference is to use the GET 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 | The data field based on which sorting is applied. For example, if the results are sorted based on ascending name, columnName will contain the value 'name'. |
| order | Based on this value, the property defined in 'columnName' is either sorted ascending (a-z) or descending (z-a). |
| reference | The reference of the contract as generated by Bloxs. |
| externalIdentifier | The unique identifier of the contract within the system of the requesting party. This identifier is not generated by the Bloxs system. |
| ownerReference | This pertains to the reference of the owner of the object which is subject of the contract. Please note, a reference assigned by Bloxs must be included here. |
| relationReference | This pertains to the primary tenant who is financially responsible. Please note, a reference assigned by Bloxs must be included here. |
| startDate.from | Start date of the contract. Lower border of parameter. |
| startDate.to | Start date of the contract. Upper border of parameter. |
| endDate.from | End date of the contract. Lower border of parameter. |
| endDate.to | End date of the contract. Upper border of parameter. |
| automaticExtends | This field indicates whether the contract is subject to automatic renewal. The default value is "false." |
| noticeDate.from | The latest date by which the contract can be cancelled, before an automatic extension is activated. This is true only if 'automaticExtends' = true. This date is automatically calculated by Bloxs based on the 'noticePeriod' & 'endDate' of the contract. If 'endDate' is left empty, noticeDate will not be calculated and therefore be left empty. Lower border of parameter. |
| noticeDate.to | The latest date by which the contract can be cancelled, before an automatic extension is activated. This is true only if 'automaticExtends' = true. This date is automatically calculated by Bloxs based on the 'noticePeriod' & 'endDate' of the contract. If 'endDate' is left empty, noticeDate will not be calculated and therefore be left empty. Upper border of parameter. |
| noticePeriod | Notice period of the contract specified in months. This is relevant if automatic extension applies to this contract (automaticExtends = true). |
Response fields
In addition to the fields in the request, the 200 response contains the fields in the table below.
| Field | Description |
|---|---|
| extraRelationReferences | This pertains to co-tenants. Please note, a reference assigned by Bloxs must be included here. |
Please enter a valid token
OK