CreateRevenueReportsExportTaskCSV

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

Request

Path Parameters

org_guid uuidrequired

Header Parameters

X-LP-Client-Identifier stringrequired

ClientIdentifier

Example: 66131659-904d-431d-9414-b2cfa980a617

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

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

Body

attributes_for_export

object

include_outlet_name boolean

include_outlet_name

include_employee_name boolean

include_employee_name

include_period_column boolean

include_period_column

include_start_column boolean

include_start_column

include_end_column boolean

include_end_column

include_selection_points_column boolean

include_selection_points_column

include_comparison_period_column boolean

include_comparison_period_column

include_revenue_column boolean

include_revenue_column

include_average_column boolean

include_average_column

include_refunds_column boolean

include_refunds_column

include_payments_column boolean

include_payments_column

include_number_of_payments_column boolean

include_number_of_payments_column

include_number_of_refunds_column boolean

include_number_of_refunds_column

include_number_of_transactions_column boolean

include_number_of_transactions_column

include_median_payments_column boolean

include_median_payments_column

filters_for_export

object

processed_at_from date-timenullable

processed_at_from

processed_at_to date-timenullable

processed_at_to

comparison_processed_at_from date-timenullable

comparison_processed_at_from

comparison_processed_at_to date-timenullable

comparison_processed_at_to

revenueByPeriodsType RevenueByPeriodsType (string)required

Possible values: [Year, Quarter, Month, Week, Day, Hour]

outlet_guid uuidnullable

outlet_guid

outlet_guids uuid[]nullable

outlet_guids

employee_guid uuidnullable

employee_guid

employee_guids uuid[]nullable

employee_guids

Body

attributes_for_export

object

include_outlet_name boolean

include_outlet_name

include_employee_name boolean

include_employee_name

include_period_column boolean

include_period_column

include_start_column boolean

include_start_column

include_end_column boolean

include_end_column

include_selection_points_column boolean

include_selection_points_column

include_comparison_period_column boolean

include_comparison_period_column

include_revenue_column boolean

include_revenue_column

include_average_column boolean

include_average_column

include_refunds_column boolean

include_refunds_column

include_payments_column boolean

include_payments_column

include_number_of_payments_column boolean

include_number_of_payments_column

include_number_of_refunds_column boolean

include_number_of_refunds_column

include_number_of_transactions_column boolean

include_number_of_transactions_column

include_median_payments_column boolean

include_median_payments_column

filters_for_export

object

processed_at_from date-timenullable

processed_at_from

processed_at_to date-timenullable

processed_at_to

comparison_processed_at_from date-timenullable

comparison_processed_at_from

comparison_processed_at_to date-timenullable

comparison_processed_at_to

revenueByPeriodsType RevenueByPeriodsType (string)required

Possible values: [Year, Quarter, Month, Week, Day, Hour]

outlet_guid uuidnullable

outlet_guid

outlet_guids uuid[]nullable

outlet_guids

employee_guid uuidnullable

employee_guid

employee_guids uuid[]nullable

employee_guids

Body

attributes_for_export

object

include_outlet_name boolean

include_outlet_name

include_employee_name boolean

include_employee_name

include_period_column boolean

include_period_column

include_start_column boolean

include_start_column

include_end_column boolean

include_end_column

include_selection_points_column boolean

include_selection_points_column

include_comparison_period_column boolean

include_comparison_period_column

include_revenue_column boolean

include_revenue_column

include_average_column boolean

include_average_column

include_refunds_column boolean

include_refunds_column

include_payments_column boolean

include_payments_column

include_number_of_payments_column boolean

include_number_of_payments_column

include_number_of_refunds_column boolean

include_number_of_refunds_column

include_number_of_transactions_column boolean

include_number_of_transactions_column

include_median_payments_column boolean

include_median_payments_column

filters_for_export

object

processed_at_from date-timenullable

processed_at_from

processed_at_to date-timenullable

processed_at_to

comparison_processed_at_from date-timenullable

comparison_processed_at_from

comparison_processed_at_to date-timenullable

comparison_processed_at_to

revenueByPeriodsType RevenueByPeriodsType (string)required

