Contents x
    Get organisations filtered and paged
    • 04 Sep 2024
    • 4 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Get organisations filtered and paged

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

    Post
    /api/v1/relations/organisations/filter

    Get a paged list of existing organisations, optionally filtered to the given parameters.

    Description

    Retrieve a paged list of existing organisations, optionally filtered to the given parameters. The Bloxs relations-api offers 2 options to get organisations filtered and paged. One is through the POST option, and as an alternative there is a GET operation available. The functional difference is that the POST option offers the ability to sort the results. Furthermore, the POST includes the parameters in the body whereas the GET includes them in the url.

    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

    The Bloxs user has an external App connected to Bloxs. Through this operation the user can display a paged list of organisations & the related information. This operation can be used if the user wants to display multiple organisations rather than just a specific one. If the user wants to display a single organisation the preference is to use the GET (organisation) operation.

    FieldDescription
    pageSizeThe 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).
    pageNumberThis allows the requesting party to specify which of the pages they want to receive.
    columnNameThe data field based on which sorting will be applied. For example, if the user wants to sort the results based on ascending name, the value 'name' should be given here.
    orderBased on this value, the property defined in 'columnName' will either be sorted ascending (a-z) or descending (z-a).
    ExternalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
    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 .
    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 option the following endpoint can be used: GET RelationTypes.
    nameName of the relation.
    websiteWebsite of the relation.
    invoiceAttnThis 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 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.
    isActive

    Boolean. A relationship can be archived. If the relationship is archived, then the status is inactive.

    True: Active

    False: Inactive

    phoneNumberPhone number of the relation.
    mobileNumberMobile phone number of the relation.
    addressStreet
    		The street of the relation.
    AddressPostalCode
    		The postal code of the relation.
    AddressCityThe place of residence of the relation.
    primaryEmailAddresses
    		Primary email address used by the relation. If other email addresses are left empty, this email address will be used for correspondence.
    lastModifiedTimestamp of the last modification within Bloxs (determined by Bloxs).
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Body parameters
    Expand All
    object
    paging
    object (PagingInfo)
    pageSize
    integer (int32) | null
    Minimum1
    Maximum1000
    pageNumber
    integer (int32) | null
    Minimum1
    Maximum9999
    sorting
    object (SortingInfo)
    columnName
    string | null
    order
    integer (int32)

    0 = Ascending

    1 = Descending

    Valid values[ \0\, \1\ ]
    filter
    object (OrganisationSearchRequestFilter)
    externalAPIIdentifier
    string | null
    reference
    string | null
    relationTypeName
    string | null
    name
    string | null
    website
    string | null
    invoiceAttn
    string | null
    reminderAttn
    string | null
    indexingAttn
    string | null
    isActive
    boolean | null
    phoneNumber
    string | null
    mobileNumber
    string | null
    addressStreet
    string | null
    addressPostalCode
    string | null
    addressCity
    string | null
    email
    string | null
    lastModified
    string (date-time) | null
    Responses
    200

    Success

    Expand All
    object
    paging
    object (PagingInfo)
    pageSize
    integer (int32) | null
    Minimum1
    Maximum1000
    pageNumber
    integer (int32) | null
    Minimum1
    Maximum9999
    sorting
    object (SortingInfo)
    columnName
    string | null
    order
    integer (int32)

    0 = Ascending

    1 = Descending

    Valid values[ \0\, \1\ ]
    organisations
    Array of object (OrganisationSearchResultFilter) | null
    object
    externalAPIIdentifier
    string | null
    reference
    string | null
    relationTypeName
    string | null
    name
    string | null
    website
    string | null
    invoiceAttn
    string | null
    reminderAttn
    string | null
    indexingAttn
    string | null
    state
    integer (int32)

    1 = Active

    2 = Inactive

    Valid values[ \1\, \2\ ]
    phoneNumber
    string | null
    mobileNumber
    string | null
    addressStreet
    string | null
    addressPostalCode
    string | null
    addressCity
    string | null
    email
    string | null
    lastModified
    string (date-time) | null
    What's Next