Счет

Примеры изображений документов

Документы для обработки должны быть закодированы в формат base64

Отправка документа

Структура запроса:

url: https://api.beorg.ru/api/bescan/add_document
method: POST
headers:
    Content-Type: application/json

body:
{
    "project_id": "U_RATE_2",
    "images": ["<строка base64>"],
    "process_info": [настройки обработки]
    "token": token,
    "machine_uid": machine_uid
}

Пример ответа об успешной загрузке:

{
    "document_id": "s-12345"
}

Структура передаваемых данных:

Ключ	Описание
project_id	название проекта
token	токен доступа
machine_uid	идентификатор устройства
images	список из строк base64 (файлов)
process_info	настройки обработки

Структура prosess_info:

Ключ	Описание
key	свободный ключ для разделения документов при загрузке и получении результатов если не указан вместо него используется улюч type
type	тип документа
options	опции обработки документа

Структура process_info.options:

Ключ	Описание
stages	этапы обработки документа (Доступны: verification, biometry_match, biometry_liveness)
relation	связь с иным документом в одном запросе (Доступны: biometry_match)

Для получения token, machine_uid и project_id обратитесь в подраздел "Начало работы"

Python

import requests
import base64

with open("<путь до файла Счета>", "rb") as image_file:
    b64 = base64.b64encode(image_file.read()).decode()

r = requests.post(
    "https://api.beorg.ru/api/bescan/add_document",
    headers={"Content-Type": "application/json"},
    json={
        "project_id": project_id,
        "token": token,
        "machine_uid": machine_uid,
        "images": [b64],
        "process_info": [
            {
                "key": "INV1",
                "type": "INV",
            }
        ],
    },
)
r.json()

Получение результатов

Структура запроса:

url: https://api.beorg.ru/api/document/result/s-12345?token=
methods: GET, POST

Python

import requests
import base64
r = requests.get("https://api.beorg.ru/api/document/result/s-12345?token=")
r.json()

Пример ответа по обработанному документу:

{
  "document_id": "s-20919",
  "documents": [
    {
      "key": "INV1",
      "type": "INV",
      "data": {
        "DocNumber": "23000015614",
        "DocDate": "31.03.2023",
        "SellerName": "АКЦИОНЕРНОЕ ОБЩЕСТВО \"ТАНДЕР\"",
        "SellerINV": "2310031475",
        "SellerKPP": "997350001",
        "SellerAddress": "350002, КРАСНОДАРСКИЙ КРАЙ, КРАСНОДАР Г, ЛЕВАНЕВСКОГО 185",
        "SellerPhoneNumber": "",
        "SellerAccountNumber": "40702810930010120150",
        "SellerBankName": "КРАСНОДАРСКОЕ ОТДЕЛЕНИЕ N8619 ПАО СБЕРБАНК",
        "SellerBankBIK": "040349602",
        "SellerBankCorrespondentAccountNumber": "30101810100000000602",
        "CustomerName": "ООО \"НИЛЬСЕН ДЭЙТА ФЭКТОРИ\"",
        "CustomerINV": "773301001",
        "CustomerKPP": "773301001",
        "CustomerAddress": "125362, МОСКВА Г, ТУШИНСКАЯ УЛ, ДОМ № 17, ЭТ. 6, ПОМ. 1",
        "CustomerPhoneNumber": "",
        "CustomerPersonalAccount": "",
        "ShipperName": "",
        "ShipperINV": "",
        "ShipperKPP": "",
        "ShipperAddress": "",
        "ShipperPhoneNumber": "",
        "ConsigneeName": "",
        "ConsigneeINV": "",
        "ConsigneeKPP": "",
        "ConsigneeAddress": "",
        "ConsigneePhoneNumber": "",
        "InvoiceBase": "ДС №ГК/6162/-11 ОТ 23.05.2022 ДОГОВОР №ГК/6162/14 ОТ 30.04.2014",
        "Currency": "",
        "ProductNumber": "",
        "ProductName": "",
        "ProductCode": "",
        "ProductMeasurementUnit": "",
        "ProductUnitsNumber": "",
        "ProductPrice": "",
        "ProductAmountWithoutNDS": "",
        "ProductNDSRate": "",
        "ProductNDSAmount": "",
        "ProductTotalAmountWithNDS": "",
        "DocAmountWithoutNDS": "",
        "DocNDSRate": "",
        "DocNDSAmount": "910300,00",
        "DocTotalAmountWithNDS": "5461800,00",
        "TotalAmountInWords": "5461800,00",
        "PrepaymentAmount": "",
        "PrepaymentPercent": "",
        "PresenceOrToOrder": "",
        "DeliveryTime": null,
        "DeliveryPrice": "",
        "DeliveryAddress": "",
        "DirectorGender": "F",
        "DirectorLastName": "БРОРИСОВА",
        "DirectorFirstName": "К.",
        "DirectorMiddleName": "В.",
        "HasDirectorSignature": true,
        "ChiefAccountantGender": "",
        "ChiefAccountantLastName": "",
        "ChiefAccountantFirstName": "",
        "ChiefAccountantMiddleName": "",
        "HasChiefAccountantSignature": false,
        "AccountantGender": "F",
        "AccountantLastName": "БОРИСОВА",
        "AccountantFirstName": "К.",
        "AccountantMiddleName": "В.",
        "HasAccountantSignature": true,
        "ResponsibleGender": "",
        "ResponsibleLastName": "",
        "ResponsibleFirstName": "",
        "ResponsibleMiddleName": "",
        "HasResponsibleSignature": false,
        "HasSeal": true
      },
      "metadata": {
        "confidences": null,
        "verifications": {}
      }
    }
  ]
}

