Contents x
    Get a organisation
    • 04 Sep 2024
    • 5 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Get a organisation

    • Updated on 04 Sep 2024
    • 5 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/relations/organisations

    Get an existing organisation. Either reference or externalIdentifier must have a value. If both are given, externalIdentifier will be used first for retrieving the organisation.

    Description

    Retrieve the information currently known in the Bloxs database about a certain Organisation. Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference. 

    Organisations are tenants who are not natural persons but rather entities such as commercial real estate or partnerships. For instance, a university providing rooms where the rent is collected directly from the tenant. 

    Use Case

    Through this operation the user can display a specific Organisation and the related information. For example the user wants to display all the information of the organisation to see which data points need to be adjusted.

    Request fields

    The request contains the following fields:

    FieldDescription
    referenceThe relationship number within Bloxs. This is unique (per client specific environment) for all relationships (EstateAgents, Organisations, Owners, Persons, Suppliers). The relationship number is generated by the Bloxs system .
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.

    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.

    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.
    relationTypeNameCategory of the organisation. The available categories are pre-defined in the system but can be configured by the user. If this data point contains a value that is not present in the available categories,  a validation error will be received. To retrieve the list of available options the following endpoint can be used: GET RelationTypes.
    nameName of the relation.
    websiteWebsite of the relation.
    invoiceAttn
    		This property indicates to whom the invoice will be addressed to. 'Attn' is the abbreviation of 'to the attention off'. The text which is entered in this property will be used as the default line to whom the invoices of this organisation are addressed to. This text will be displayed in the header of the associated documents. There are no validations on this property. The way in which the text is entered is how it will be displayed.
    reminderAttnThis property indicates to whom the payment reminders will be addressed to. 'Attn' is the abbreviation of 'to the attention off'. The text which is entered in this property will be used as the default line to whom the payment reminders of this organisation are addressed to. This text will be displayed in the header of the associated documents. There are no validations on this property. The way in which the text is entered is how it will be displayed.
    indexingAttnThis property indicates to whom the yearly indexing of the rent will be addressed to. 'Attn' is the abbreviation of 'to the attention off'. The text which is entered in this property will be used as the default line to whom the communication regarding the yearly indexing of the rent of this organisation are addressed to. This text will be displayed in the header of the associated documents. There are no validations on this property. The way in which the text is entered is how it will be displayed.
    referenceThe relationship number within Bloxs. This is unique (per client specific environment) for all relationships (EstateAgents, Organisations, Owners, Persons, Suppliers). The relationship number is generated by the Bloxs system .
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Query parameters
    reference
    string

    The internal identifier of the model (i.e. Reference, Code, Name, depends on model).

    externalIdentifier
    string

    The external API identifier of the model.

    Responses
    200

    Success

    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
    relationTypeName
    string
    Min length0
    Max length256
    name
    string
    Min length0
    Max length256
    website
    string | null
    invoiceAttn
    string | null
    reminderAttn
    string | null
    indexingAttn
    string | null
    reference
    string | null
    Min length0
    Max length100
    404

    The requested organisation was not found.

    What's Next