Отчет по продажам

GET /v5/orgs/:org_guid/reports/operation/money

Коды возможных ошибок:

[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [401]: "Unauthorized" - для выполнения операции требуется авторизация [403]: "NoPermissions" - нет прав на выполнение этой операции [404]: "NotFound" - запрашиваемый объект или его родительский объект не найдены [422]: "RequestIsNotValid" - параметры запроса не прошли валидацию

Request

Path Parameters

org_guid uuidrequired

GUID организации

Query Parameters

date_from date-time

Starting date

date_to date-time

End date

page_token string

presentation PresentationModes

Possible values: [compact, full]

Header Parameters

Accept-Language stringrequired

Язык используемый для ответов

Example: ru-RU

X-LP-Client-Identifier stringrequired

Идентификатор клиента

Example: 5096d5e5-ed46-4c0e-a56a-30674b6091c2

X-LP-Client-Type stringrequired

Possible values: [Unknown, App, WebApp, Service]

Тип клиента

Example: App

X-LP-Client-Name string

Имя клиента

Example: Swagger

X-LP-Client-OS-Name string

ОС клиента

Example: SwaggerDoc

X-LP-Client-OS-Version string

Версия ОС клиента

Example: 1.0

X-LP-Client-Screen-Resolution string

Разрешение экрана ОС клиента

Example: 1280x0900

X-LP-Client-Model string

Модель оборудования клиента

Example: Chrome 75

X-LP-Organization-Alias string

Организация по умолчанию

X-LP-Client-Extensions csv

Поддерживаемые клиентом расширения моделей

Responses

Success

application/json

Schema
Example (from schema)

Schema

items

object[]

nullable

Array [

legal_entity

object

guid uuid

type_of stringnullable

outlet

object

guid uuid

type_of stringnullable

brand

object

guid uuid

type_of stringnullable

workplace

object

guid uuid

type_of stringnullable

employee

object

guid uuid

type_of stringnullable

customer_name stringnullable

customer_contacts stringnullable

deal_number stringnullable

sale_action_type stringnullable

opened_at date-timenullable

operation_status stringnullable

shipment_status stringnullable

sale_status stringnullable

deal_comment stringnullable

positions

object[]

nullable

Array [

good_type GoodTypes (string)required

Possible values: [Product, ExciseProduct, Work, Service, GamblingBet, GamblingWinning, LotteryBet, LotteryWinning, IntellectualProperty, Payment, AgentFee, Composite, Other, PropertyRights, NonRealizationIncome, InsuranceFee, TradeFee, ResortFee]

name stringrequired

Possible values: <= 128 characters

uom

object

required

guid uuid

type_of stringnullable

tax ValueAddedTaxRates (string)required

Possible values: [Tax20, Tax10, Tax0, TaxFree]

sale_price

object

required

value int64

currency CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

type_of stringnullable

quantity doublerequired

made_in CountryCodes (string)

Possible values: [AFG, ALB, ATA, DZA, ASM, AND, AGO, ATG, AZE, ARG, AUS, AUT, BHS, BHR, BGD, ARM, BRB, BEL, BMU, BTN, BOL, BIH, BWA, BVT, BRA, BLZ, IOT, SLB, VGB, BRN, BGR, MMR, BDI, BLR, KHM, CMR, CAN, CPV, CYM, CAF, LKA, TCD, CHL, CHN, TWN, CXR, CCK, COL, COM, MYT, COG, COD, COK, CRI, HRV, CUB, CYP, CZE, BEN, DNK, DMA, DOM, ECU, SLV, GNQ, ETH, ERI, EST, FRO, FLK, SGS, FJI, FIN, ALA, FRA, GUF, PYF, ATF, DJI, GAB, GEO, GMB, PSE, DEU, GHA, GIB, KIR, GRC, GRL, GRD, GLP, GUM, GTM, GIN, GUY, HTI, HMD, VAT, HND, HKG, HUN, ISL, IND, IDN, IRN, IRQ, IRL, ISR, ITA, CIV, JAM, JPN, KAZ, JOR, KEN, PRK, KOR, KWT, KGZ, LAO, LBN, LSO, LVA, LBR, LBY, LIE, LTU, LUX, MAC, MDG, MWI, MYS, MDV, MLI, MLT, MTQ, MRT, MUS, MEX, MCO, MNG, MDA, MNE, MSR, MAR, MOZ, OMN, NAM, NRU, NPL, NLD, CUW, ABW, SXM, BES, NCL, VUT, NZL, NIC, NER, NGA, NIU, NFK, NOR, MNP, UMI, FSM, MHL, PLW, PAK, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, GNB, TLS, PRI, QAT, REU, ROU, RUS, RWA, BLM, SHN, KNA, AIA, LCA, MAF, SPM, VCT, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SVK, VNM, SVN, SOM, ZAF, ZWE, ESP, SSD, SDN, ESH, SUR, SJM, SWZ, SWE, CHE, SYR, TJK, THA, TGO, TKL, TON, TTO, ARE, TUN, TUR, TKM, TCA, TUV, UGA, UKR, MKD, EGY, GBR, GGY, JEY, IMN, TZA, USA, VIR, BFA, URY, UZB, VEN, WLF, WSM, YEM, ZMB]

total_sum

object

required

value int64

currency CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

type_of stringnullable

additional_attributes

object

as_agent_type_of FEAgentTypes (string)

Possible values: [BankPayingAgent, BankPayingSubagent, PayingAgent, PayingSubagent, Attorney, Consignee, Agent]

transfer_operator_name stringnullable

Possible values: <= 64 characters

transfer_operator_phones string[]nullable

transfer_operator_address stringnullable

Possible values: <= 256 characters

transfer_operator_inn stringnullable

Possible values: <= 12 characters

paying_agent_operation stringnullable

Possible values: <= 24 characters

paying_agent_phones string[]nullable

payment_operator_phones string[]nullable

supplier_name stringnullable

Possible values: <= 256 characters

supplier_inn stringnullable

Possible values: <= 12 characters

supplier_phones string[]nullable

code bytenullable

mark stringnullable

Possible values: <= 1024 characters

declaration_number stringnullable

Possible values: <= 32 characters

excise_fee int32nullable

meta stringnullable

meta_data

object

nullable

property name* stringnullable

permissions

object[]

nullable

Array [

role

object

required

guid uuid

type_of stringnullable

can_edit_name boolean

can_edit_good_type boolean

can_edit_uom boolean

can_edit_tax boolean

can_edit_quantity boolean

can_edit_sale_price boolean

can_delete boolean

allowed_max_quantity doublenullable

allowed_min_quantity doublenullable

allowed_max_sale_price

object

value int64

currency CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

type_of stringnullable

allowed_min_sale_price

object

value int64

currency CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

type_of stringnullable

]

type_of stringnullable

]

goods_amount int64nullable

position_discount int64nullable

type_of stringnullable

]

next_page_token stringnullable

page_number int32

pages_total int32

items_per_page int32

items_total int32

type_of stringnullable

{
  "items": [
    {
      "legal_entity": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "outlet": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "brand": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "workplace": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "employee": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "customer_name": "string",
      "customer_contacts": "string",
      "deal_number": "string",
      "sale_action_type": "string",
      "opened_at": "2024-08-06T11:29:10.680Z",
      "operation_status": "string",
      "shipment_status": "string",
      "sale_status": "string",
      "deal_comment": "string",
      "positions": [
        {
          "good_type": "Product",
          "name": "string",
          "uom": {
            "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "type_of": "string"
          },
          "tax": "Tax20",
          "sale_price": {
            "value": 0,
            "currency": "RUB",
            "type_of": "string"
          },
          "quantity": 0,
          "made_in": "AFG",
          "total_sum": {
            "value": 0,
            "currency": "RUB",
            "type_of": "string"
          },
          "additional_attributes": {
            "as_agent_type_of": "BankPayingAgent",
            "transfer_operator_name": "string",
            "transfer_operator_phones": [
              "string"
            ],
            "transfer_operator_address": "string",
            "transfer_operator_inn": "string",
            "paying_agent_operation": "string",
            "paying_agent_phones": [
              "string"
            ],
            "payment_operator_phones": [
              "string"
            ],
            "supplier_name": "string",
            "supplier_inn": "string",
            "supplier_phones": [
              "string"
            ],
            "code": "string",
            "mark": "string",
            "declaration_number": "string",
            "excise_fee": 0
          },
          "meta": "string",
          "meta_data": {},
          "permissions": [
            {
              "role": {
                "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type_of": "string"
              },
              "can_edit_name": true,
              "can_edit_good_type": true,
              "can_edit_uom": true,
              "can_edit_tax": true,
              "can_edit_quantity": true,
              "can_edit_sale_price": true,
              "can_delete": true,
              "allowed_max_quantity": 0,
              "allowed_min_quantity": 0,
              "allowed_max_sale_price": {
                "value": 0,
                "currency": "RUB",
                "type_of": "string"
              },
              "allowed_min_sale_price": {
                "value": 0,
                "currency": "RUB",
                "type_of": "string"
              },
              "type_of": "string"
            }
          ],
          "type_of": "string"
        }
      ],
      "goods_amount": 0,
      "position_discount": 0,
      "type_of": "string"
    }
  ],
  "next_page_token": "string",
  "page_number": 0,
  "pages_total": 0,
  "items_per_page": 0,
  "items_total": 0,
  "type_of": "string"
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

info stringnullable

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Forbidden

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Not Found

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Client Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Too Many Requests

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Server Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Отчет по продажам

/v5/orgs/:org_guid/reports/operation/money

Коды возможных ошибок:​

Request​

Path Parameters

Query Parameters

Header Parameters

Responses​

Коды возможных ошибок:

Request

Responses