{
  "openapi": "3.0.1",
  "info": {
    "title": "Документация по SelSup API",
    "description": "API SelSup — программный интерфейс для работы с сервисом SelSup. Даёт возможность работать со всеми функциями SelSup из вашей системы. Для использования API добавьте новый токен на странице:https://selsup.ru/application/integration/api. Добавленный токен необходимо передавать во всех запросах к API SelSup, в заголовке Authorization.",
    "contact": {
      "name": "Support Team",
      "email": "admin@selsup.ru"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://selsup.ru/dogovor-offerta/"
    },
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.selsup.ru/",
      "description": "Production server"
    }
  ],
  "tags": [
    {
      "name": "Биллинг",
      "description": "Методы для работы с билингом для фулфилмента"
    }
  ],
  "paths": {
    "/api/billing/find": {
      "get": {
        "tags": [
          "Биллинг"
        ],
        "summary": "Получение операций биллинга за период",
        "description": "Возвращает данные как для клиента так и для фулфилмента",
        "operationId": "getBillingOperation",
        "parameters": [
          {
            "name": "from",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Ограничение на количество записей. Максимальное значение - 500",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Ограничение на количество записей. Максимальное значение - 500",
              "format": "int32"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Номер страницы начиная с 1",
            "required": false,
            "schema": {
              "type": "integer",
              "description": "Номер страницы начиная с 1",
              "format": "int32"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "Возвратить в ответе общее количество записей",
            "required": false,
            "schema": {
              "type": "boolean",
              "description": "Возвратить в ответе общее количество записей"
            }
          },
          {
            "name": "sortBy",
            "in": "query",
            "description": "Поле сортировки записей. Работает только при получении списка.",
            "required": false,
            "schema": {
              "type": "string",
              "description": "Поле сортировки записей. Работает только при получении списка."
            }
          },
          {
            "name": "ascending",
            "in": "query",
            "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.",
            "required": false,
            "schema": {
              "type": "boolean",
              "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка."
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/hal+json": {
                "schema": {
                  "$ref": "#/components/schemas/FindResponseBilling"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Billing": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Идентификатор биллинга. Проставляется автоматически",
            "format": "int64"
          },
          "name": {
            "type": "string",
            "description": "Наименование операции биллинга"
          },
          "productId": {
            "type": "integer",
            "description": "Идентификатор товара, для которого рассчитан биллинг",
            "format": "int64"
          },
          "itemId": {
            "type": "integer",
            "description": "привязка к единице хранения на складе",
            "format": "int64"
          },
          "orderId": {
            "type": "integer",
            "description": "Заказ по которому был рассчитан биллинг",
            "format": "int64"
          },
          "price": {
            "type": "number",
            "format": "double"
          },
          "volume": {
            "type": "integer",
            "description": "объем для операций, которые зависят от объема",
            "format": "int32"
          },
          "weight": {
            "type": "integer",
            "format": "int32"
          },
          "quantity": {
            "type": "integer",
            "format": "int32"
          },
          "totalPrice": {
            "type": "number",
            "format": "double"
          },
          "tariffId": {
            "type": "integer",
            "description": "идентификатор тарифа для хранения или короба",
            "format": "int64"
          },
          "linkedClientId": {
            "type": "integer",
            "description": "идентификатор клиента фулфилмента",
            "format": "int64"
          },
          "clientId": {
            "type": "integer",
            "description": "идентификатор клиента самого фулфилмента",
            "format": "int64"
          },
          "from": {
            "type": "string",
            "description": "дата тарификации от",
            "format": "date-time"
          },
          "to": {
            "type": "string",
            "description": "дата тарификации до",
            "format": "date-time"
          },
          "date": {
            "type": "string",
            "description": "дата операции",
            "format": "date-time"
          },
          "userId": {
            "type": "integer",
            "description": "идентификатор пользователя фулфилмента, который добавил операцию",
            "format": "int64"
          }
        },
        "description": "Строки с результатом поиска"
      },
      "FindResponseBilling": {
        "type": "object",
        "properties": {
          "rows": {
            "type": "array",
            "description": "Строки с результатом поиска",
            "items": {
              "$ref": "#/components/schemas/Billing"
            }
          },
          "total": {
            "type": "integer",
            "description": "Общее количество найденных записей. Возвращается только, когда count = true",
            "format": "int32"
          },
          "page": {
            "type": "integer",
            "description": "Номер запрошенной страницы",
            "format": "int32"
          },
          "hasNextPage": {
            "type": "boolean",
            "description": "Есть ли следующая страница"
          },
          "emptyPurchase": {
            "type": "integer",
            "description": "Показатель пустой закупочной цены",
            "format": "int64"
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    }
  }
}