Отчет по отгрузкам
Получение отгрузок (реализаций) за указанный период. Включает информацию о товарах, услугах, клиентах, транспорте и материалах.
Запрос
POST /api/application/report
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
SecretKey |
string | Да | Секретный ключ |
StartDate |
datetime | Да | Начало периода (например: 2024-01-01 00:00:00) |
EndDate |
datetime | Да | Окончание периода (например: 2024-01-31 23:59:59) |
Пример запроса
{
"SecretKey": "2akgzOCYsAxLwpNl",
"StartDate": "2024-12-01 00:00:00",
"EndDate": "2024-12-12 23:59:59"
}
Ответ
Успешный ответ (200)
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Success |
boolean | Да | Успешно ли построен отчет |
Message |
string | Нет | Сообщение об ошибке (null если успешно) |
Data |
array | Да | Массив отгрузок |
Структура Data[] (основные поля)
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Id |
integer | Да | ID заявки в базе Цифры |
Doc |
string | Нет | Номер документа в программе бетонного завода |
Guid |
string|null | Нет | GUID реализации в 1C (заполняется после создания реализации в 1С) |
IntegrationUnitId |
integer|null | Нет | ID подразделения интеграции (из настроек связи с 1С) |
MixId |
integer | Да | ID бетонного завода |
ShortNumber |
string | Нет | Короткий номер отгрузки (например: "Д10-5") |
Total |
float | Да | Фактический объем отгрузки (м³) |
TotalClient |
float | Да | Объем в документах для клиента (м³). Если не задан, равен Total |
Type |
string | Да | Тип доставки: delivery (доставка), take-away (самовывоз), production (производство) |
Status |
string | Да | Статус заявки: new, loading, delivery, object, pouring, return, done |
PaymentMethod |
string|null | Нет | Способ оплаты: bankWithVAT, bankWithoutVAT, cashbox, cash, transfer |
Date |
datetime | Да | Дата и время окончания загрузки (в timezone бетонного завода) |
StartAt |
datetime|null | Нет | Дата и время начала загрузки (в timezone бетонного завода) |
Recipe |
object | Да | Рецепт бетона
Структура Recipe |
Client |
object | Да | Контрагент (покупатель)
Структура Client/Seller/Carrier |
Products |
array | Да | Товары в отгрузке
Структура Products[] |
Services |
array | Да | Услуги в отгрузке
Структура Services[] |
Zone |
object|null | Нет | Зона доставки
Структура Zone |
Delivery |
object | Да | Информация о доставке
Структура Delivery |
Seller |
object | Да | Организация-продавец (см. структуру Company) |
Carrier |
object | Да | Организация-перевозчик (см. структуру Company) |
Car |
object | Да | Транспортное средство
Структура Car |
Driver |
object | Да | Водитель
Структура Driver |
Manager |
object | Нет | Менеджер
Структура Manager |
Spec |
object | Нет | Спецификация (дополнительная номенклатура)
Структура Spec |
Contract |
object | Да | Договор
Структура Contract |
Invoice |
object | Да | Счет
Структура Invoice |
Materials |
array | Да | Материалы (сырье) в рецепте
Структура Materials[] |
Структура Recipe
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Id |
integer | Да | ID рецепта в базе Цифры |
Guid |
string|null | Нет | GUID номенклатуры в 1С |
CharacteristicGuid |
string|null | Нет | GUID характеристики номенклатуры в 1С |
Name |
string | Да | Наименование рецепта |
Price |
float | Да | Цена за м³ |
IntegrationUnitId |
integer|null | Нет | ID подразделения интеграции |
Структура Client / Seller / Carrier
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Id |
integer | Да | ID компании в базе Цифры |
Guid |
string|null | Нет | GUID контрагента в 1С |
Name |
string | Да | Название компании |
Inn |
string|null | Нет | ИНН (только для Client) |
IntegrationUnitId |
integer|null | Нет | ID подразделения интеграции |
Структура Products[]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Id |
integer | Да | ID товара (номенклатуры) в базе Цифры |
ServiceId |
integer | Да | ID записи о товаре в таблице application_services |
Guid |
string|null | Нет | GUID номенклатуры в 1С |
CharacteristicGuid |
string|null | Нет | GUID характеристики номенклатуры в 1С |
Name |
string | Да | Наименование товара |
Price |
float | Да | Цена за единицу |
Sum |
float | Да | Общая сумма |
Quantity |
float | Да | Количество |
VatRate |
string | Да | Ставка НДС (например: "20%", "0%") |
VatInPrice |
boolean | Да | НДС включен в цену |
IntegrationUnitId |
integer|null | Нет | ID подразделения интеграции |
Структура Services[]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Id |
integer | Да | ID услуги в таблице application_services |
GoodId |
integer | Да | ID связанной номенклатуры в базе Цифры |
Guid |
string|null | Нет | GUID номенклатуры в 1С (обычно берется из тарифа) |
Name |
string | Да | Наименование услуги |
Price |
float | Да | Цена за единицу |
Sum |
float | Да | Общая сумма |
Quantity |
float | Да | Количество |
VatRate |
string | Да | Ставка НДС (например: "20%", "0%") |
VatInPrice |
boolean | Да | НДС включен в цену |
IntegrationUnitId |
integer|null | Нет | ID подразделения интеграции |
TariffId |
integer|null | Нет | ID тарифа услуги |
Структура Zone
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Id |
integer | Да | ID зоны доставки в базе Цифры |
Guid |
string|null | Нет | GUID зоны доставки в 1С |
Name |
string | Да | Название зоны |
Примечание: Если зона доставки не назначена, поле Zone будет null.
Структура Delivery
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Address |
string | Да | Адрес доставки (пустая строка для самовывоза) |
Distance |
float | Да | Расстояние до объекта (км) |
DistanceToObjectPlan |
float | Да | Плановое расстояние до объекта (км) |
OnObjectTime |
float | Да | Время нахождения на объекте (минуты) |
Price |
float | Да | Стоимость доставки |
Структура Car
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Id |
integer | Да | ID транспортного средства в базе Цифры |
Guid |
string|null | Нет | GUID ТС в 1С |
CarNumber |
string | Да | Номер автомобиля |
Volume |
float | Да | Объем миксера (м³) |
Rent |
string|null | Нет | Признак арендованного ТС (например: "rent") |
IntegrationUnitId |
integer|null | Нет | ID подразделения интеграции |
Структура Driver
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Id |
integer | Да | ID водителя в базе Цифры |
Guid |
null | Нет | Всегда null (водители не синхронизируются с 1С) |
Name |
string | Да | ФИО водителя |
Структура Manager
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Id |
integer|null | Нет | ID менеджера в базе Цифры |
Name |
string|null | Нет | ФИО менеджера |
Phone |
string|null | Нет | Телефон менеджера |
Структура Spec
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Id |
integer|null | Нет | ID спецификации в базе Цифры |
Guid |
string|null | Нет | GUID номенклатуры в 1С |
CharacteristicGuid |
string|null | Нет | GUID характеристики номенклатуры в 1С |
Name |
string|null | Нет | Наименование |
IntegrationUnitId |
integer|null | Нет | ID подразделения интеграции |
Структура Contract
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Id |
integer | Да | ID договора в базе Цифры |
Guid |
string|null | Нет | GUID договора в 1С |
Name |
string | Да | Номер/название договора |
IntegrationUnitId |
integer|null | Нет | ID подразделения интеграции |
Структура Invoice
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Id |
integer | Да | ID счета в базе Цифры |
Guid |
string|null | Нет | GUID счета в 1С |
Name |
string | Да | Номер счета |
IntegrationUnitId |
integer|null | Нет | ID подразделения интеграции |
Структура Materials[]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| Примечание: Структура массива Materials зависит от данных рецепта и может содержать различные поля. Обычно включает информацию о сырье (цемент, песок, щебень и др.) с указанием количества и характеристик. Для работы с материалами используйте отдельный метод API Расход материалов. | |||
Пример ответа
{
"Success": true,
"Message": null,
"Data": [
{
"Id": 12345,
"Doc": "3432",
"Guid": "22db4291-154f-11ec-973e-244bfecb4e0a",
"IntegrationUnitId": 5,
"MixId": 3,
"ShortNumber": "Д10-5",
"Total": 12.0,
"TotalClient": 11.8,
"Type": "delivery",
"Status": "done",
"PaymentMethod": "bankWithVAT",
"Date": "2024-12-09 13:00:52",
"StartAt": "2024-12-09 12:41:40",
"Recipe": {
"Id": 45,
"Guid": "33ab5192-265g-22fc-a84f-355cgfdc5f1b",
"CharacteristicGuid": "44bc6203-376h-33gd-b95g-466dghde6g2c",
"Name": "БСТ В12,5П3 F50W2",
"Price": 4500.0,
"IntegrationUnitId": 5
},
"Client": {
"Id": 123,
"Guid": "55cd7314-487i-44he-c06h-577ehife7h3d",
"Name": "ООО Заказчик Бетона",
"Inn": "7604377806",
"IntegrationUnitId": 5
},
"Products": [
{
"Id": 45,
"ServiceId": 892,
"Guid": "66de8425-598j-55if-d17i-688fijgf8i4e",
"CharacteristicGuid": "77ef9536-6a9k-66jg-e28j-799gjkhg9j5f",
"Name": "БСТ В12,5П3 F50W2",
"Price": 4500.0,
"Sum": 54000.0,
"Quantity": 12.0,
"VatRate": "20%",
"VatInPrice": true,
"IntegrationUnitId": 5
}
],
"Services": [
{
"Id": 893,
"GoodId": 67,
"Guid": "88fg0647-7b0l-77kh-f39k-800hklih0k6g",
"Name": "Доставка бетона",
"Price": 4000.0,
"Sum": 4000.0,
"Quantity": 1.0,
"VatRate": "20%",
"VatInPrice": true,
"IntegrationUnitId": 5,
"TariffId": 15
}
],
"Zone": {
"Id": 8,
"Guid": "99gh1758-8c1m-88li-g40l-911ikjli1l7h",
"Name": "Зона 1 (до 30 км)"
},
"Delivery": {
"Address": "Тула, Менделеевская улица, 12В",
"Distance": 34.5,
"DistanceToObjectPlan": 32.0,
"OnObjectTime": 40.0,
"Price": 4000.0
},
"Seller": {
"Id": 10,
"Guid": "aahi2869-9d2n-99mj-h51m-a22jlkmj2m8i",
"Name": "ООО Бетонный Завод №3",
"Inn": "7123456789",
"IntegrationUnitId": 5
},
"Carrier": {
"Id": 15,
"Guid": "bbij397a-ae3o-aanl-i62n-b33kmnkl3n9j",
"Name": "ИП Перевозчиков",
"Inn": "7198765432",
"IntegrationUnitId": 5
},
"Car": {
"Id": 89,
"Guid": "ccjk4a8b-bf4p-bbnm-j73o-c44lnoml4oak",
"CarNumber": "В700ТК797",
"Volume": 8.0,
"Rent": null,
"IntegrationUnitId": 5
},
"Driver": {
"Id": 78,
"Guid": null,
"Name": "Иванов Петр Андреевич"
},
"Manager": {
"Id": 25,
"Name": "Петрова Анна Сергеевна",
"Phone": "+79001234567"
},
"Spec": {
"Id": 150,
"Guid": "ddkl5b9c-cg5q-ccon-k84p-d55monpm5pbm",
"CharacteristicGuid": "eelm6cad-dh6r-ddpo-l95q-e66npoqn6qcn",
"Name": "Добавка пластификатор",
"IntegrationUnitId": 5
},
"Contract": {
"Id": 456,
"Guid": "ffmn7dbe-ei7s-eeqp-ma6r-f77oqpro7rdo",
"Name": "Договор №123/2024 от 01.01.2024",
"IntegrationUnitId": 5
},
"Invoice": {
"Id": 789,
"Guid": "ggno8ecf-fj8t-ffqq-nb7s-g88prqsp8sep",
"Name": "Счет №456 от 05.12.2024",
"IntegrationUnitId": 5
},
"Materials": []
}
]
}
Коды ответов
| Код | Описание |
|---|---|
200 |
Успешно |
403 |
Секретный ключ не найден |
Примечания
- Фильтрация по статусу: Возвращаются только завершенные отгрузки со статусом
done - Работа с GUID:
- Поле
Guidв основной структуре будет заполнено только после создания реализации в 1С через заданиеcreateApplication - GUID для номенклатур (Recipe, Products, Services, Spec) могут быть разделены на
Guid(номенклатура) иCharacteristicGuid(характеристика)
- Поле
- IntegrationUnitId: ID подразделения интеграции заполняется только если настроена связь с конкретным подразделением 1С
- Timezone: Все даты и время возвращаются в timezone бетонного завода (по полю MixId)
- Nullable поля: Многие поля могут быть
null, если информация не была заполнена в системе (Zone, Manager, Spec и др.) - Materials: Массив Materials содержит JSON-структуру с расходом сырья. Для детальной работы с материалами используйте отдельный API метод
- VatInPrice: Если
true, то НДС уже включен в цену товара/услуги - Driver.Guid: Всегда
null, так как водители не синхронизируются с 1С