Описание ключей

Ключ	Тип	Описание
document_id	string	номер документа в формате s-<номер документа>
documents	list	список данных по каждому документу
documents[].key	string	ключ заданный при отправке документа для отслеживания
documents[].type	string	тип документа
documents[].data	dictionary	обработанные данные по каждому полю, содержит ключи полей и их определенные значения
DocNumber	string	Номер документа
DocDate	string	Дата документа (от)
SellerName	string	Наименование продавца
SellerINN	string	ИНН продавца
SellerKPP	string	КПП продавца
SellerAddress	string	Адрес продавца
SellerPhoneNumber	string	Номер телефона продавца
SellerAccountNumber	string	Расчетный счет продавца
SellerBankName	string	Наименование банка продавца
SellerBankBIK	string	БИК банка продавца
SellerBankCorrespondentAccountNumber	string	Корреспондентский счет банка продавца
CustomerName	string	Наименование покупателя
CustomerINN	string	ИНН покупателя
CustomerKPP	string	КПП покупателя
CustomerAddress	string	Адрес покупателя
CustomerPhoneNumber	string	Номер телефона покупателя
CustomerPersonalAccount	string	Лицевой счет покупателя
ShipperName	string	Наименование (грузо-)отправителя
ShipperINN	string	ИНН (грузо-)отправителя
ShipperKPP	string	КПП (грузо-)отправителя
ShipperAddress	string	Адрес (грузо-)отправителя
ShipperPhoneNumber	string	Номер телефона (грузо-)отправителя
ConsigneeName	string	Наименование (грузо-)получателя
ConsigneeINN	string	ИНН (грузо-)получателя
ConsigneeKPP	string	КПП (грузо-)получателя
ConsigneeAddress	string	Адрес (грузо-)получателя
ConsigneePhoneNumber	string	Номер телефона (грузо-)получателя
InvoiceBase	string	Основание счета
Currency	string	Валюта
ProductNumber	string	Наименование товара
ProductName	string	Артикул товара
ProductArticleNumber	string	Номер позиции товара в таблице
ProductCode	string	Код товара
ProductMeasurementUnit	string	Единица измерения товара
ProductUnitsNumber	string	Количество единиц товара
ProductPrice	string	Цена товара
ProductAmountWithoutNDS	string	Сумма товара без НДС
ProductNDSRate	string	Ставка НДС товара, %
ProductNDSAmount	string	Сумма НДС товара
ProductTotalAmountWithNDS	string	Итоговая сумма товара с НДС
DocAmountWithoutNDS	string	Сумма документа без НДС
DocNDSRate	string	Ставка НДС документа, %
DocNDSAmount	string	Сумма НДС документа
DocTotalAmountWithNDS	string	Итоговая сумма документа с НДС
TotalAmountInWords	string	Итоговая сумма прописью
PrepaymentAmount	string	Сумма предоплаты
PrepaymentPercent	string	Процент предоплаты
PresenceOrToOrder	string	Наличие/на заказ
DeliveryTime	string	Срок поставки
DeliveryPrice	string	Стоимость доставки
DeliveryAddress	string	Адрес доставки
DirectorGender	string	Пол руководителя
DirectorLastName	string	Фамилия руководителя
DirectorFirstName	string	Имя руководителя
DirectorMiddleName	string	Отчество руководителя
HasDirectorSignature	string	Наличие подписи руководителя
ChiefAccountantGender	string	Пол главного бухгалтера
ChiefAccountantLastName	string	Фамилия главного бухгалтера
ChiefAccountantFirstName	string	Имя главного бухгалтера
ChiefAccountantMiddleName	string	Отчество главного бухгалтера
HasChiefAccountantSignature	string	Наличие подписи главного бухгалтера
AccountantGender	string	Пол бухгалтера
AccountantLastName	string	Фамилия бухгалтера
AccountantFirstName	string	Имя бухгалтера
AccountantMiddleName	string	Отчество бухгалтера
HasAccountantSignature	string	Наличие подписи бухгалтера
ResponsibleGender	string	Пол ответственного
ResponsibleLastName	string	Фамилия ответственного
ResponsibleFirstName	string	Имя ответственного
ResponsibleMiddleName	string	Отчество ответственного
HasResponsibleSignature	string	Наличие подписи ответственного
HasSeal	string	Наличие печати
metadata	dictionary	содержит ключи метаданных
confidences	dictionary {key: float}	метаданные с точностью обработки по каждому полю - содержит ключи полей и значения уровня уверенности. Значения от 0.0000 до 0.9999, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность - 0.9999.