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

# Initiate report generation

`POST /api/v2/host/reports`

## Request

- Base URL: `https://api.momence.com`
- URL: `https://api.momence.com/api/v2/host/reports`
- Auth: OAuth 2
  - Authorization code: `/api/v2/auth/authorize`
  - Password
  - Token URL: `/api/v2/auth/token`

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
    - ApiV2HostReportRunPayrollReportRunParametersDto
      - `reportType` 'payroll', required
      - `hostId` integer, required
      - `dateRange` DateRangeDto, required
        - `from` string, date-time, required
        - `to` string, date-time, required
      - `teacherId` integer
      - `locationId` integer
      - `memberHomeLocationId` integer
      - `includeVatInRevenue` boolean

## Response `200`

- ApiV2HostCreateReportRunResponseDto
  - `id` integer, required

## Changes

- **2026-11-03** `5adb9a85439b`: 3 info
  - added the new `imported-sale` enum value to the request property `parameters/oneOf[#/components/schemas/ApiV2HostReportRunTotalSalesReportRunParametersDto]/saleTypes/items/`
  - added the new `reward-points` enum value to the request property `parameters/oneOf[#/components/schemas/ApiV2HostReportRunTotalSalesReportRunParametersDto]/saleTypes/items/`
  - added `#/components/schemas/ApiV2HostReportRunPayrollReportRunParametersDto` to the `parameters` request property `oneOf` list

[Operation history](https://skmtc.dev/momence/apis/momence-public/changes/api/v2/host/reports/post.md)

---

[API](https://skmtc.dev/momence/apis/momence-public.md) - [All operations](https://skmtc.dev/momence/apis/momence-public/llms.txt) - [OpenAPI document](https://skmtc.dev/momence/apis/momence-public/revisions/5adb9a85439b?raw)
