Перейти к основному содержанию
GET
/
v1
/
crm
/
counterparties
cURL
curl --request GET \
  --url https://api.example.com/v1/crm/counterparties/
[
  {
    "id": 123,
    "name": "<string>",
    "access": [
      123
    ],
    "side": 0,
    "source": 0,
    "type": 0,
    "category": 0,
    "iin": "<string>",
    "bin": "<string>",
    "iban": "<string>",
    "bank": "<string>",
    "phone": "<string>",
    "owner": "<string>",
    "address": "<string>",
    "email": "jsmith@example.com",
    "order": -1,
    "extra": "<unknown>",
    "deleted": true,
    "deleted_at": "2023-11-07T05:31:56Z",
    "tenant": 123
  }
]

Параметры запроса

side
enum<integer>
  • 0 - self
  • 1 - foreign
Доступные опции:
0,
1

Ответ

200 - application/json
id
integer
обязательно
name
string
обязательно
Maximum string length: 255
access
integer[] | null
side
enum<integer>
  • 0 - self
  • 1 - foreign
Доступные опции:
0,
1
Требуемый диапазон: -32768 <= x <= 32767
source
enum<integer>
  • 0 - shop
  • 1 - expense
Доступные опции:
0,
1
Требуемый диапазон: -32768 <= x <= 32767
type
enum<integer>
  • 0 - ИП
  • 1 - ТОО
  • 2 - АО
  • 3 - ПК
Доступные опции:
0,
1,
2,
3
Требуемый диапазон: -32768 <= x <= 32767
category
enum<integer>
  • 0 - CREDIT
  • 1 - DEBIT
Доступные опции:
0,
1
Требуемый диапазон: -32768 <= x <= 32767
iin
string | null
Required string length: 12
bin
string | null
Required string length: 12
iban
string | null
Maximum string length: 25
bank
string | null
Maximum string length: 255
phone
string | null
Maximum string length: 32
owner
string | null
Maximum string length: 255
address
string | null
Maximum string length: 255
email
string<email> | null
Maximum string length: 254
order
integer | null
Требуемый диапазон: -2147483648 <= x <= 2147483647
extra
any
deleted
boolean
deleted_at
string<date-time> | null
tenant
integer