Перейти к содержанию

Счет

Первичный документ бухгалтерского учета

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

Документы для обработки должны быть закодированы в формат 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": "",
        "DocDate": "",
        "SellerName": "",
        "SellerINV": "",
        "SellerKPP": "",
        "SellerAccountNumber": "",
        "SellerBankName": "",
        "SellerBankBIK": "",
        "SellerBankCorrespondentAccountNumber": "",
        "CustomerName": "",
        "CustomerINV": "",
        "CustomerKPP": "",
        "ShipperINV": "",
        "ShipperKPP": "",
        "ConsigneeINV": "",
        "ConsigneeKPP": "",
        "InvoiceBase": "",
        "Currency": "",
        "ProductName": "",
        "ProductMeasurementUnit": "",
        "ProductUnitsNumber": "",
        "ProductPrice": "",
        "ProductAmountWithoutNDS": "",
        "ProductNDSRate": "",
        "ProductNDSAmount": "",
        "ProductTotalAmountWithNDS": "",
        "DocAmountWithoutNDS": "",
        "DocNDSRate": "",
        "DocNDSAmount": "",
        "DocTotalAmountWithNDS": "",
        "TotalAmountInWords": "",
        "DeliveryTime": null,
        "HasDirectorSignature": ,
        "HasChiefAccountantSignature": false,
        "HasAccountantSignature": ,
        "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 КПП продавца
SellerAccountNumber string Расчетный счет продавца
SellerBankName string Наименование банка продавца
SellerBankBIK string БИК банка продавца
SellerBankCorrespondentAccountNumber string Корреспондентский счет банка продавца
CustomerName string Наименование покупателя
CustomerINN string ИНН покупателя
CustomerKPP string КПП покупателя
ShipperINN string ИНН (грузо-)отправителя
ShipperKPP string КПП (грузо-)отправителя
ConsigneeINN string ИНН (грузо-)получателя
ConsigneeKPP string КПП (грузо-)получателя
InvoiceBase string Основание счета
Currency string Валюта
ProductName 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 Итоговая сумма прописью
HasDirectorSignature string Наличие подписи руководителя
HasChiefAccountantSignature string Наличие подписи главного бухгалтера
HasAccountantSignature string Наличие подписи бухгалтера
HasResponsibleSignature string Наличие подписи ответственного
HasSeal string Наличие печати
metadata dictionary содержит ключи метаданных
confidences dictionary
{key: float}
метаданные с точностью обработки по каждому полю -
содержит ключи полей и значения уровня уверенности.
Значения от 0.0000 до 0.9999, где чем значение больше,
тем уверенность в результате выше.
Максимальная уверенность - 0.9999.