ListSale

GET 
/orgs/:org_guid/deals/sales

ListSale

Request

Path Parameters

org_guid uuidrequired

Query Parameters

created_from date-time
created_to date-time
updated_from date-time
updated_to date-time
page_token string
presentation PresentationModes

Possible values: [compact, full]

order_by DealOrderings

Possible values: [created_at_asc, created_at_desc, updated_at_asc, updated_at_desc, opened_at_asc, opened_at_desc, number_asc, number_desc]

query string

Possible values: non-empty and <= 64 characters

Поиск производится по полям: number, comment, custom_properties, deal_permissions, meta, metadata

selection SelectionModes

Possible values: [alive_only, archived_only, all]

opened_at_from date-time
opened_at_to date-time
total_sum_from int64
total_sum_to int64
states DealStates[]

Possible values: [New, InProgress, Completed, Cancelled]

payment_statuses DealPaymentStatus[]

Possible values: [NotPaid, Paid, PartiallyPaid, Refunded, PartiallyRefunded]

shipping_statuses DealShippingStatus[]

Possible values: [NotShipped, Shipped, PartiallyShipped, Returned, PartiallyReturned]

outlet_guid uuid[]
opened_by_guid uuid[]
workplace_guid uuid[]
comment_contains string

Header Parameters

X-LP-Client-Identifier stringrequired
ClientIdentifier
Example: 0d6cd006-7db5-4add-9e5e-3008701013b8
X-LP-Client-Type stringrequired
Possible values: [Unknown, App, WebApp, Service]
ClientType
Example: App
X-LP-Client-Name string
ClientName
Example: Swagger
X-LP-Client-OS-Name string
ClientOSName
Example: SwaggerDoc
X-LP-Client-OS-Version string
ClientOSVersion
Example: 1.0
X-LP-Client-Screen-Resolution string
ClientScreenResolution
Example: 1280x0900
X-LP-Client-Model string
ClientModel
Example: Chrome 75
X-LP-Organization-Alias string

OrganizationAlias

X-LP-Client-Extensions csv

ClientExtensions

Accept-Language stringrequired
Language
Example: en-US

Responses

200

Success

application/json

Schema

Schema

items

object[]

nullable

items

Array [

outlet

object

required

guid uuid

guid

type_of string

type_of

workplace

object

guid uuid

guid

type_of string

type_of

opened_by

object

required

guid uuid

guid

type_of string

type_of

opened_at date-timerequired

opened_at

number stringrequired

Possible values: non-empty and <= 36 characters

number

comment stringnullable

Possible values: <= 512 characters

comment

state DealStates (string)

Possible values: [New, InProgress, Completed, Cancelled]

payment_status DealPaymentStatus (string)

Possible values: [NotPaid, Paid, PartiallyPaid, Refunded, PartiallyRefunded]

shipping_status DealShippingStatus (string)

Possible values: [NotShipped, Shipped, PartiallyShipped, Returned, PartiallyReturned]

total_sum

object

required

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

positions

object[]

nullable

positions

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: non-empty and <= 128 characters

name

uom

object

required

guid uuid

guid

type_of string

type_of

tax ValueAddedTaxRates (string)required

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

sale_price

object

required

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

quantity doublerequired

quantity

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

value

currency CurrencyCodes (string)required

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

type_of string

type_of

barcode stringnullable

barcode (*Required when is_markable=true)

is_markable boolean

is_markable

marking_attributes

object

is_part_of_package_of int32nullable

Possible values: >= 2 and <= 99999999

is_part_of_package_of

marks

object[]

required

Possible values: >= 1

marks

Array [

marking_code stringnullable

Possible values: <= 256 characters

marking_code

checking_result FEGoodDataCheckingResult (string)[]nullable

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

checking_result

for_quantity doublerequired

for_quantity

]

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_name

transfer_operator_phones string[]nullable

transfer_operator_phones

transfer_operator_address stringnullable

Possible values: <= 256 characters

transfer_operator_address

transfer_operator_inn stringnullable

transfer_operator_inn

paying_agent_operation stringnullable

Possible values: <= 24 characters

paying_agent_operation

paying_agent_phones string[]nullable

paying_agent_phones

payment_operator_phones string[]nullable

payment_operator_phones

supplier_name stringnullable

Possible values: <= 256 characters

supplier_name

supplier_inn stringnullable

supplier_inn

supplier_phones string[]nullable

supplier_phones

declaration_number stringnullable

Possible values: <= 32 characters

declaration_number

excise_fee int32nullable

excise_fee

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

type_of string

type_of

]

customer_data

object

name stringnullable

Possible values: <= 256 characters

name

inn stringnullable

inn

contacts stringnullable

Possible values: <= 64 characters

contacts

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, RefugeeIdentity, RefugeeOtherDocuments, ForeignTemporaryIdentity]

identity_document_data stringnullable

Possible values: <= 64 characters

identity_document_data

date_of_birth date-timenullable

date_of_birth

address stringnullable

Possible values: <= 256 characters

