Skip to main content

Получить данные сделки продажи

GET 

/v5/orgs/:org_guid/deals/sales/:deal_guid

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

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

Важная информация!

Если указанный объект удален (помещен в архив) данный метод всё равно вернет данные по нему.

Request

Path Parameters

    org_guid uuidrequired

    Уникальный идентификатор организации

    deal_guid uuidrequired

    Уникальный идентификатор сделки продажи

Query Parameters

    presentation PresentationModes

    Possible values: [compact, full]

Header Parameters

    Accept-Language stringrequired

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

    Example: ru-RU
    X-LP-Client-Identifier stringrequired

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

    Example: 131fb310-487f-4fc0-8719-75e503602688
    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

Schema

    outlet

    object

    required

    guid uuid
    type_of stringnullable

    opened_by

    object

    required

    guid uuid
    type_of stringnullable

    workplace

    object

    guid uuid
    type_of stringnullable
    opened_at date-timerequired
    number stringrequired

    Possible values: <= 36 characters

    comment stringnullable

    Possible values: <= 512 characters

    status DealStatuses (string)required

    Possible values: [Opened, Reserved, Paid, Shipped, Delivered, Returned, PartlyReturned, Closed, Canceled]

    total_sum

    object

    required

    value int64
    currency CurrencyCodes (string)required

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

    type_of stringnullable

    positions

    object[]

    nullable

  • Array [

  • settlement_subject SettlementSubjects (string)required

    Possible values: [Product, ExciseProduct, Work, Service, GamblingBet, GamblingWinning, LotteryBet, LotteryWinning, IntellectualProperty, Payment, AgentFee, Payout, Other, PropertyRights, NonRealizationIncome, OtherPayments, TradeFee, ResortFee, Bail, Outflow, ContributionForOPSIP, ContributionForOPS, ContributionForOMSIP, ContributionForOMS, ContributionForOSS, CasinoPayment, Cashout, ATNM, ATM, TNM, TM]

    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

    good_codes

    object

    unknown stringnullable

    Possible values: <= 32 characters

    ean8 stringnullable

    Possible values: >= 8 characters and <= 8 characters

    ean13 stringnullable

    Possible values: >= 13 characters and <= 13 characters

    itf14 stringnullable

    Possible values: >= 14 characters and <= 14 characters

    gs1 stringnullable

    Possible values: <= 38 characters

    gs1m stringnullable

    Possible values: <= 38 characters

    kmk stringnullable

    Possible values: <= 38 characters

    mi stringnullable

    Possible values: >= 20 characters and <= 20 characters

    egais2 stringnullable

    Possible values: >= 33 characters and <= 33 characters

    egais3 stringnullable

    Possible values: >= 14 characters and <= 14 characters

    f1 stringnullable

    Possible values: <= 32 characters

    f2 stringnullable

    Possible values: <= 32 characters

    f3 stringnullable

    Possible values: <= 32 characters

    f4 stringnullable

    Possible values: <= 32 characters

    f5 stringnullable

    Possible values: <= 32 characters

    f6 stringnullable

    Possible values: <= 32 characters

    marking_attributes

    object

    marking_code stringnullable

    Possible values: <= 256 characters

    is_part_of_package_of int32nullable

    Possible values: >= 2 and <= 99999999

    checking_result V5FEGoodDataCheckingResult (string)[]nullable

    Possible values: [KMChecked, KPKMCorrect, OISMStatusChecked, OISMStatusCorrect, KPKMCheckedAutonomously]

    mark_scanning_was_skipped boolean

    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
    declaration_number stringnullable

    Possible values: <= 32 characters

    excise_fee int32nullable
    markable_as MarkTypes (string)

    Possible values: [NotMarkable, Tobacco, Medicines, Shoes, Tires, FurCoats, PhotoCamerasAndFlashLamps, LightIndustryGoods, PerfumeAndToiletWater, DairyProducts, Wheelchairs, Bicycles, PackagedWater, BeerAndBeerDrinks, Other]

    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
  • ]

  • guid uuid
    type_of stringnullable
  • ]

  • customer_data

    object

    name stringnullable

    Possible values: <= 256 characters

    inn stringnullable

    Possible values: <= 12 characters

    contacts stringnullable

    Possible values: <= 64 characters

    citizenship 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]

    identity_document_type IdentityDocumentTypes (string)

    Possible values: [RFPassport, RFSpecialPassport, RFTemporaryIdentity, RFBirthCertificate, RFOtherDocuments, ForeignPassport, ForeignOtherDocuments, ForeignIdentity, ForeignResidence, ForeignTemporaryResidence, RefugeeApplication]

    identity_document_data stringnullable

    Possible values: <= 64 characters

    date_of_birth date-timenullable
    address stringnullable

    Possible values: <= 256 characters

    additional_attributes

    object

    settlement_location stringnullable

    Possible values: <= 256 characters

    printable_header string[]nullable
    printable_footer string[]nullable

    permissions

    object[]

    nullable

  • Array [

  • role

    object

    required

    guid uuid
    type_of stringnullable
    can_edit_comment boolean
    can_edit_customer_name boolean
    can_edit_customer_contacts boolean
    can_edit_customer_inn boolean
    can_add_free_position boolean
    can_add_offer_position boolean
    can_delete boolean
    can_cancel boolean
    can_refund boolean
    type_of stringnullable
  • ]

  • organization

    object

    guid uuid
    type_of stringnullable

    extensions

    SaleExtensions

    Расширения

    retail_app

    object

    deal_permissions

    object[]

    nullable

  • Array [

  • role

    object

    required

    guid uuid
    type_of stringnullable
    can_edit_comment boolean
    can_edit_customer_name boolean
    can_edit_customer_contacts boolean
    can_edit_customer_inn boolean
    can_add_offer_position boolean
    can_add_free_position boolean
    can_delete boolean
    can_refund boolean
    can_cancel boolean
  • ]

  • deal_position_permissions

    object[]

    nullable

  • Array [

  • position

    object

    required

    guid uuid
    type_of stringnullable

    role

    object

    required

    guid uuid
    type_of stringnullable
    can_edit_name boolean
    can_edit_good_type boolean
    can_edit_uom boolean
    can_edit_quantity boolean
    can_edit_tax boolean
    can_edit_sale_price boolean
    can_delete boolean
    allowed_max_quantity double

    Possible values: <= 10000000

    allowed_min_quantity double

    Possible values: <= 10000000

    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
  • ]

  • version stringrequired

    Possible values: non-empty and <= 8 characters

    payment_methods

    object

    availabilities

    object[]

    nullable

  • Array [

  • role

    object

    required

    guid uuid
    type_of stringnullable
    cash_payments_available boolean
    cashless_payments_available boolean
    card_payments_available boolean
    split_payments_available boolean
    quick_payments_available boolean
    bnpl_payments_available boolean
  • ]

  • version stringrequired

    Possible values: non-empty and <= 8 characters

    payment_recipients

    object

    payment_recipient_inn stringrequired
    agent_inn stringnullable
    version stringrequired

    Possible values: non-empty and <= 8 characters

    discounts

    object

    deal_position_discounts

    object[]

    nullable

  • Array [

  • deal_position_guid uuidrequired

    sale_price_discount

    object

    type DiscountAmountType (string)required

    Possible values: [Absolute, Percentage]

    amount int64required
    original_sale_price_value int64required
  • ]

  • sale_discount_percentage int32nullable
    version stringrequired

    Possible values: non-empty and <= 8 characters

    created_at date-time
    updated_at date-time
    deleted_at date-timenullable
    meta stringnullable

    Possible values: <= 128 characters

    meta_data

    object

    nullable

    property name* string
    guid uuid
    type_of stringnullable
Loading...