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

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: d71bef6d-98d4-4b5b-9969-a3529f8440d3
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

200

Success

application/json

Schema

Schema

outlet

object

required

Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

типа

guid uuid

Глобальный уникальный идентификатор объекта

type_of stringnullable

Тип объекта

opened_by

object

required

Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

типа

guid uuid

Глобальный уникальный идентификатор объекта

type_of stringnullable

Тип объекта

workplace

object

Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

типа

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]

Коды валют (ISO 4217)

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

Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

типа

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]

Коды валют (ISO 4217)

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]

Коды стран ISO 3166-1 alpha-3 / ISO 3166-1 numeric

total_sum

object

required

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

good_codes

object

Значения реквизитов, входящих в состав реквизита код товара (тег 1163) при фискализации в формате ФФД 1.2.

unknown stringnullable

Possible values: <= 32 characters

Нераспознанный код товара Опциональный. Тэг ФФД: 1300. Обязательность по ФЗ-54: Опциональный. Длина: n ≤ 32

ean8 stringnullable

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

Код EAN-8 Опциональный. Тэг ФФД: 1301. Обязательность по ФЗ-54: Опциональный. Длина: n = 8

ean13 stringnullable

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

Код EAN-13 Опциональный. Тэг ФФД: 1302. Обязательность по ФЗ-54: Опциональный. Длина: n = 13

itf14 stringnullable

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

Код ITF-14 Опциональный. Тэг ФФД: 1303. Обязательность по ФЗ-54: Опциональный. Длина: n = 14

gs1 stringnullable

Possible values: <= 38 characters

Код GS1.0 Опциональный. Тэг ФФД: 1304. Обязательность по ФЗ-54: Опциональный. Длина: n ≤ 38

gs1m stringnullable

Possible values: <= 38 characters

Код GS1.M Опциональный. Тэг ФФД: 1305. Обязательность по ФЗ-54: Опциональный. Длина: n ≤ 38

kmk stringnullable

Possible values: <= 38 characters

Код КМК Опциональный. Тэг ФФД: 1306. Обязательность по ФЗ-54: Опциональный. Длина: n ≤ 38

mi stringnullable

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

Код МИ Опциональный. Тэг ФФД: 1307. Обязательность по ФЗ-54: Опциональный. Длина: n = 20

egais2 stringnullable

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

Код ЕГАИС-2.0 Опциональный. Тэг ФФД: 1308. Обязательность по ФЗ-54: Опциональный. Длина: n = 33

egais3 stringnullable

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

Код ЕГАИС-3.0 Опциональный. Тэг ФФД: 1309. Обязательность по ФЗ-54: Опциональный. Длина: n = 14

f1 stringnullable

Possible values: <= 32 characters

Код Ф1 Опциональный. Тэг ФФД: 1320. Обязательность по ФЗ-54: Опциональный. Длина: n ≤ 32

f2 stringnullable

Possible values: <= 32 characters

Код Ф2 Опциональный. Тэг ФФД: 1321. Обязательность по ФЗ-54: Опциональный. Длина: n ≤ 32

f3 stringnullable

Possible values: <= 32 characters

Код Ф3 Опциональный. Тэг ФФД: 1322. Обязательность по ФЗ-54: Опциональный. Длина: n ≤ 32

f4 stringnullable

Possible values: <= 32 characters

Код Ф4 Опциональный. Тэг ФФД: 1323. Обязательность по ФЗ-54: Опциональный. Длина: n ≤ 32

f5 stringnullable

Possible values: <= 32 characters

Код Ф5 Опциональный. Тэг ФФД: 1324. Обязательность по ФЗ-54: Опциональный. Длина: n ≤ 32

f6 stringnullable

Possible values: <= 32 characters

Код Ф6 Опциональный. Тэг ФФД: 1325. Обязательность по ФЗ-54: Опциональный. Длина: n ≤ 32

marking_attributes

object

Перечисление возможных атрибутов маркированных товаров.

marking_code stringnullable

Possible values: <= 256 characters

Код маркировки; Длина: n ≤ 256 байта

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

Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

типа

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]

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

allowed_min_sale_price

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

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]

Коды стран ISO 3166-1 alpha-3 / ISO 3166-1 numeric

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

Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

типа

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

Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

типа

guid uuid

Глобальный уникальный идентификатор объекта

type_of stringnullable

Тип объекта

extensions

SaleExtensions

Расширения

retail_app

object

Расширение LIFE POS Retail для сделки

deal_permissions

object[]

nullable

Разрешения для сделки

Array [

role

object

required

Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

типа

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

Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

типа

guid uuid

Глобальный уникальный идентификатор объекта

type_of stringnullable

Тип объекта

role

object

required

Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

типа

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]

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

allowed_min_sale_price

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

]

version stringrequired

