- 30 Dec 2024
- 1 Minute to read
- Print
- DarkLight
[PREVIEW] Get a list of private rent deposit types
- Updated on 30 Dec 2024
- 1 Minute to read
- Print
- DarkLight
[PREVIEW] Get a list of existing private rent deposit types.
Description
Retrieve a list with all known commercial rent 'deposit types' within Bloxs.
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. No API endpoint will be made available to finalise the contract. 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
The user wants to add a deposit type of a private rent contract through the update concept private rent contract operation update concept private rent contract operation. One of the obligatory fields in the request of this operation is 'depositTypeName'. However, the user does not know the options which are available to choose from. The user can utilize this operation to retrieve a list, so a choice can be made regarding which 'depositTypeName' to choose.
Response fields
The response contains the fields in the table below. For the get operation it gives a up-to-date insight in the data that is currently registered in Bloxs.
Field | Description |
---|---|
name | The name of the deposit type |
Please enter a valid token
OK