Contents x
    Remove a bankaccount from an organisation
    • 18 Sep 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Remove a bankaccount from an organisation

    • Updated on 18 Sep 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Delete
    /api/v1/relations/organisations/bankaccounts

    Remove an existing bank account from an organisation.

    Description

    Removes a bank account connected to an 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

    The Bloxs user wants to remove a bank account connected to an organisation, for example, because the organisation no longer uses the bank account in question.

    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 organisation to which the bank accounts belongs.
    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 organisation to which the bank accounts belongs.
    bankAccountNumberThe bank account number assigned to a bank account. This field is used as an identifier to indicate which bank account should be deleted.
    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.

    Body parameters
    object
    bankAccountNumber
    string | null
    Responses
    200

    The bank account was removed from the organisation

    400

    The bank account 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
    What's Next