Цифра ↔ 1С

Отчет по заказам

Получение заказов за указанный период с информацией о входящих в них отгрузках.

Запрос

POST /api/orders/report

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

Параметр Тип Обязательный Описание
SecretKey string Да Секретный ключ
StartDate datetime Да Начало периода
EndDate datetime Да Окончание периода

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

{
  "SecretKey": "2akgzOCYsAxLwpNl",
  "StartDate": "2024-12-01 00:00:00",
  "EndDate": "2024-12-12 23:59:59"
}

Ответ

Структура Data[] (основные поля заказа)

Поле Тип Обязательное Описание
Id integer Да ID заказа в Цифре
Guid string Нет ID в 1C (если связь установлена)
Doc string Да Номер заказа
ShortNumber string Нет Короткий номер заказа (например: "Д10")
Total float Да Общий объем заказа (м³)
Type string Да Тип: delivery, take-away, production
Status string Да Статус: new, confirmed, work, done, completed, canceled
PaymentMethod string Нет Способ оплаты
DeliveryType string Да Тип доставки (дублирует Type): delivery, take-away, production
Date datetime Да Дата и время заказа с учетом часового пояса
FirstOrderTimeDelivery string Нет Время первой отгрузки (формат ЧЧ:ММ:СС)
Comment string Нет Комментарий диспетчера к заказу
Recipe object Нет Рецепт (основной товар заказа). См. структуру Recipe
Client object Нет Контрагент (клиент). См. структуру контрагента
Products array Нет Массив дополнительных товаров (продуктов). См. структуру Products
Services array Нет Массив услуг. См. структуру Services
Zone object Нет Зона доставки. См. структуру Zone
Delivery object Нет Информация о доставке. См. структуру Delivery
Seller object Нет Продавец (компания). См. структуру контрагента
Carrier object Нет Перевозчик (компания). См. структуру контрагента
Manager object Нет Менеджер заказа. См. структуру Manager
Spec object Нет Спецтехника (как товар). См. структуру Spec
Contract object Нет Договор. См. структуру Contract
Invoice object Нет Счет. См. структуру Invoice
Applications array Нет Массив отгрузок в заказе (структура как в отчете по отгрузкам)
Pumps array Нет Массив насосов. См. структуру Pumps

Структура Recipe (рецепт)

Поле Тип Описание
Id integer ID товара (рецепта) в Цифре
Guid string GUID номенклатуры в 1C
CharacteristicGuid string GUID характеристики номенклатуры в 1C
Name string Название рецепта
Price float Цена за м³
IntegrationUnitId integer ID интеграционной единицы (связь с 1C)

Структура контрагента (Client, Seller, Carrier)

Поле Тип Описание
Id integer ID контрагента в Цифре
Guid string GUID контрагента в 1C
Name string Название компании
Inn string ИНН компании
IntegrationUnitId integer ID интеграционной единицы (связь с 1C)

Структура Products[] (дополнительные товары)

Поле Тип Описание
Id integer ID товара в Цифре
ServiceId integer ID записи услуги/товара в таблице услуг
Guid string GUID номенклатуры в 1C
CharacteristicGuid string GUID характеристики номенклатуры в 1C
Name string Название товара
Price float Цена за единицу
Sum float Общая сумма (Price × Quantity)
Quantity float Количество
VatRate string Ставка НДС (например, "20%")
VatInPrice boolean НДС включен в цену
IntegrationUnitId integer ID интеграционной единицы (связь с 1C)

Структура Services[] (услуги)

Поле Тип Описание
Id integer ID услуги в таблице услуг
GoodId integer ID товара (номенклатуры) в Цифре
Guid string GUID номенклатуры услуги в 1C
Name string Название услуги
Price float Цена за единицу
Sum float Общая сумма (Price × Quantity)
Quantity float Количество
VatRate string Ставка НДС (например, "20%")
VatInPrice boolean НДС включен в цену
IntegrationUnitId integer ID интеграционной единицы (связь с 1C)
TariffId integer ID тарифа услуги

Структура Zone (зона доставки)

Поле Тип Описание
Id integer ID зоны доставки в Цифре
Guid string GUID зоны доставки в 1C
Name string Название зоны доставки

