---
title: "Retrieve a report"
method: GET
path: "/api/v2/host/reports/{reportRunId}"
tags: ["host"]
---

# Retrieve a report

`GET /api/v2/host/reports/{reportRunId}`

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

## Path parameters

- `reportRunId` number, required

## Response `200`

- ApiV2HostGetReportRunResponseDto
  - `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
  - `data` union, required
    - ApiV2HostReportRunTotalSalesReportRunDataDto
      - `items` union[], required
        - union
          - ApiV2HostReportRunEventSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'event', required
            - `eventType` 'private' | 'special-event' | 'special-event-new' | 'retreat' | 'fitness' | 'course' | 'course-class' | 'semester' | 'recital', required
            - `eventIsSemesterClass` boolean, required
            - `details` object, required
          - ApiV2HostReportRunMembershipSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'membership' | 'pack' | 'subscription', required
            - `membershipType` 'subscription' | 'on-demand-subscription' | 'package-events' | 'package-money' | 'patron', required
            - `details` object, required
          - ApiV2HostReportRunCourseSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'course', required
            - `details` object, required
          - ApiV2HostReportRunVideoSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'on-demand', required
            - `details` object, required
          - ApiV2HostReportRunProductSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'product', required
            - `details` object, required
          - ApiV2HostReportRunAutomatedPenaltyChargeDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'automatic-penalty-charge', required
            - `details` object, required
          - ApiV2HostReportRunAppointmentSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'appointment', required
            - `details` object, required
          - ApiV2HostReportRunAppointmentAddonSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'appointment', required
            - `details` object, required
            - `isAddonItem` number, required
          - ApiV2HostReportRunAppointmentDepositSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'appointment', required
            - `details` object, required
            - `isDepositItem` number, required
          - ApiV2HostReportRunGiftCardSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'gift-card', required
            - `details` object, required
          - ApiV2HostReportRunPaymentPlanInstallmentSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'payment-plan-installment', required
            - `details` object, required
          - ApiV2HostReportRunTipTotalSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'tip', required
          - ApiV2HostReportRunTuitionInstallmentSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'tuition-installment', required
            - `details` object, required
          - ApiV2HostReportRunTuitionRegistrationFeeSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'tuition-registration-fee', required
            - `details` object, required
          - ApiV2HostReportRunMembershipRenewalRetryFeeSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'membership-renewal-retry-fee', required
            - `details` object, required
          - ApiV2HostReportRunMembershipFreezeFeeSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'membership-freeze-fee', required
            - `details` object, required
          - ApiV2HostReportRunMembershipCancellationFeeSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'membership-cancellation-fee', required
            - `details` object, required
          - ApiV2HostReportRunRefundSaleItemDto
            - `memberId` integer, nullable, required
            - `customerName` string, required
            - `customerEmail` string, required
            - `payingCustomerEmail` string, required
            - `payingCustomerName` string, required
            - `payingMemberId` integer, required
            - `saleItemId` integer, nullable, required
            - `paymentDate` string, date-time, required
            - `serviceDate` string, date-time, nullable, required
            - `paymentValue` number, nullable, required
            - `paidInMoneyCredits` number, nullable, required
            - `paymentVat` number, nullable, required
            - `paymentItem` string, required
            - `paymentMethod` string, required
            - `paymentStatus` 'succeeded' | 'failed' | 'pending' | 'voided' | 'unpaid' | 'incomplete', nullable, required
            - `paymentTransactionId` integer, nullable, required
            - `refunded` number, required
            - `stripeToken` string, nullable, required
            - `currency` string, nullable, required
            - `customerSelectedLocation` string
            - `soldBy` string
            - `transactionItems` TransactionItemDto[], required
              - …
            - `location` string, nullable
            - `saleReference` string, nullable
            - `paymentCategory` 'refund', required
            - `details` object, required
      - `reportType` 'total-sales', required
    - ApiV2HostReportRunFranchiseGiftCardReconciliationReportRunDataDto
      - `items` FranchiseGiftCardReconciliationItemDto[], required
        - `hostName` string, required
        - `totals` TotalsDto, required
          - `amountReceivable` number, required
          - `amountPayable` number, required
          - `balance` number, required
        - `paymentTransactionItems` PaymentTransactionItemDto[], required
          - `id` integer, required
          - `createdAt` string, date-time, required
          - `isAmountReceivable` boolean, required
          - `transactionHostName` string, required
          - `giftCardPurchaseHostName` string, required
          - `giftCardPurchaseHostId` integer, required
          - `giftCardCode` string, required
          - `paidInCurrency` number, required
      - `reportType` 'franchise-gift-card-reconciliation', required
  - `id` integer, required
  - `status` 'queued' | 'running' | 'completed' | 'failed', 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/revisions/5e27e54ff467/schema)