Получить данные фискального документа 'Кассовый чек'

GET 
/v5/orgs/:org_guid/fiscal-registrars/:registrar_guid/docs/receipts/:doc_guid

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

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

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

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

Request

Path Parameters

org_guid uuidrequired

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

registrar_guid anyrequired

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

doc_guid uuidrequired

Уникальный идентификатор фискального документа

Query Parameters

presentation PresentationModes

Possible values: [compact, full]

Header Parameters

Accept-Language stringrequired
Язык используемый для ответов
Example: ru-RU
X-LP-Client-Identifier stringrequired
Идентификатор клиента
Example: ab8a79f4-39c9-45d1-8477-db4672676a22
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

fiscal_form FiscalDocumentForms (string)required

Possible values: [RegistrationReport, ShiftOpeningReport, Receipt, StrictForm, ShiftClosingReport, FiscalDriveClosingReport, OperatorConfirmation, ReRegistrationReport, SettlementReport, ReceiptOfCorrection, StrictFormOfCorrection]

fiscal_drive_number stringrequired

Possible values: <= 16 characters, Value must match regular expression ^\d+$

number int32required
cashier_name stringnullable

Possible values: <= 64 characters

issued_at date-timerequired

fiscal_registrar

object

guid uuid

type_of stringnullable

sources

object

fiscal_document_name stringnullable

fiscal_document_form V5FEFiscalForms (string)

Possible values: [RegistrationReport, ShiftOpeningReport, Receipt, StrictForm, ShiftClosingReport, FiscalDriveClosingReport, OperatorConfirmation, ReRegistrationReport, SettlementReport, ReceiptOfCorrection, StrictFormOfCorrection]

customer_data

object

customer_name stringnullable

Possible values: <= 256 characters

customer_inn stringnullable

Possible values: <= 12 characters

customer_date_of_birth date-timenullable

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_code V5FEIdentityDocumentTypeCodes (string)

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

identity_document_data stringnullable

Possible values: <= 64 characters

customer_address stringnullable

Possible values: <= 256 characters

receipt_number int32

shift_number int32

operation_type V5FEOperationTypes (string)

Possible values: [Inflow, InflowRefund, Outflow, OutflowRefund]

tax_system TaxSystems (string)

Possible values: [Osn, Usn, UsnMinus, Envd, Esn, Patent]

machine_number stringnullable

Possible values: <= 20 characters

customer_contacts stringnullable

Possible values: <= 64 characters

positions

object[]

nullable

