About Bank Details

Scope: crm

Who can perform methods: any user

Bank details are a strict sequence of numbers required for conducting operations with a bank account. They can be used to send a cashless payment or deposit money into the account through the cashier.

The mandatory bank details include:

  • account number
  • correspondent account number
  • bank identification code (BIC) and full name of the bank

In CRM, bank details are linked to the universal details object. Multiple bank details can be associated with a single detail.

Fields of Bank Details

Name
type

Description

Read

Write

Required

Immutable

ID
integer

Identifier of the bank detail. Created automatically and unique within the account

Yes

No

No

No

ENTITY_ID
integer

Identifier of the parent object. Currently, it can only be the identifier of the detail.

Identifiers of details can be obtained using the method crm.requisite.list

Yes

Yes

Yes

Yes

COUNTRY_ID
integer

Identifier of the country corresponding to the set of bank detail fields (see method crm.requisite.preset.countries for available values).

The country code of the bank detail matches the country code in the linked detail template, the identifier of which is specified in the ENTITY_ID field

Yes

Yes

No

No

DATE_CREATE
datetime

Creation date

Yes

No

No

No

DATE_MODIFY
datetime

Modification date

Yes

No

No

No

CREATED_BY_ID
user

Identifier of the user who created the detail

Yes

No

No

No

MODIFY_BY_ID
user

Identifier of the user who modified the detail

Yes

No

No

No

NAME*
string

Name of the bank detail

Yes

Yes

No

No

CODE
string

Symbolic code of the detail

Yes

Yes

No

No

XML_ID
string

External key. Used for exchange operations. Identifier of the object in the external information base.

The purpose of the field may change by the final developer. Each application ensures the uniqueness of values in this field.

It is recommended to use a unique prefix to avoid collisions with other applications

Yes

Yes

No

No

ACTIVE
char

Activity status. Values Y or N are used.

Currently, the field does not actually affect anything

Yes

Yes

No

No

SORT
integer

Sorting

Yes

Yes

No

No

RQ_BANK_NAME
string

Name of the bank

Yes

Yes

No

No

RQ_BANK_ADDR
string

Address of the bank

Yes

Yes

No

No

RQ_BANK_CODE
string

Bank Code (for country BR)

Yes

Yes

No

No

RQ_BANK_ROUTE_NUM
string

Bank Routing Number

Yes

Yes

No

No

RQ_BIK
string

BIC

Yes

Yes

No

No

RQ_CODEB
string

Code Banque (for country FR)

Yes

Yes

No

No

RQ_CODEG
string

Code Guichet (for country FR)

Yes

Yes

No

No

RQ_RIB
string

Clé RIB (for country FR)

Yes

Yes

No

No

RQ_MFO
string

MFO

Yes

Yes

No

No

RQ_ACC_NAME
string

Bank Account Holder Name

Yes

Yes

No

No

RQ_ACC_NUM
string

Bank Account Number

Yes

Yes

No

No

RQ_ACC_TYPE
string

Tipo da conta (for country BR)

Yes

Yes

No

No

RQ_AGENCY_NAME
string

Agência (for country BR)

Yes

Yes

No

No

RQ_IIK
string

IIK

Yes

Yes

No

No

RQ_ACC_CURRENCY
string

Currency of the account

Yes

Yes

No

No

RQ_COR_ACC_NUM
string

Correspondent account

Yes

Yes

No

No

RQ_IBAN
string

IBAN

Yes

Yes

No

No

RQ_SWIFT
string

SWIFT

Yes

Yes

No

No

RQ_BIC
string

BIC

Yes

Yes

No

No

COMMENTS
string

Comment

Yes

Yes

No

No

ORIGINATOR_ID
string

Identifier of the external information base. The purpose of the field may change by the final developer

Yes

Yes

No

No

Overview of Methods

Method

Description

crm.requisite.bankdetail.add

Creates a new bank detail

crm.requisite.bankdetail.update

Modifies an existing bank detail

crm.requisite.bankdetail.get

Returns the bank detail by identifier

crm.requisite.bankdetail.list

Returns a list of bank details by filter

crm.requisite.bankdetail.delete

Deletes a bank detail

crm.requisite.bankdetail.fields

Returns a formal description of bank detail fields