Contents x
    Get all bank accounts for an organisation
    • 18 Sep 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Get all bank accounts for an organisation

    • Updated on 18 Sep 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/relations/organisations/bankaccounts

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

    Description

    Retrieve all the bank accounts (and associated information) currently known in the Bloxs database connected to 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 all the known bank accounts related to a specific organisation. For example the user wants to make some adjustments regarding a bank account, or wants to delete one. In this case this endpoint can be used to retrieve the bank accounts so the user knows which data points to adjust.

    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. This field should contain the reference of the person from which the bank accounts should be retrieved.
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. This field should contain the externalIdentifier of the person from which the bank accounts should be retrieved.

    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
    bankAccountNumberThe bank account number assigned to a bank account. This field is used as an identifier to indicate which bank account should be updated.
    bic

    BIC code (Bank Identifier Code). An international standard for identifying banks and financial institutions. It is also known as a SWIFT code, as it is governed by the Society for Worldwide Interbank Financial Telecommunication (SWIFT). 

    A BIC code consists of 8 or 11 characters. The components are:

    Bank Code (4 characters): Identifies the bank.

    Country Code (2 characters): Indicates the country in which the bank is located, following the ISO 3166-1 alpha-2 standard.

    Location Code (2 characters): Specifies the bank's location within the country.

    Branch Code (3 characters, optional): Identifies a specific branch or office of the bank.

    isBankAccountNonIBAN

    Indicator showing that the bank account number is not an IBAN (International Bank Account Number) account.

    Bloxs applies a verification process to check if a bank account number is an IBAN. By using this checkbox, you can bypass the verification for non-IBAN numbers. This is relevant for instances such as expats making payments from a non-IBAN account.

    isPreferredBankAccountA bank account can be designated as the preferred account. When a new bank account is submitted and marked as preferred, the other bank accounts will be designated as 'other'. Therefore, you do not need the PUT to adjust the other bank accounts. If there is only one bank account, it will automatically be marked as preferred.


    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

    Array of object
    object
    bankAccountNumber
    string | null
    bic
    string | null
    isBankAccountNonIBAN
    boolean
    isPreferredBankAccount
    boolean
    404

    The requested organisation was not found.

    What's Next