Добавляет новую асинхронную задачу на экспорт выручки по периодам по выручке в CSV.

POST /v5/orgs/:org_guid/async/exports/revenueperiods:new.csv

Request

Path Parameters

org_guid uuidrequired

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

Header Parameters

Accept-Language stringrequired

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

Example: ru-RU

X-LP-Client-Identifier stringrequired

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

Example: 96cebbb1-1e77-4938-ae5e-29fcfc27606d

X-LP-Client-Type stringrequired

Possible values: [Unknown, App, WebApp, Service, Android]

Тип клиента

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

Поддерживаемые клиентом расширения моделей

application/json-patch+json
application/json
text/json
application/*+json

Body

Параметры экспорта

attributes_for_export

object

filters_for_export

object

Body

Параметры экспорта

attributes_for_export

object

filters_for_export

object

Body

Параметры экспорта

attributes_for_export

object

filters_for_export

object

Body

Параметры экспорта

attributes_for_export

object

filters_for_export

object

Responses

Success

application/json

Schema
Example (from schema)

Schema

mime_type stringnullable

mime_type

report_export_type ReportExportType (string)required

Possible values: [RevenueByPeriodsExcel, RevenueByOutletsPeriodsExcel, RevenueByEmploeesPeriodsExcel, RevenueByPeriodsCSV, RevenueByOutletsPeriodsCSV, RevenueByEmploeesPeriodsCSV, ReportTransactionExcel, ReportTransactionCSV, ReportFiscalDocumentExcel, ReportFiscalDocumentCSV, ReportMoneyOperationExcel, ReportMoneyOperationCSV, ReportPaymentAndRefundExcel, ReportPaymentAndRefundCSV, ReportCombinedExcel, ReportCombinedCSV, ReportNomenclatureResultExcel, ReportNomenclatureResultCSV]

Перечисление типов выгружаемых отчетов с выручками

parameters

object

Параметры экспорта отчета по выручке

attributes_for_export

object

filters_for_export

object

status AsyncTaskStatuses (string)

Possible values: [InQueue, InProgress, WaitingForFeedback, Completed, Canceled]

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

progress int32

Прогресс

resolutions

object[]

nullable

organization

object

created_at date-time

Дата создания

updated_at date-time

Дата последнего обновления

deleted_at date-timenullable

Дата удаления (архивации)

meta stringnullable

Possible values: <= 128 characters

Метаданные объекта (нарпимер, идентификатор в сторонней системе)

meta_data

object

nullable

guid uuid

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

type_of stringnullable

Тип объекта

{
  "mime_type": "string",
  "report_export_type": "RevenueByPeriodsExcel",
  "parameters": {
    "attributes_for_export": {
      "include_outlet_name": true,
      "include_employee_name": true,
      "include_period_column": true,
      "include_start_column": true,
      "include_end_column": true,
      "include_selection_points_column": true,
      "include_comparison_period_column": true,
      "include_revenue_column": true,
      "include_average_column": true,
      "include_refunds_column": true,
      "include_payments_column": true,
      "include_number_of_payments_column": true,
      "include_number_of_refunds_column": true,
      "include_number_of_transactions_column": true,
      "include_median_payments_column": true
    },
    "filters_for_export": {
      "processed_at_from": "2025-07-07T15:36:39.568Z",
      "processed_at_to": "2025-07-07T15:36:39.568Z",
      "comparison_processed_at_from": "2025-07-07T15:36:39.568Z",
      "comparison_processed_at_to": "2025-07-07T15:36:39.568Z",
      "revenueByPeriodsType": "Year",
      "outlet_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "employee_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  },
  "status": "InQueue",
  "progress": 0,
  "resolutions": [
    {
      "message": "string",
      "type": "Information"
    }
  ],
  "organization": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "created_at": "2025-07-07T15:36:39.568Z",
  "updated_at": "2025-07-07T15:36:39.568Z",
  "deleted_at": "2025-07-07T15:36:39.568Z",
  "meta": "string",
  "meta_data": {},
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "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]

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

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

Forbidden

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

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

Not Found

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

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

Client Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

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

Too Many Requests

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

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

Server Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

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

CURL

curl -L -X POST 'https://docs.life-pay.ru/v5/orgs/:org_guid/async/exports/revenueperiods:new.csv' \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
-H 'Authorization: Bearer <TOKEN>'

Auth

BearerAuth

Bearer Token

Parameters

org_guid — pathrequired

Accept-Language — headerrequired

X-LP-Client-Identifier — headerrequired

X-LP-Client-Type — headerrequired

X-LP-Client-Name — header

X-LP-Client-OS-Name — header

X-LP-Client-OS-Version — header

X-LP-Client-Screen-Resolution — header

X-LP-Client-Model — header

X-LP-Organization-Alias — header

X-LP-Client-Extensions — header

Body

Content-Type

{
  "attributes_for_export": {
    "include_outlet_name": true,
    "include_employee_name": true,
    "include_period_column": true,
    "include_start_column": true,
    "include_end_column": true,
    "include_selection_points_column": true,
    "include_comparison_period_column": true,
    "include_revenue_column": true,
    "include_average_column": true,
    "include_refunds_column": true,
    "include_payments_column": true,
    "include_number_of_payments_column": true,
    "include_number_of_refunds_column": true,
    "include_number_of_transactions_column": true,
    "include_median_payments_column": true
  },
  "filters_for_export": {
    "processed_at_from": "2025-07-07T15:36:37.077Z",
    "processed_at_to": "2025-07-07T15:36:37.077Z",
    "comparison_processed_at_from": "2025-07-07T15:36:37.077Z",
    "comparison_processed_at_to": "2025-07-07T15:36:37.077Z",
    "revenueByPeriodsType": "Year",
    "outlet_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "employee_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Добавляет новую асинхронную задачу на экспорт выручки по периодам по выручке в CSV.

/v5/orgs/:org_guid/async/exports/revenueperiods:new.csv

Request​

Path Parameters

Header Parameters

Body

Body

Body

Body

Responses​

Request

Responses