Insert an estateAgent
  • 02 Oct 2024
  • 4 Minutes to read
  • Dark
    Light

Insert an estateAgent

  • Dark
    Light

Article summary

Post
/api/v1/relations/estateAgents

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.                                                   

FieldDescription
externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
phoneNumberPhone number of the relation.
mobileNumberMobile phone number of the relation.
cocNumberChamber of Commerce number.
cocDescriptionAdditional 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.
vatNumberVAT (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.
streetThe street of the relation.
houseNumber
The house number of the relation.
postalCode
The postal code of the relation.
cityThe 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.
postalAddressThe 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.
primaryEmailAddressesPrimary email address used by the relation. If other email addresses are left empty, this email address will be used for correspondence.
invoicesEmailAddressesThe email address used to send invoices.
paymentRemindersEmailAddressesThe email address used to send reminders regarding payments.
indexationsEmailAddressesThe email address to which the annual rent increase (indexation) is sent.
serviceTicketsEmailAddressesThe 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.
purchaseOrdersEmailAddressesAll 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.
portalsEmailAddressesWithin 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.
otherEmailAddressesOther email addresses.
name
Name of the relation.
websiteWebsite of the relation.
Security
HTTP
Type Bearer

Please enter a valid token

Body parameters
Expand All
object
externalIdentifier
string | null
Min length0
Max length100
phoneNumber
string | null
mobileNumber
string | null
cocNumber
string | null
Min length0
Max length256
cocDescription
string | null
vatNumber
string | null
Min length0
Max length256
correspondenceMethod
integer (int32) Required

1 = Email

2 = Post

Valid values[ \1\, \2\ ]
remarks
string | null
languageISOCode
string | null
Min length0
Max length2
address
object (Address)
street
string Required
Min length0
Max length200
houseNumber
string | null
Min length0
Max length40
postalCode
string Required
Min length0
Max length20
city
string Required
Min length0
Max length200
countryISOCode
string Required
Min length0
Max length2
invoiceAddress
object (Address)
street
string Required
Min length0
Max length200
houseNumber
string | null
Min length0
Max length40
postalCode
string Required
Min length0
Max length20
city
string Required
Min length0
Max length200
countryISOCode
string Required
Min length0
Max length2
postalAddress
object (Address)
street
string Required
Min length0
Max length200
houseNumber
string | null
Min length0
Max length40
postalCode
string Required
Min length0
Max length20
city
string Required
Min length0
Max length200
countryISOCode
string Required
Min length0
Max length2
primaryEmailAddresses
Array of string | null
string
invoicesEmailAddresses
Array of string | null
string
paymentRemindersEmailAddresses
Array of string | null
string
indexationsEmailAddresses
Array of string | null
string
serviceTicketsEmailAddresses
Array of string | null
string
purchaseOrdersEmailAddresses
Array of string | null
string
portalsEmailAddresses
Array of string | null
string
otherEmailAddresses
Array of string | null
string
name
string Required
Min length0
Max length256
website
string | null
Responses
200

The estate agent was created

Expand All
object
externalIdentifier
string | null
Min length0
Max length100
phoneNumber
string | null
mobileNumber
string | null
cocNumber
string | null
Min length0
Max length256
cocDescription
string | null
vatNumber
string | null
Min length0
Max length256
correspondenceMethod
integer (int32)

1 = Email

2 = Post

Valid values[ \1\, \2\ ]
remarks
string | null
languageISOCode
string | null
Min length0
Max length2
address
object (Address)
street
string
Min length0
Max length200
houseNumber
string | null
Min length0
Max length40
postalCode
string
Min length0
Max length20
city
string
Min length0
Max length200
countryISOCode
string
Min length0
Max length2
invoiceAddress
object (Address)
street
string
Min length0
Max length200
houseNumber
string | null
Min length0
Max length40
postalCode
string
Min length0
Max length20
city
string
Min length0
Max length200
countryISOCode
string
Min length0
Max length2
postalAddress
object (Address)
street
string
Min length0
Max length200
houseNumber
string | null
Min length0
Max length40
postalCode
string
Min length0
Max length20
city
string
Min length0
Max length200
countryISOCode
string
Min length0
Max length2
primaryEmailAddresses
Array of string | null
string
invoicesEmailAddresses
Array of string | null
string
paymentRemindersEmailAddresses
Array of string | null
string
indexationsEmailAddresses
Array of string | null
string
serviceTicketsEmailAddresses
Array of string | null
string
purchaseOrdersEmailAddresses
Array of string | null
string
portalsEmailAddresses
Array of string | null
string
otherEmailAddresses
Array of string | null
string
name
string
Min length0
Max length256
website
string | null
reference
string | null
Min length0
Max length100
400

The estate agent data has validation issues

Expand All
object
type
string | null
title
string | null
traceId
string | null
status
integer (int32)
errors
object | null
property*
Array of string additionalProperties
string