Структура Delivery (доставка)

Поле Тип Описание
Address string Адрес доставки
Distance float Расстояние до объекта (км)
Price float Стоимость доставки

Структура Manager (менеджер)

Поле Тип Описание
Id integer ID менеджера в Цифре
Name string ФИО менеджера
Phone string Телефон менеджера

Структура Spec (спецтехника)

Поле Тип Описание
Id integer ID товара (спецтехники) в Цифре
Guid string GUID номенклатуры в 1C
CharacteristicGuid string GUID характеристики номенклатуры в 1C
Name string Название спецтехники
IntegrationUnitId integer ID интеграционной единицы (связь с 1C)

Структура Contract (договор)

Поле Тип Описание
Id integer ID договора в Цифре
Guid string GUID договора в 1C
Name string Номер/название договора
IntegrationUnitId integer ID интеграционной единицы (связь с 1C)

Структура Invoice (счет)

Поле Тип Описание
Id integer ID счета в Цифре
Guid string GUID счета в 1C
Name string Номер счета
IntegrationUnitId integer ID интеграционной единицы (связь с 1C)

Структура Pumps[] (насосы)

Поле Тип Описание
Id integer ID насоса в Цифре
Guid string GUID насоса в 1C
Number string Номер насоса
Rent boolean Арендованный насос
Name string Название/модель насоса
Driver object Водитель насоса (структура: Id, Guid, Name, Phone)

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