Possible values: non-empty and <= 8 characters

Версия расширения

payment_methods

object

Расширение в котором хранится информация о том какие способы оплаты из поддерживаемых системой LIFE POS для

каких ролей сотрудников должны быть доступны при оплате конкретной сделки продажи

availabilities

object[]

nullable

Настройки доступности способов оплаты

Array [

role

object

required

Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

типа

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

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

]

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

Тип объекта

Example (from schema)

{
  "outlet": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "opened_by": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "workplace": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "opened_at": "2024-11-18T08:30:52.226Z",
  "number": "string",
  "comment": "string",
  "status": "Opened",
  "total_sum": {
    "value": 0,
    "currency": "RUB",
    "type_of": "string"
  },
  "positions": [
    {
      "settlement_subject": "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"
      },
      "good_codes": {
        "unknown": "string",
        "ean8": "string",
        "ean13": "string",
        "itf14": "string",
        "gs1": "string",
        "gs1m": "string",
        "kmk": "string",
        "mi": "string",
        "egais2": "string",
        "egais3": "string",
        "f1": "string",
        "f2": "string",
        "f3": "string",
        "f4": "string",
        "f5": "string",
        "f6": "string"
      },
      "marking_attributes": {
        "marking_code": "string",
        "is_part_of_package_of": 0,
        "checking_result": [
          "KMChecked"
        ],
        "mark_scanning_was_skipped": true
      },
      "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"
        ],
        "declaration_number": "string",
        "excise_fee": 0
      },
      "markable_as": "NotMarkable",
      "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"
        }
      ],
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type_of": "string"
    }
  ],
  "customer_data": {
    "name": "string",
    "inn": "string",
    "contacts": "string",
    "citizenship": "AFG",
    "identity_document_type": "RFPassport",
    "identity_document_data": "string",
    "date_of_birth": "2024-11-18T08:30:52.227Z",
    "address": "string"
  },
  "additional_attributes": {
    "settlement_location": "string",
    "printable_header": [
      "string"
    ],
    "printable_footer": [
      "string"
    ]
  },
  "permissions": [
    {
      "role": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "can_edit_comment": true,
      "can_edit_customer_name": true,
      "can_edit_customer_contacts": true,
      "can_edit_customer_inn": true,
      "can_add_free_position": true,
      "can_add_offer_position": true,
      "can_delete": true,
      "can_cancel": true,
      "can_refund": true,
      "type_of": "string"
    }
  ],
  "organization": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "extensions": {
    "retail_app": {
      "deal_permissions": [
        {
          "role": {
            "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "type_of": "string"
          },
          "can_edit_comment": false,
          "can_edit_customer_name": false,
          "can_edit_customer_contacts": false,
          "can_edit_customer_inn": false,
          "can_add_offer_position": false,
          "can_add_free_position": false,
          "can_delete": false,
          "can_refund": false,
          "can_cancel": false
        }
      ],
      "deal_position_permissions": [
        {
          "position": {
            "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "type_of": "string"
          },
          "role": {
            "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "type_of": "string"
          },
          "can_edit_name": false,
          "can_edit_good_type": false,
          "can_edit_uom": false,
          "can_edit_quantity": false,
          "can_edit_tax": false,
          "can_edit_sale_price": false,
          "can_delete": false,
          "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"
          }
        }
      ],
      "version": "string"
    },
    "payment_methods": {
      "availabilities": [
        {
          "role": {
            "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "type_of": "string"
          },
          "cash_payments_available": true,
          "cashless_payments_available": true,
          "card_payments_available": true,
          "split_payments_available": true,
          "quick_payments_available": true,
          "bnpl_payments_available": true
        }
      ],
      "version": "string"
    },
    "payment_recipients": {
      "payment_recipient_inn": "string",
      "agent_inn": "string",
      "version": "string"
    },
    "discounts": {
      "deal_position_discounts": [
        {
          "deal_position_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "sale_price_discount": {
            "type": "Absolute",
            "amount": 0
          },
          "original_sale_price_value": 0
        }
      ],
      "sale_discount_percentage": 0,
      "version": "string"
    }
  },
  "created_at": "2024-11-18T08:30:52.228Z",
  "updated_at": "2024-11-18T08:30:52.228Z",
  "deleted_at": "2024-11-18T08:30:52.228Z",
  "meta": "string",
  "meta_data": {},
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type_of": "string"
}

401

Unauthorized

application/json

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]

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

Example (from schema)

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

403

Forbidden

application/json

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]

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

Example (from schema)

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

404

Not Found

application/json

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]

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

Example (from schema)

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

422

Client Error

application/json

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]

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

Example (from schema)

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

429

Too Many Requests

application/json

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]

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

Example (from schema)

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

500

Server Error

application/json

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]

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

Example (from schema)

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

Loading...