Possible values: [Year, Quarter, Month, Week, Day, Hour]

outlet_guid uuidnullable

outlet_guid

outlet_guids uuid[]nullable

outlet_guids

employee_guid uuidnullable

employee_guid

employee_guids uuid[]nullable

employee_guids

Body

attributes_for_export

object

include_outlet_name boolean

include_outlet_name

include_employee_name boolean

include_employee_name

include_period_column boolean

include_period_column

include_start_column boolean

include_start_column

include_end_column boolean

include_end_column

include_selection_points_column boolean

include_selection_points_column

include_comparison_period_column boolean

include_comparison_period_column

include_revenue_column boolean

include_revenue_column

include_average_column boolean

include_average_column

include_refunds_column boolean

include_refunds_column

include_payments_column boolean

include_payments_column

include_number_of_payments_column boolean

include_number_of_payments_column

include_number_of_refunds_column boolean

include_number_of_refunds_column

include_number_of_transactions_column boolean

include_number_of_transactions_column

include_median_payments_column boolean

include_median_payments_column

filters_for_export

object

processed_at_from date-timenullable

processed_at_from

processed_at_to date-timenullable

processed_at_to

comparison_processed_at_from date-timenullable

comparison_processed_at_from

comparison_processed_at_to date-timenullable

comparison_processed_at_to

revenueByPeriodsType RevenueByPeriodsType (string)required

Possible values: [Year, Quarter, Month, Week, Day, Hour]

outlet_guid uuidnullable

outlet_guid

outlet_guids uuid[]nullable

outlet_guids

employee_guid uuidnullable

employee_guid

employee_guids uuid[]nullable

employee_guids

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

include_outlet_name boolean

include_outlet_name

include_employee_name boolean

include_employee_name

include_period_column boolean

include_period_column

include_start_column boolean

include_start_column

include_end_column boolean

include_end_column

include_selection_points_column boolean

include_selection_points_column

include_comparison_period_column boolean

include_comparison_period_column

include_revenue_column boolean

include_revenue_column

include_average_column boolean

include_average_column

include_refunds_column boolean

include_refunds_column

include_payments_column boolean

include_payments_column

include_number_of_payments_column boolean

include_number_of_payments_column

include_number_of_refunds_column boolean

include_number_of_refunds_column

include_number_of_transactions_column boolean

include_number_of_transactions_column

include_median_payments_column boolean

include_median_payments_column

filters_for_export

object

processed_at_from date-timenullable

processed_at_from

processed_at_to date-timenullable

processed_at_to

comparison_processed_at_from date-timenullable

comparison_processed_at_from

comparison_processed_at_to date-timenullable

comparison_processed_at_to

revenueByPeriodsType RevenueByPeriodsType (string)required

Possible values: [Year, Quarter, Month, Week, Day, Hour]

outlet_guid uuidnullable

outlet_guid

outlet_guids uuid[]nullable

outlet_guids

employee_guid uuidnullable

employee_guid

employee_guids uuid[]nullable

employee_guids

status AsyncTaskStatuses (string)

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

progress int32

progress

resolutions

object[]

nullable

resolutions

Array [

message stringnullable

message

type ResolutionTypes (string)

Possible values: [Information, Warning, Error]

]

organization

object

guid uuid

guid

type_of string

type_of

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

{
  "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": "2024-11-18T08:30:48.429Z",
      "processed_at_to": "2024-11-18T08:30:48.429Z",
      "comparison_processed_at_from": "2024-11-18T08:30:48.429Z",
      "comparison_processed_at_to": "2024-11-18T08:30:48.429Z",
      "revenueByPeriodsType": "Year",
      "outlet_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "outlet_guids": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "employee_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "employee_guids": [
        "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": "2024-11-18T08:30:48.429Z",
  "updated_at": "2024-11-18T08:30:48.429Z",
  "deleted_at": "2024-11-18T08:30:48.429Z",
  "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]

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"
}

CreateRevenueReportsExportTaskCSV

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

Request​

Path Parameters

Header Parameters

Body

Body

Body

Body

Responses​

Request

Responses