Array [

method V5FESettlementMethods (string)

Possible values: [Prepayment, PartialPrepayment, AdvancePayment, FullPayment, PartialPaymentAndCredit, Credit, CreditPayment]

subject V5FESettlementSubjectTypes (string)

Possible values: [Product, ExcisableProduct, Work, Service, GamblingBet, GamblingWin, LotteryBet, LotteryWin, IntellectualProperty, Payment, AgentCommission, Payout, Other, PropertyRights, NonRealizationIncome, OtherPayments, TradeFee, ResortFee, Bail, Outflow, ContributionForOPSIP, ContributionForOPS, ContributionForOMSIP, ContributionForOMS, ContributionForOOS, CasinoPayment, Cashout, ATNM, ATM, TNM, TM]

code bytenullabledeprecated

as_agent_type_of V5FEAgentTypes (string)

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

agent_data

object

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

type_of stringnullable

supplier_data

object

supplier_phones string[]nullable

supplier_name stringnullable

Possible values: <= 256 characters

type_of stringnullable

supplier_inn stringnullable

Possible values: >= 10 characters and <= 12 characters

name stringnullable

Possible values: <= 128 characters

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

declaration_number stringnullable

Possible values: <= 32 characters

price_per_unit int64

vat_per_unit int64nullable

quantity double

excise_fee int64nullable

vat_rate V5FEValueAddedTaxCodes (string)

Possible values: [Vat1102, Vat1103, Vat1104, Vat1105, Vat1106, Vat1107]

total_vat int64nullable

total_price int64nullable

additional_attribute stringnullable

Possible values: <= 64 characters

measure_of_quantity V5FEMeasuresOfQuantity (string)

Possible values: [Piece, Gram, Kilogram, Ton, Centimeter, Decimeter, Meter, SquareCentimeter, SquareDecimeter, SquareMeter, Milliliter, Liter, CubicMeter, KilowattHour, Gigacalorie, Day, Hour, Minute, Second, Kilobyte, Megabyte, Gigabyte, Terabyte, Other]

good_code

object

unknown stringnullable

Possible values: <= 32 characters

ean8 stringnullable

Possible values: <= 8 characters

ean13 stringnullable

Possible values: <= 13 characters

itf14 stringnullable

Possible values: <= 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

egais2 stringnullable

Possible values: <= 33 characters

egais3 stringnullable

Possible values: <= 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

control_code stringnullable

Possible values: <= 4 characters

code_processing_mode booleannullable

good_data_checking_result V5FEGoodDataCheckingResult (string)[]nullable

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

fractional_count_of_marked_position

object

numerator int64

denominator int64

industry_attributes

object[]

nullable

Array [

foiv V5FEFOIV (string)

Possible values: [InternalAffairsMinistry, EmergencySituationsMinistry, ForeignAffairsMinistry, CommonwealthOfIndependentStatesFA, DefenseMinistry, MilitaryTechnicalCooperationFS, TechnicalAndExportControlFS, JusticeMinistry, PenitentiaryFS, BailiffsFS, StateCourierFS, IntelligenceFS, FederalSecurityFS, NationalGuardFS, ProtectiveFS, FinancialMonitoringFS, ArchivalFA, SpecialPresidentProgramsDirectorate, PresidentDirectorate, HealthMinistry, HealthcareSurveillanceFS, CultureMinistry, ScienceandHigherEducationMinistry, NaturalResourcesAndEnvironmentMinistry, HydrometeorologyAndEnvironmentalMonitoringFS, NaturalResourcesSurveillanceFS, WaterResourcesFA, ForestryFA, MineralResourcesFA, IndustryAndTradeMinistry, TechnicalRegulationAndMetrologyFA, EducationMinistry, DevelopmentOfFarEastAndArcticMinistry, AgricultureMinistry, VeterinaryAndPhytosanitarySupervisionFS, FisheryFa, SportMinistry, ConstructionHousingAndUtilitiesMinistry, TransportMinistry, SupervisionOfTransportFS, AirTransportFA, RoadFA, RailTransportFA, MaritimeAndRiverTransportFA, LaborAndSocialProtectionMinistry, LaborAndEmploymentFS, FinanceMinistry, TaxationFS, AssayFS, AlcoholMarketRegulationFS, CustomsFS, TreasuryFS, StatePropertyManagementFA, DigitalDevelopmentCommunicationsAndMassMediaMinistry, SupervisionOfCommunicationsItAndMassMediaFS, PressAndMassMediaFA, CommunicationFA, EconomicDevelopmentMinistry, AccreditationFS, StateStatisticsFS, IntellectualPropertyFS, TourismFA, EnergyMinistry, AntimonopolyFS, StateRegistrationCadastreAndCartographyFS, ConsumerRightsProtectionAndHumanWellbeingFS, SupervisionInEducationAndScienceFS, EnvironmentalTechnologicalAndNuclearSupervisionFS, StateReservesFA, MedicalBiologicalFA, YouthFA, EthnicaffairsFA]

basis_document_date date-timenullable

basis_document_number stringnullable

Possible values: <= 32 characters

attribute_value stringnullable

Possible values: <= 256 characters

]

type_of stringnullable

]

total_sum int64nullable

sum_by_cash int64

sum_by_card int64

sum_by_prepayment int64

sum_by_postpayment int64

sum_by_considerations int64

sum_of_vat_1102 int64nullable

sum_of_vat_1103 int64nullable

sum_of_vat_1104 int64nullable

sum_of_vat_1105 int64nullable

sum_of_vat_1106 int64nullable

sum_of_vat_1107 int64nullable

used_for_internet_only booleannullable

receipt_sender_email stringnullable

Possible values: <= 64 characters

results_of_checking_marked_positions booleannullable

federal_tax_service_url stringnullable

Possible values: <= 256 characters

operational_receipt_attributes

object[]

nullable

