#Requisites

Entity: requisite | Scope: crm | Base path: /v1/requisites

Legacy entity (UPPER_CASE field names) — field names are automatically converted to camelCase.

#Operations

Method Path Description Bitrix24 Method
GET /v1/requisites List all (with filter, sort, pagination) crm.requisite.list
GET /v1/requisites/:id Get by ID crm.requisite.get
POST /v1/requisites Create new crm.requisite.add
PATCH /v1/requisites/:id Update by ID crm.requisite.update
DELETE /v1/requisites/:id Delete by ID crm.requisite.delete
GET /v1/requisites/fields Get available fields crm.requisite.fields

#Fields

API Name Bitrix24 Name Type Readonly Description
id ID number yes Идентификатор записи
entityTypeId ENTITY_TYPE_ID number
entityId ENTITY_ID number
presetId PRESET_ID number
name NAME string
active ACTIVE boolean
sort SORT number
rqName RQ_NAME string
rqInn RQ_INN string
rqKpp RQ_KPP string
rqOgrn RQ_OGRN string

#Examples

#List

Terminal 
curl -X GET '/v1/requisites?limit=10' \
  -H 'X-Api-Key: YOUR_KEY'

#Get by ID

Terminal 
curl -X GET '/v1/requisites/123' \
  -H 'X-Api-Key: YOUR_KEY'

#Create

Terminal 
curl -X POST '/v1/requisites' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"entityTypeId":1,"entityId":1,"presetId":1}'

#Update

Terminal 
curl -X PATCH '/v1/requisites/123' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"updated"}'

#Delete

Terminal 
curl -X DELETE '/v1/requisites/123' \
  -H 'X-Api-Key: YOUR_KEY'

#Batch

Terminal 
curl -X POST '/v1/batch' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"calls":[{"entity":"requisites","action":"list","params":{"limit":5}}]}'