---
title: "Initiate report generation"
method: POST
path: "/api/v2/host/reports"
tags: ["host"]
---

# Initiate report generation

`POST /api/v2/host/reports`

Initiates generation of a report. Use "Retrieve a report" endpoint to retrieve the report data once the generation is completed.

**Rate limit:** 100 req / 1 d

## Request body

- ApiV2HostCreateReportRunRequestDto
  - `parameters` union, required
    - ApiV2HostReportRunTotalSalesReportRunParametersDto
      - `reportType` 'total-sales', required
      - `hostId` integer, required
      - `dateRange` DateRangeDto, required
        - `from` string, date-time, required
        - `to` string, date-time, required
      - `locationId` integer
      - `tagId` integer
      - `moneyCreditSalesFilter` 'noFilter' | 'filterOutMoneyCreditSales' | 'filterOutSalesPaidByMoneyCredits'
      - `includeRefunds` boolean
      - `saleTypes` string[]
      - `excludeGiftCardPaymentMethod` boolean
      - `excludeTransactionFeesInSaleValue` boolean
    - ApiV2HostReportRunFranchiseGiftCardReconciliationReportRunParametersDto
      - `reportType` 'franchise-gift-card-reconciliation', required
      - `hostId` integer, required
      - `dateRange` DateRangeDto, required
        - `from` string, date-time, required
        - `to` string, date-time, required

## Response `200`

- ApiV2HostCreateReportRunResponseDto
  - `id` integer, required

---

[API](https://skmtc.net/momence/apis/momence-public.md) · [All operations](https://skmtc.net/momence/apis/momence-public/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/momence/momence-public/versions/5e27e54ff467/schema)