Создание поставщика

Метод позволяет создать нового поставщика в компании.

Endpoint: POST /v1/supplier

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

Имя	Тип	Описание
name	string	Название поставщика
default_margin	number	Наценка по умолчанию, применяемая к товарам поставщика
phone_numbers	[]string	Список телефонных номеров поставщика
note	string	Примечание к поставщику
detail	object	Реквизиты поставщика
detail.legal_name	string	Юридическое название поставщика
detail.country_id	string (uuid)	Идентификатор страны
detail.legal_address	string	Юридический адрес поставщика
detail.inn	string	ИНН поставщика
detail.mfo	string	МФО банка поставщика
detail.bank_account	object	Банковский счёт поставщика
detail.bank_account.name	string	Название банка
detail.bank_account.account_number	string	Номер банковского счёта
detail.postal_code	string	Почтовый индекс
documents	[]object	Список документов поставщика
documents[].file_name	string	Название файла документа
documents[].file_url	string	Ссылка на файл документа

{
    "name": "some name",
    "default_margin": 0,
    "phone_numbers": [
        "+998901234567"
    ],
    "note": "some note",
    "detail": {
        "legal_name": "some legal name",
        "country_id": "00000000-0000-0000-0000-000000000000",
        "legal_address": "some legal address",
        "inn": "000000000",
        "mfo": "00000",
        "bank_account": {
            "name": "some bank name",
            "account_number": "00000000000000000000"
        },
        "postal_code": "000000"
    },
    "documents": [
        {
            "file_name": "some file name",
            "file_url": "<https://some-file-url>"
        }
    ]
}

Пример запроса

curl -X 'POST' \
  '<https://api-admin.billz.ai/v1/supplier>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {token}' \
  -H 'Platform-Id: {platform_id}' \
  -H 'Billz-Response-Channel: HTTP' \
  -d '{
    "name": "some name",
    "default_margin": 0,
    "phone_numbers": [
        "+998901234567"
    ],
    "note": "some note",
    "detail": {
        "legal_name": "some legal name",
        "country_id": "{country_id}",
        "legal_address": "some legal address",
        "inn": "000000000",
        "mfo": "00000",
        "bank_account": {
            "name": "some bank name",
            "account_number": "00000000000000000000"
        },
        "postal_code": "000000"
    },
    "documents": [
        {
            "file_name": "some file name",
            "file_url": "<https://some-file-url>"
        }
    ]
}'

Параметры ответа

Имя	Тип	Описание
session_id	string (uuid)	Идентификатор сессии клиента
status_code	number	Статус код HTTP
id	string (uuid)	Идентификатор созданного поставщика
error	object	Объект возвращаемой ошибки
error.code	string	Код возвращаемой ошибки. Пустая строка, если ошибки нет
error.message	string	Текст возвращаемой ошибки. Пустая строка, если ошибки нет
data	object	Созданный поставщик
data.id	string (uuid)	Идентификатор поставщика
data.external_id	number	Внешний (порядковый) идентификатор поставщика
data.company_id	string (uuid)	Идентификатор компании
data.name	string	Название поставщика
data.default_margin	number	Наценка по умолчанию
data.phone_numbers	[]string	Список телефонных номеров поставщика
data.note	string	Примечание к поставщику
data.detail	object	Реквизиты поставщика
data.detail.legal_name	string	Юридическое название поставщика
data.detail.country_id	string (uuid)	Идентификатор страны
data.detail.legal_address	string	Юридический адрес поставщика
data.detail.inn	string	ИНН поставщика
data.detail.mfo	string	МФО банка поставщика
data.detail.bank_account	object	Банковский счёт поставщика
data.detail.bank_account.id	string (uuid)	Идентификатор банковского счёта
data.detail.bank_account.supplier_id	string (uuid)	Идентификатор поставщика
data.detail.bank_account.name	string	Название банка
data.detail.bank_account.account_number	string	Номер банковского счёта
data.detail.postal_code	string	Почтовый индекс
data.documents	[]object	Список документов поставщика
data.session_id	string (uuid)	Идентификатор сессии клиента
correlation_id	string (uuid)	Идентификатор запроса
topic	string	Название топика обработчика

Пример ответа

{
    "session_id": "ae3e9489-f37b-4d6e-94d8-da2624262c3c",
    "status_code": 200,
    "id": "5b6f4816-4af8-4cb6-aaa9-16f1d4e8a63f",
    "error": {
        "code": "",
        "message": ""
    },
    "data": {
        "company_id": "8f8aeb93-e88e-4b2e-84f1-8e5f7f132764",
        "default_margin": 0,
        "detail": {
            "bank_account": {
                "account_number": "",
                "id": "",
                "name": "",
                "supplier_id": "5b6f4816-4af8-4cb6-aaa9-16f1d4e8a63f"
            },
            "country_id": "",
            "id": "",
            "inn": "",
            "legal_address": "",
            "legal_name": "",
            "mfo": "",
            "postal_code": ""
        },
        "documents": [],
        "external_id": 788827,
        "id": "5b6f4816-4af8-4cb6-aaa9-16f1d4e8a63f",
        "name": "new supplier",
        "note": "comment",
        "phone_numbers": [
            "+998000000001"
        ],
        "session_id": "ae3e9489-f37b-4d6e-94d8-da2624262c3c"
    },
    "correlation_id": "43ca6cd3-58da-48fc-ba87-c0f8d15ac03c",
    "topic": "v1.user_service.supplier.created"
}