Array [

operation_date date-timenullable

operation_id int32nullable

operation_data stringnullable

Possible values: <= 64 characters

]

additional_receipt_attribute stringnullable

Possible values: <= 16 characters

additional_user_attribute

object

additional_attribute_name stringnullable

Possible values: <= 64 characters

additional_attribute_value stringnullable

Possible values: <= 256 characters

type_of stringnullable

industry_receipt_attributes

object[]

nullable

Array [

foiv V5FEFOIV (string)

Possible values: [InternalAffairsMinistry, EmergencySituationsMinistry, ForeignAffairsMinistry, CommonwealthOfIndependentStatesFA, DefenseMinistry, MilitaryTechnicalCooperationFS, TechnicalAndExportControlFS, JusticeMinistry, PenitentiaryFS, BailiffsFS, StateCourierFS, IntelligenceFS, FederalSecurityFS, NationalGuardFS, ProtectiveFS, FinancialMonitoringFS, ArchivalFA, SpecialPresidentProgramsDirectorate, PresidentDirectorate, HealthMinistry, HealthcareSurveillanceFS, CultureMinistry, ScienceandHigherEducationMinistry, NaturalResourcesAndEnvironmentMinistry, HydrometeorologyAndEnvironmentalMonitoringFS, NaturalResourcesSurveillanceFS, WaterResourcesFA, ForestryFA, MineralResourcesFA, IndustryAndTradeMinistry, TechnicalRegulationAndMetrologyFA, EducationMinistry, DevelopmentOfFarEastAndArcticMinistry, AgricultureMinistry, VeterinaryAndPhytosanitarySupervisionFS, FisheryFa, SportMinistry, ConstructionHousingAndUtilitiesMinistry, TransportMinistry, SupervisionOfTransportFS, AirTransportFA, RoadFA, RailTransportFA, MaritimeAndRiverTransportFA, LaborAndSocialProtectionMinistry, LaborAndEmploymentFS, FinanceMinistry, TaxationFS, AssayFS, AlcoholMarketRegulationFS, CustomsFS, TreasuryFS, StatePropertyManagementFA, DigitalDevelopmentCommunicationsAndMassMediaMinistry, SupervisionOfCommunicationsItAndMassMediaFS, PressAndMassMediaFA, CommunicationFA, EconomicDevelopmentMinistry, AccreditationFS, StateStatisticsFS, IntellectualPropertyFS, TourismFA, EnergyMinistry, AntimonopolyFS, StateRegistrationCadastreAndCartographyFS, ConsumerRightsProtectionAndHumanWellbeingFS, SupervisionInEducationAndScienceFS, EnvironmentalTechnologicalAndNuclearSupervisionFS, StateReservesFA, MedicalBiologicalFA, YouthFA, EthnicaffairsFA]

basis_document_date date-timenullable

basis_document_number stringnullable

Possible values: <= 32 characters

attribute_value stringnullable

Possible values: <= 256 characters

]

qr_code stringnullable

print_view stringnullable

Possible values: <= 32768 characters

fiscal_document_format V5FEFiscalFormats (string)

Possible values: [Version1, Version2, Version3, Version4]

organization_name stringnullable

Possible values: <= 256 characters

organization_inn stringnullable

Possible values: <= 12 characters

issued_at date-time

fiscal_registrar_registration_number stringnullable

Possible values: <= 20 characters

fiscal_registrar_serial_number stringnullable

cashier_name stringnullable

Possible values: <= 64 characters

cashier_inn stringnullable

Possible values: <= 12 characters

settlement_address stringnullable

Possible values: <= 256 characters

settlement_location stringnullable

Possible values: <= 256 characters

fiscal_document_number int32

fiscal_drive_number stringnullable

Possible values: <= 16 characters

fiscal_sign int64nullable

additional_attributes

object[]

nullable

Array [

name stringnullable

Possible values: <= 128 characters

value stringnullable

Possible values: <= 1024 characters

]

type_of stringnullable
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)