{
  "Success": true,
  "Message": null,
  "Data": [
    {
      "Id": 567,
      "Guid": "22db4291-154f-11ec-973e-244bfecb4e0a",
      "Doc": "Z-123",
      "ShortNumber": "Д10",
      "Total": 24.0,
      "Type": "delivery",
      "Status": "done",
      "PaymentMethod": "bankWithVAT",
      "DeliveryType": "delivery",
      "Date": "2024-12-09 08:00:00",
      "FirstOrderTimeDelivery": "08:00:00",
      "Comment": "Подъезд со стороны главного входа",
      "Recipe": {
        "Id": 45,
        "Guid": "33ab5192-265g-22fc-a84f-355cgfdc5f1b",
        "CharacteristicGuid": "44bc6203-376h-33gd-b95g-466dghde6g2d",
        "Name": "БСТ В25П4F200",
        "Price": 4500.0,
        "IntegrationUnitId": 1
      },
      "Client": {
        "Id": 123,
        "Guid": "44cd6203-376h-33gd-b95g-466dghde6g2c",
        "Name": "ООО Заказчик",
        "Inn": "7604377806",
        "IntegrationUnitId": 1
      },
      "Products": [
        {
          "Id": 78,
          "ServiceId": 501,
          "Guid": "55de7314-487i-44he-c06h-577ehief7h3e",
          "CharacteristicGuid": null,
          "Name": "Пластификатор",
          "Price": 150.0,
          "Sum": 300.0,
          "Quantity": 2.0,
          "VatRate": "20%",
          "VatInPrice": true,
          "IntegrationUnitId": 1
        }
      ],
      "Services": [
        {
          "Id": 502,
          "GoodId": 89,
          "Guid": "66ef8425-598j-55if-d17i-688fijfg8i4f",
          "Name": "Доставка бетона",
          "Price": 2500.0,
          "Sum": 2500.0,
          "Quantity": 1.0,
          "VatRate": "20%",
          "VatInPrice": true,
          "IntegrationUnitId": 1,
          "TariffId": 15
        }
      ],
      "Zone": {
        "Id": 10,
        "Guid": "77fg9536-609k-66jg-e28j-799gjkgh9j5g",
        "Name": "Зона 1 (до 10 км)"
      },
      "Delivery": {
        "Address": "Тула, Менделеевская улица, 12В",
        "Distance": 8.5,
        "Price": 2500.0
      },
      "Seller": {
        "Id": 5,
        "Guid": "88gh0647-710l-77kh-f39k-800hklhi0k6h",
        "Name": "ООО Бетонный Завод",
        "Inn": "7604123456",
        "IntegrationUnitId": 1
      },
      "Carrier": {
        "Id": 12,
        "Guid": "99hi1758-821m-88li-g40l-911ilmij1l7i",
        "Name": "ООО Транспортная Компания",
        "Inn": "7604654321",
        "IntegrationUnitId": 1
      },
      "Manager": {
        "Id": 25,
        "Name": "Иванов Иван Иванович",
        "Phone": "+7 (900) 123-45-67"
      },
      "Spec": {
        "Id": 34,
        "Guid": "00ij2869-932n-99mj-h51m-022jmnjk2m8j",
        "CharacteristicGuid": null,
        "Name": "Автобетононасос 42м",
        "IntegrationUnitId": 1
      },
      "Contract": {
        "Id": 18,
        "Guid": "11jk3970-043o-00nk-i62n-133knokl3n9k",
        "Name": "Договор №123 от 01.01.2024",
        "IntegrationUnitId": 1
      },
      "Invoice": {
        "Id": 42,
        "Guid": "22kl4081-154p-11ol-j73o-244loplm4o0l",
        "Name": "Счет №456",
        "IntegrationUnitId": 1
      },
      "Applications": [
        {
          "Id": 12345,
          "Doc": "Z-123-1",
          "Guid": "33lm5192-265q-22pm-k84p-355mpqmn5p1m",
          "IntegrationUnitId": 1,
          "MixId": 1001,
          "ShortNumber": "Д10-1",
          "Total": 12.0,
          "TotalClient": 12.0,
          "Type": "delivery",
          "Status": "done",
          "PaymentMethod": "bankWithVAT",
          "Date": "2024-12-09 08:30:00",
          "StartAt": "2024-12-09 08:00:00",
          "Recipe": {
            "Id": 45,
            "Guid": "33ab5192-265g-22fc-a84f-355cgfdc5f1b",
            "CharacteristicGuid": "44bc6203-376h-33gd-b95g-466dghde6g2d",
            "Name": "БСТ В25П4F200",
            "Price": 4500.0,
            "IntegrationUnitId": 1
          },
          "Client": {
            "Id": 123,
            "Guid": "44cd6203-376h-33gd-b95g-466dghde6g2c",
            "Name": "ООО Заказчик",
            "Inn": "7604377806",
            "IntegrationUnitId": 1
          },
          "Products": [],
          "Services": [],
          "Zone": {
            "Id": 10,
            "Guid": "77fg9536-609k-66jg-e28j-799gjkgh9j5g",
            "Name": "Зона 1 (до 10 км)"
          },
          "Delivery": {
            "Address": "Тула, Менделеевская улица, 12В",
            "Distance": 8.5,
            "DistanceToObjectPlan": 8.2,
            "OnObjectTime": 30.0,
            "Price": 1250.0
          },
          "Seller": {
            "Id": 5,
            "Guid": "88gh0647-710l-77kh-f39k-800hklhi0k6h",
            "Name": "ООО Бетонный Завод",
            "Inn": "7604123456",
            "IntegrationUnitId": 1
          },
          "Carrier": {
            "Id": 12,
            "Guid": "99hi1758-821m-88li-g40l-911ilmij1l7i",
            "Name": "ООО Транспортная Компания",
            "Inn": "7604654321",
            "IntegrationUnitId": 1
          },
          "Car": {
            "Id": 8,
            "Guid": "44mn6203-376r-33qn-l95q-466nqrno6q2n",
            "CarNumber": "А123БВ177",
            "Volume": 12.0,
            "Rent": false,
            "IntegrationUnitId": 1
          },
          "Driver": {
            "Id": 15,
            "Guid": null,
            "Name": "Петров Петр Петрович"
          },
          "Manager": {
            "Id": 25,
            "Name": "Иванов Иван Иванович",
            "Phone": "+7 (900) 123-45-67"
          },
          "Spec": {
            "Id": 34,
            "Guid": "00ij2869-932n-99mj-h51m-022jmnjk2m8j",
            "CharacteristicGuid": null,
            "Name": "Автобетононасос 42м",
            "IntegrationUnitId": 1
          },
          "Contract": {
            "Id": 18,
            "Guid": "11jk3970-043o-00nk-i62n-133knokl3n9k",
            "Name": "Договор №123 от 01.01.2024",
            "IntegrationUnitId": 1
          },
          "Invoice": {
            "Id": 42,
            "Guid": "22kl4081-154p-11ol-j73o-244loplm4o0l",
            "Name": "Счет №456",
            "IntegrationUnitId": 1
          },
          "Materials": []
        },
        {
          "Id": 12346,
          "Doc": "Z-123-2",
          "Guid": "55no7314-487s-44ro-m06r-577ospon7r3o",
          "IntegrationUnitId": 1,
          "MixId": 1002,
          "ShortNumber": "Д10-2",
          "Total": 12.0,
          "TotalClient": 12.0,
          "Type": "delivery",
          "Status": "done",
          "PaymentMethod": "bankWithVAT",
          "Date": "2024-12-09 10:15:00",
          "StartAt": "2024-12-09 09:45:00",
          "Recipe": {
            "Id": 45,
            "Guid": "33ab5192-265g-22fc-a84f-355cgfdc5f1b",
            "CharacteristicGuid": "44bc6203-376h-33gd-b95g-466dghde6g2d",
            "Name": "БСТ В25П4F200",
            "Price": 4500.0,
            "IntegrationUnitId": 1
          },
          "Client": {
            "Id": 123,
            "Guid": "44cd6203-376h-33gd-b95g-466dghde6g2c",
            "Name": "ООО Заказчик",
            "Inn": "7604377806",
            "IntegrationUnitId": 1
          },
          "Products": [],
          "Services": [],
          "Zone": {
            "Id": 10,
            "Guid": "77fg9536-609k-66jg-e28j-799gjkgh9j5g",
            "Name": "Зона 1 (до 10 км)"
          },
          "Delivery": {
            "Address": "Тула, Менделеевская улица, 12В",
            "Distance": 8.5,
            "DistanceToObjectPlan": 8.2,
            "OnObjectTime": 30.0,
            "Price": 1250.0
          },
          "Seller": {
            "Id": 5,
            "Guid": "88gh0647-710l-77kh-f39k-800hklhi0k6h",
            "Name": "ООО Бетонный Завод",
            "Inn": "7604123456",
            "IntegrationUnitId": 1
          },
          "Carrier": {
            "Id": 12,
            "Guid": "99hi1758-821m-88li-g40l-911ilmij1l7i",
            "Name": "ООО Транспортная Компания",
            "Inn": "7604654321",
            "IntegrationUnitId": 1
          },
          "Car": {
            "Id": 9,
            "Guid": "66op8425-598t-55sp-n17s-688ptqpo8s4p",
            "CarNumber": "В456ГД177",
            "Volume": 12.0,
            "Rent": false,
            "IntegrationUnitId": 1
          },
          "Driver": {
            "Id": 16,
            "Guid": null,
            "Name": "Сидоров Сидор Сидорович"
          },
          "Manager": {
            "Id": 25,
            "Name": "Иванов Иван Иванович",
            "Phone": "+7 (900) 123-45-67"
          },
          "Spec": {
            "Id": 34,
            "Guid": "00ij2869-932n-99mj-h51m-022jmnjk2m8j",
            "CharacteristicGuid": null,
            "Name": "Автобетононасос 42м",
            "IntegrationUnitId": 1
          },
          "Contract": {
            "Id": 18,
            "Guid": "11jk3970-043o-00nk-i62n-133knokl3n9k",
            "Name": "Договор №123 от 01.01.2024",
            "IntegrationUnitId": 1
          },
          "Invoice": {
            "Id": 42,
            "Guid": "22kl4081-154p-11ol-j73o-244loplm4o0l",
            "Name": "Счет №456",
            "IntegrationUnitId": 1
          },
          "Materials": []
        }
      ],
      "Pumps": [
        {
          "Id": 20,
          "Guid": "77pq9536-609u-66tq-o28t-799qurqp9t5q",
          "Number": "Н001",
          "Rent": false,
          "Name": "Автобетононасос 42м Putzmeister",
          "Driver": {
            "Id": 30,
            "Guid": null,
            "Name": "Александров Александр",
            "Phone": "+7 (900) 765-43-21"
          }
        }
      ]
    }
  ]
}

Коды ответов

Код Описание
200 Успешно
400 Неверный формат данных

Примечания

См. также