- 02 Oct 2024
- 4 Minutes to read
- Print
- DarkLight
Insert an estateAgent
- Updated on 02 Oct 2024
- 4 Minutes to read
- Print
- DarkLight
Insert a new estate agent.
Description
Insert (add) an estate agent to your existing relations. This includes a wide range of real estate brokerage services, including but not limited to real estate agents, brokers, and rental agents.
The 200 response contains a field named 'reference'. It is important to save this value since it is used as an identifier for all the other operations to recognise this specific entity.
Use Case
The user wants to add an estate agent from a third party system to the Bloxs application. Consequently the estate agent can be used in the Bloxs application for other processes, like service tickets, contracts, invoicing etc.
Field | Description |
---|---|
externalIdentifier | The unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. |
phoneNumber | Phone number of the relation. |
mobileNumber | Mobile phone number of the relation. |
cocNumber | Chamber of Commerce number. |
cocDescription | Additional information about the Chamber of Commerce number. Termed as KVK description in the Bloxs system. Extra information can be entered here regarding the Chamber of Commerce number. |
vatNumber | VAT (BTW) number of the relation. |
correspondenceMethod | The default method of correspondence. This field is an integer with 2 options: 1 = Email 2 = Post If the correspondenceMethod is set to Email, then the primaryEmailAddresses field is mandatory. If the CorrespondenceMethod is set to Post, then the Address field is mandatory. |
remarks | General comments. Please note: avoid including sensitive information here, such as passwords or sensitive personal data. |
languageISOCode | ISO language code. Use the 2-letter code from the ISO 639-1 Code list. |
address | The address of the relation. |
street | The street of the relation. |
houseNumber | The house number of the relation. |
postalCode | The postal code of the relation. |
city | The place of residence of the relation. |
countryISOCode | ISO country code. Use the 2-letter code from the ISO 639-1 Code list. |
invoiceAddress | The billing address of the relation. In case this field is empty, the data from 'address' will be used. This is mainly relevant for certain templates. |
postalAddress | The postal address of the relation. In case this field is empty, the data from 'address' will be used. This is mainly relevant for certain templates. |
primaryEmailAddresses | Primary email address used by the relation. If other email addresses are left empty, this email address will be used for correspondence. |
invoicesEmailAddresses | The email address used to send invoices. |
paymentRemindersEmailAddresses | The email address used to send reminders regarding payments. |
indexationsEmailAddresses | The email address to which the annual rent increase (indexation) is sent. |
serviceTicketsEmailAddresses | The email address to which all maintenance notifications are sent. This may differ from the general email address. For instance, in the case of a shared office space where all communication is centralized through one central desk instead of being handled separately by individual tenants. |
purchaseOrdersEmailAddresses | All communication specifically related to procurement is conducted through this email address. This is primarily applicable to large parties where procurement processes are managed through separate email accounts. |
portalsEmailAddresses | Within Bloxs, a portal account for customers or tenants can be opened. Through this field, you can provide multiple email addresses that need to be granted access. |
otherEmailAddresses | Other email addresses. |
name | Name of the relation. |
website | Website of the relation. |
Please enter a valid token
1 = Email
2 = Post
The estate agent was created
1 = Email
2 = Post
The estate agent data has validation issues