لوكلاء AI: ملف markdown لهذه الصفحة — /docs-content-en/entities/bank-details.md فهرس التوثيق — /llms.txt

مقالات التوثيق متاحة حاليًا باللغة الإنجليزية فقط.

Bank details

Bank accounts attached to a requisite: current account, BIC, correspondent account, SWIFT, IBAN. Without a bank detail, you cannot issue an invoice.

Bitrix24 API: crm.requisite.bankdetail.* Scope: crm

Create bank detail

POST /v1/bank-details

Creates a new bank detail and links it to a CRM requisite. A deleted record cannot be restored — create a new one if needed.

Request fields (body)

Field Type Required Description
FieldentityId Typenumber Requiredyes DescriptionID of the owner requisite. Lookup: GET /v1/requisites
Fieldname Typestring Requiredyes DescriptionBank detail name
FieldentityTypeId Typenumber Requiredno DescriptionParent entity type. Pass 8 to link the record to a requisite
FieldrqBik Typestring Requiredno DescriptionBank BIC
FieldrqAccNum Typestring Requiredno DescriptionCurrent account
FieldrqCorAccNum Typestring Requiredno DescriptionCorrespondent account
FieldrqSwift Typestring Requiredno DescriptionSWIFT code
FieldrqIban Typestring Requiredno DescriptionIBAN number
FieldrqBankName Typestring Requiredno DescriptionBank name
FieldrqBankAddr Typestring Requiredno DescriptionBank address
FieldrqAccName Typestring Requiredno DescriptionAccount holder name
FieldrqAccCurrency Typestring Requiredno DescriptionAccount currency
Fieldactive Typeboolean Requiredno DescriptionWhether the detail is active. Defaults to true
Fieldsort Typenumber Requiredno DescriptionSort order. Defaults to 500
Fieldcode / xmlId / originatorId Typestring Requiredno DescriptionExternal identifiers for synchronization
Fieldcomments Typestring Requiredno DescriptionComment

The id, createdAt, updatedAt, createdBy, modifyBy fields are set by the system and ignored on write.

Examples

curl — personal key

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/bank-details" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityTypeId": 8,
    "entityId": 1,
    "name": "Current account",
    "rqBik": "37040044",
    "rqAccNum": "0532013000",
    "rqSwift": "DEUTDEFF"
  }'

curl — OAuth application

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/bank-details" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "entityTypeId": 8,
    "entityId": 1,
    "name": "Current account",
    "rqBik": "37040044",
    "rqAccNum": "0532013000",
    "rqSwift": "DEUTDEFF"
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/bank-details', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    entityTypeId: 8,
    entityId: 1,
    name: 'Current account',
    rqBik: '37040044',
    rqAccNum: '0532013000',
    rqSwift: 'DEUTDEFF',
  }),
})

const { success, data } = await res.json()
console.log('Created bank detail ID:', data.id)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/bank-details', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    entityTypeId: 8,
    entityId: 1,
    name: 'Current account',
    rqBik: '37040044',
    rqAccNum: '0532013000',
    rqSwift: 'DEUTDEFF',
  }),
})

const { success, data } = await res.json()
console.log('Created bank detail ID:', data.id)

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionThe created bank detail
Fielddata.id Typenumber DescriptionID of the new record
Fielddata.entityId Typenumber DescriptionID of the owner requisite
Fielddata.countryId Typenumber DescriptionCountry ID; 0 if the country is not set
Fielddata.name Typestring | null DescriptionName
Fielddata.active Typeboolean DescriptionWhether the detail is active
Fielddata.sort Typenumber DescriptionSort order
Fielddata.rqBik Typestring | null DescriptionBank BIC
Fielddata.rqAccNum Typestring | null DescriptionCurrent account
Fielddata.rqCorAccNum Typestring | null DescriptionCorrespondent account
Fielddata.rqSwift Typestring | null DescriptionSWIFT code
Fielddata.rqIban Typestring | null DescriptionIBAN number
Fielddata.rqBankName Typestring | null DescriptionBank name
Fielddata.rqBankAddr Typestring | null DescriptionBank address
Fielddata.rqAccName Typestring | null DescriptionAccount holder name
Fielddata.rqAccCurrency Typestring | null DescriptionAccount currency
Fielddata.comments Typestring | null DescriptionComment
Fielddata.createdAt Typedatetime DescriptionCreation date (ISO 8601)
Fielddata.updatedAt Typedatetime | null DescriptionLast modification date
Fielddata.createdBy Typenumber DescriptionCreator ID
Fielddata.modifyBy Typenumber | null Descriptionnull right after creation

Unset fields are returned as null. Full list — GET /v1/bank-details/fields.

Response example

HTTP status: 201 Created

JSON 
{
  "success": true,
  "data": {
    "id": 19,
    "entityId": 1,
    "countryId": 0,
    "createdAt": "2026-06-10T10:14:29.000Z",
    "updatedAt": null,
    "createdBy": 1,
    "modifyBy": null,
    "name": "Current account",
    "code": null,
    "xmlId": null,
    "originatorId": null,
    "active": true,
    "sort": 500,
    "rqBankName": null,
    "rqBankAddr": null,
    "rqBik": "37040044",
    "rqAccName": null,
    "rqAccNum": "0532013000",
    "rqAccCurrency": null,
    "rqCorAccNum": null,
    "rqIban": null,
    "rqSwift": "DEUTDEFF",
    "comments": null
  }
}

Error response example

422 — entityId not provided:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "ENTITY_ID is not defined or invalid."
  }
}

Errors

HTTP Code Description
HTTP422 CodeBITRIX_ERROR DescriptionentityTypeId or entityId not provided, or Bitrix24 rejected the field value
HTTP403 CodeSCOPE_DENIED DescriptionKey lacks the crm scope. Message: This endpoint requires 'crm' scope
HTTP401 CodeTOKEN_MISSING DescriptionX-Api-Key not provided

Full list of common API errors — Errors.

Known specifics

entityTypeId is not returned on read. This is an owner field: you pass it on creation with the value 8, but it is absent from the GET /v1/bank-details/:id response and from the list.

See also