Remove a bankaccount from a person

Prev Next
Delete
/api/v1/relations/persons/bankaccounts

Remove an existing bank account from a person.

Description

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

A person is a standalone entity and pertains to an enhancement of organisation. This could be a contact person within an organisation. Several users utilize this to enter their own employees into the system.

Use Case

The Bloxs user wants to remove a bank account connected to a person, for example, because the person 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 person 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 person 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 person

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