{
  "fiscal_form": "RegistrationReport",
  "fiscal_drive_number": "string",
  "number": 0,
  "cashier_name": "string",
  "issued_at": "2024-08-06T11:29:09.605Z",
  "fiscal_registrar": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "sources": {
    "fiscal_document_name": "string",
    "fiscal_document_form": "RegistrationReport",
    "customer_data": {
      "customer_name": "string",
      "customer_inn": "string",
      "customer_date_of_birth": "2024-08-06T11:29:09.606Z",
      "citizenship": "AFG",
      "identity_document_type_code": "RFPassport",
      "identity_document_data": "string",
      "customer_address": "string"
    },
    "receipt_number": 0,
    "shift_number": 0,
    "operation_type": "Inflow",
    "tax_system": "Osn",
    "machine_number": "string",
    "customer_contacts": "string",
    "positions": [
      {
        "method": "Prepayment",
        "subject": "Product",
        "as_agent_type_of": "BankPayingAgent",
        "agent_data": {
          "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"
          ],
          "type_of": "string"
        },
        "supplier_data": {
          "supplier_phones": [
            "string"
          ],
          "supplier_name": "string",
          "type_of": "string"
        },
        "supplier_inn": "string",
        "name": "string",
        "country": "AFG",
        "declaration_number": "string",
        "price_per_unit": 0,
        "vat_per_unit": 0,
        "quantity": 0,
        "excise_fee": 0,
        "vat_rate": "Vat1102",
        "total_vat": 0,
        "total_price": 0,
        "additional_attribute": "string",
        "measure_of_quantity": "Piece",
        "good_code": {
          "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"
        },
        "control_code": "string",
        "code_processing_mode": true,
        "good_data_checking_result": [
          "KMChecked"
        ],
        "fractional_count_of_marked_position": {
          "numerator": 0,
          "denominator": 0
        },
        "industry_attributes": [
          {
            "foiv": "InternalAffairsMinistry",
            "basis_document_date": "2024-08-06T11:29:09.608Z",
            "basis_document_number": "string",
            "attribute_value": "string"
          }
        ],
        "type_of": "string"
      }
    ],
    "total_sum": 0,
    "sum_by_cash": 0,
    "sum_by_card": 0,
    "sum_by_prepayment": 0,
    "sum_by_postpayment": 0,
    "sum_by_considerations": 0,
    "sum_of_vat_1102": 0,
    "sum_of_vat_1103": 0,
    "sum_of_vat_1104": 0,
    "sum_of_vat_1105": 0,
    "sum_of_vat_1106": 0,
    "sum_of_vat_1107": 0,
    "used_for_internet_only": true,
    "receipt_sender_email": "string",
    "results_of_checking_marked_positions": true,
    "federal_tax_service_url": "string",
    "operational_receipt_attributes": [
      {
        "operation_date": "2024-08-06T11:29:09.608Z",
        "operation_id": 0,
        "operation_data": "string"
      }
    ],
    "additional_receipt_attribute": "string",
    "additional_user_attribute": {
      "additional_attribute_name": "string",
      "additional_attribute_value": "string",
      "type_of": "string"
    },
    "industry_receipt_attributes": [
      {
        "foiv": "InternalAffairsMinistry",
        "basis_document_date": "2024-08-06T11:29:09.608Z",
        "basis_document_number": "string",
        "attribute_value": "string"
      }
    ],
    "qr_code": "string",
    "print_view": "string",
    "fiscal_document_format": "Version1",
    "organization_name": "string",
    "organization_inn": "string",
    "issued_at": "2024-08-06T11:29:09.608Z",
    "fiscal_registrar_registration_number": "string",
    "fiscal_registrar_serial_number": "string",
    "cashier_name": "string",
    "cashier_inn": "string",
    "settlement_address": "string",
    "settlement_location": "string",
    "fiscal_document_number": 0,
    "fiscal_drive_number": "string",
    "fiscal_sign": 0,
    "additional_attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "type_of": "string"
  },
  "created_at": "2024-08-06T11:29:09.609Z",
  "updated_at": "2024-08-06T11:29:09.609Z",
  "deleted_at": "2024-08-06T11:29:09.609Z",
  "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]

message stringnullable
info stringnullable

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]

message stringnullable
info stringnullable

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]

message stringnullable
info stringnullable

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]

message stringnullable
info stringnullable

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]

message stringnullable
info stringnullable

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]

message stringnullable
info stringnullable

Example (from schema)

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

Loading...