GetReportReportPaymentAndRefundItem

GET /orgs/:org_guid/reports/operation/paymentrefund

Request

Path Parameters

org_guid uuidrequired

Query Parameters

date_from date-time

date_to date-time

page_token string

presentation PresentationModes

Possible values: [compact, full]

Header Parameters

X-LP-Client-Identifier stringrequired

ClientIdentifier

Example: b22e0e43-ec26-4977-b4de-972ea8b4881c

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

Success

application/json

Schema
Example (from schema)

Schema

items

object[]

nullable

items

Array [

legal_entity

object

guid uuid

guid

type_of string

type_of

outlet

object

guid uuid

guid

type_of string

type_of

workplace

object

guid uuid

guid

type_of string

type_of

employee

object

guid uuid

guid

type_of string

type_of

customer_name stringnullable

customer_name

customer_contacts stringnullable

customer_contacts

deal_number stringnullable

deal_number

processed_at date-timenullable

processed_at

opened_at date-timenullable

opened_at

operation_status stringnullable

operation_status

shipment_status stringnullable

shipment_status

sale_status stringnullable

sale_status

sale_action_type stringnullable

sale_action_type

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

]

total_sum int64

total_sum

cash_part_amount int64nullable

cash_part_amount

card_part_amount int64nullable

card_part_amount

sbp_part_amount int64nullable

sbp_part_amount

other_part_amount int64nullable

other_part_amount

fiscalization_flag boolean

fiscalization_flag

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

{
  "items": [
    {
      "legal_entity": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "outlet": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "workplace": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "employee": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "customer_name": "string",
      "customer_contacts": "string",
      "deal_number": "string",
      "processed_at": "2024-11-18T08:30:46.475Z",
      "opened_at": "2024-11-18T08:30:46.476Z",
      "operation_status": "string",
      "shipment_status": "string",
      "sale_status": "string",
      "sale_action_type": "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"
        }
      ],
      "total_sum": 0,
      "cash_part_amount": 0,
      "card_part_amount": 0,
      "sbp_part_amount": 0,
      "other_part_amount": 0,
      "fiscalization_flag": true,
      "type_of": "string"
    }
  ],
  "next_page_token": "string",
  "page_number": 0,
  "pages_total": 0,
  "items_per_page": 0,
  "items_total": 0,
  "type_of": "string"
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

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

message stringnullable

message

info stringnullable

info

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

Forbidden

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

Not Found

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

Client Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

Too Many Requests

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

Server Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

GetReportReportPaymentAndRefundItem

/orgs/:org_guid/reports/operation/paymentrefund

Request​

Path Parameters

Query Parameters

Header Parameters

Responses​

Request

Responses