address

additional_attributes

object

settlement_location stringnullable

Possible values: <= 256 characters

settlement_location

printable_header string[]nullable

printable_header

printable_footer string[]nullable

printable_footer

organization

object

guid uuid

guid

type_of string

type_of

extensions

SaleExtensions

Расширения

retail_app

object

deal_permissions

object[]

nullable

deal_permissions

Array [

role

object

required

guid uuid

guid

type_of string

type_of

can_edit_comment boolean

can_edit_comment

can_edit_customer_name boolean

can_edit_customer_name

can_edit_customer_contacts boolean

can_edit_customer_contacts

can_edit_customer_inn boolean

can_edit_customer_inn

can_add_offer_position boolean

can_add_offer_position

can_add_free_position boolean

can_add_free_position

can_delete boolean

can_delete

can_refund boolean

can_refund

can_cancel boolean

can_cancel

]

deal_position_permissions

object[]

nullable

deal_position_permissions

Array [

position

object

required

guid uuid

guid

type_of string

type_of

role

object

required

guid uuid

guid

type_of string

type_of

can_edit_name boolean

can_edit_name

can_edit_good_type boolean

can_edit_good_type

can_edit_uom boolean

can_edit_uom

can_edit_quantity boolean

can_edit_quantity

can_edit_tax boolean

can_edit_tax

can_edit_sale_price boolean

can_edit_sale_price

can_delete boolean

can_delete

allowed_max_quantity double

Possible values: <= 10000000

allowed_max_quantity

allowed_min_quantity double

Possible values: <= 10000000

allowed_min_quantity

allowed_max_sale_price

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

allowed_min_sale_price

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

]

version stringrequired

Possible values: non-empty and <= 8 characters

version

payment_methods

object

availabilities

object[]

nullable

availabilities

Array [

role

object

required

guid uuid

guid

type_of string

type_of

cash_payments_available boolean

cash_payments_available

cashless_payments_available boolean

cashless_payments_available

card_payments_available boolean

card_payments_available

split_payments_available boolean

split_payments_available

quick_payments_available boolean

quick_payments_available

bnpl_payments_available boolean

bnpl_payments_available

split_payments_available_methods

object

cash_payments_available boolean

cash_payments_available

cashless_payments_available boolean

cashless_payments_available

card_payments_available boolean

card_payments_available

quick_payments_available boolean

quick_payments_available

]

version stringrequired

Possible values: non-empty and <= 8 characters

version

payment_recipients

object

payment_recipient_inn stringrequired

Possible values: non-empty

payment_recipient_inn

agent_inn stringnullable

agent_inn

version stringrequired

Possible values: non-empty and <= 8 characters

version

discounts

object

deal_position_discounts

object[]

nullable

deal_position_discounts

Array [

deal_position_guid uuidrequired

deal_position_guid

sale_price_discount

object

type DiscountAmountType (string)required

Possible values: [Absolute, Percentage]

amount int64required

amount

original_sale_price_value int64required

original_sale_price_value

]

sale_discount_percentage int32nullable

sale_discount_percentage

version stringrequired

Possible values: non-empty and <= 8 characters

version

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

guid uuid

guid

type_of string

type_of

]

next_page_token stringnullable

next_page_token

page_number int32

page_number

pages_total int32

pages_total

items_per_page int32

items_per_page

items_total int32

items_total

type_of string

type_of

Example (from schema)

{
  "items": [
    {
      "outlet": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "workplace": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "opened_by": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "opened_at": "2024-11-18T08:30:48.098Z",
      "number": "string",
      "comment": "string",
      "state": "New",
      "payment_status": "NotPaid",
      "shipping_status": "NotShipped",
      "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"
          },
          "barcode": "string",
          "is_markable": true,
          "marking_attributes": {
            "is_part_of_package_of": 0,
            "marks": [
              {
                "marking_code": "string",
                "checking_result": [
                  "KMChecked"
                ],
                "for_quantity": 0
              }
            ]
          },
          "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
          },
          "meta": "string",
          "meta_data": {},
          "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:48.099Z",
        "address": "string"
      },
      "additional_attributes": {
        "settlement_location": "string",
        "printable_header": [
          "string"
        ],
        "printable_footer": [
          "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,
              "split_payments_available_methods": {
                "cash_payments_available": true,
                "cashless_payments_available": true,
                "card_payments_available": true,
                "quick_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:48.099Z",
      "updated_at": "2024-11-18T08:30:48.099Z",
      "deleted_at": "2024-11-18T08:30:48.099Z",
      "meta": "string",
      "meta_data": {},
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type_of": "string"
    }
  ],
  "next_page_token": "string",
  "page_number": 0,
  "pages_total": 0,
  "items_per_page": 0,
  "items_total": 0,
  "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

message

info stringnullable

info

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

message

info stringnullable

info

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

message

info stringnullable

info

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

message

info stringnullable

info

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

message

info stringnullable

info

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

message

info stringnullable

info

Example (from schema)

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

Loading...