Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

Add support for exporting payouts (#3993)

Steven Tey7ba397a47a32
diff --git a/apps/web/app/(ee)/api/cron/export/payouts/fetch-payouts-batch.ts b/apps/web/app/(ee)/api/cron/export/payouts/fetch-payouts-batch.ts
new file mode 100644
index 0000000000..bdf4eff6aa
--- /dev/null
+++ b/apps/web/app/(ee)/api/cron/export/payouts/fetch-payouts-batch.ts
@@ -0,0 +1,35 @@
+import { getPayouts, ParsedPayoutsFilters } from "@/lib/api/payouts/get-payouts";
+
+export async function* fetchPayoutsBatch(
+ {
+ workspaceId,
+ programId,
+ filters,
+ }: {
+ workspaceId: string;
+ programId: string;
+ filters: ParsedPayoutsFilters;
+ },
+ pageSize: number = 1000,
+) {
+ let page = 1;
+ let hasMore = true;
+
+ while (hasMore) {
+ const payouts = await getPayouts({
+ workspaceId,
+ programId,
+ filters,
+ page,
+ pageSize,
+ });
+
+ if (payouts.length > 0) {
+ yield { payouts };
+ page++;
+ hasMore = payouts.length === pageSize;
+ } else {
+ hasMore = false;
+ }
+ }
+}
diff --git a/apps/web/app/(ee)/api/cron/export/payouts/route.ts b/apps/web/app/(ee)/api/cron/export/payouts/route.ts
new file mode 100644
index 0000000000..4493ace234
--- /dev/null
+++ b/apps/web/app/(ee)/api/cron/export/payouts/route.ts
@@ -0,0 +1,107 @@
+import { convertToCSV } from "@/lib/analytics/utils/convert-to-csv";
+import { formatPayoutsForExport } from "@/lib/api/payouts/format-payouts-for-export";
+import { parsePayoutsQuery } from "@/lib/api/payouts/get-payouts";
+import { createDownloadableExport } from "@/lib/api/create-downloadable-export";
+import { generateExportFilename } from "@/lib/api/utils/generate-export-filename";
+import { generateRandomString } from "@/lib/api/utils/generate-random-string";
+import { withCron } from "@/lib/cron/with-cron";
+import { payoutsExportCronInputSchema } from "@/lib/zod/schemas/payouts";
+import { sendEmail } from "@dub/email";
+import ExportReady from "@dub/email/templates/export-ready";
+import { prisma } from "@dub/prisma";
+import { logAndRespond } from "../../utils";
+import { fetchPayoutsBatch } from "./fetch-payouts-batch";
+
+const MAX_PAYOUTS_EXPORT_LIMIT = 100_000;
+
+export const dynamic = "force-dynamic";
+
+// POST /api/cron/export/payouts - QStash worker for processing large payout exports
+export const POST = withCron(async ({ rawBody }) => {
+ const raw = JSON.parse(rawBody);
+ const isHoldStatus = raw.status === "hold";
+ const { status: _status, ...restRaw } = raw;
+
+ const { workspaceId, programId, userId, columns } =
+ payoutsExportCronInputSchema.parse(isHoldStatus ? restRaw : raw);
+
+ const filters = parsePayoutsQuery(raw);
+
+ const user = await prisma.user.findUnique({
+ where: {
+ id: userId,
+ },
+ select: {
+ email: true,
+ },
+ });
+
+ if (!user) {
+ return logAndRespond(`User ${userId} not found.`);
+ }
+
+ if (!user.email) {
+ return logAndRespond(`User ${userId} has no email.`);
+ }
+
+ const program = await prisma.program.findUnique({
+ where: {
+ id: programId,
+ },
+ select: {
+ name: true,
+ },
+ });
+
+ if (!program) {
+ return logAndRespond(`Program ${programId} not found.`);
+ }
+
+ const allRows: Record<string, string | number>[] = [];
+
+ for await (const { payouts } of fetchPayoutsBatch({
+ workspaceId,
+ programId,
+ filters,
+ })) {
+ const formatted = formatPayoutsForExport(payouts, columns);
+ const remaining = MAX_PAYOUTS_EXPORT_LIMIT - allRows.length;
+
+ if (remaining <= 0) {
+ break;
+ }
+
+ allRows.push(...formatted.slice(0, remaining));
+ }
+
+ const csvData = convertToCSV(allRows);
+
+ const { downloadUrl } = await createDownloadableExport({
+ fileKey: `exports/payouts/${generateRandomString(16)}.csv`,
+ fileName: generateExportFilename("payouts"),
+ body: csvData,
+ contentType: "text/csv",
+ });
+
+ await sendEmail({
+ to: user.email,
+ subject: "Your payouts export is ready",
+ react: ExportReady({
+ email: user.email,
+ exportType: "payouts",
+ downloadUrl,
+ program: {
+ name: program.name,
+ },
+ }),
+ });
+
+ const capped =
+ allRows.length >= MAX_PAYOUTS_EXPORT_LIMIT
+ ? ` (capped at ${MAX_PAYOUTS_EXPORT_LIMIT})`
+ : "";
+
+ return logAndRespond(
+ `Export (${allRows.length} payouts${capped}) generated and email sent to user.`,
+ );
+});
diff --git a/apps/web/app/(ee)/api/payouts/export/route.ts b/apps/web/app/(ee)/api/payouts/export/route.ts
new file mode 100644
index 0000000000..bafac49d1f
--- /dev/null
+++ b/apps/web/app/(ee)/api/payouts/export/route.ts
@@ -0,0 +1,66 @@
+import { convertToCSV } from "@/lib/analytics/utils";
+import { formatPayoutsForExport } from "@/lib/api/payouts/format-payouts-for-export";
+import {
+ getPayouts,
+ getPayoutsCount,
+ parsePayoutsQuery,
+} from "@/lib/api/payouts/get-payouts";
+import { getDefaultProgramIdOrThrow } from "@/lib/api/programs/get-default-program-id-or-throw";
+import { withWorkspace } from "@/lib/auth";
+import { qstash } from "@/lib/cron";
+import { payoutsExportQuerySchema } from "@/lib/zod/schemas/payouts";
+import { APP_DOMAIN_WITH_NGROK } from "@dub/utils";
+import { NextResponse } from "next/server";
+
+const MAX_PAYOUTS_TO_EXPORT = 1000;
+
+// GET /api/payouts/export – export payouts to CSV
+export const GET = withWorkspace(async ({ searchParams, workspace, session }) => {
+ const programId = getDefaultProgramIdOrThrow(workspace);
+
+ const isHoldStatus = searchParams.status === "hold";
+ const { status: _status, ...restSearchParams } = searchParams;
+
+ const { columns } = payoutsExportQuerySchema.parse(
+ isHoldStatus ? restSearchParams : searchParams,
+ );
+
+ const filters = parsePayoutsQuery(searchParams);
+
+ const count = await getPayoutsCount({
+ programId,
+ filters,
+ });
+
+ if (count > MAX_PAYOUTS_TO_EXPORT) {
+ await qstash.publishJSON({
+ url: `${APP_DOMAIN_WITH_NGROK}/api/cron/export/payouts`,
+ body: {
+ ...searchParams,
+ columns: columns.join(","),
+ workspaceId: workspace.id,
+ programId,
+ userId: session.user.id,
+ },
+ });
+
+ return NextResponse.json({}, { status: 202 });
+ }
+
+ const payouts = await getPayouts({
+ workspaceId: workspace.id,
+ programId,
+ filters,
+ page: 1,
+ pageSize: MAX_PAYOUTS_TO_EXPORT,
+ });
+
+ const rows = formatPayoutsForExport(payouts, columns);
+
+ return new Response(convertToCSV(rows), {
+ headers: {
+ "Content-Type": "text/csv",
+ "Content-Disposition": "attachment",
+ },
+ });
+});
diff --git a/apps/web/app/(ee)/api/payouts/route.ts b/apps/web/app/(ee)/api/payouts/route.ts
index 4303e76179..2cb0d8ef0c 100644
--- a/apps/web/app/(ee)/api/payouts/route.ts
+++ b/apps/web/app/(ee)/api/payouts/route.ts
@@ -1,14 +1,10 @@
-import { DubApiError } from "@/lib/api/errors";
-import { getEffectivePayoutMode } from "@/lib/api/payouts/get-effective-payout-mode";
+import { getPayouts, parsePayoutsQuery } from "@/lib/api/payouts/get-payouts";
import { getDefaultProgramIdOrThrow } from "@/lib/api/programs/get-default-program-id-or-throw";
-import { getProgramOrThrow } from "@/lib/api/programs/get-program-or-throw";
import { withWorkspace } from "@/lib/auth";
import {
+ PAYOUTS_MAX_PAGE_SIZE,
PayoutResponseSchema,
- payoutsQuerySchema,
} from "@/lib/zod/schemas/payouts";
-import { prisma } from "@dub/prisma";
-import { FraudEventStatus, PayoutStatus } from "@dub/prisma/client";
import { NextResponse } from "next/server";
import * as z from "zod/v4";
@@ -16,101 +12,16 @@ import * as z from "zod/v4";
export const GET = withWorkspace(async ({ workspace, searchParams }) => {
const programId = getDefaultProgramIdOrThrow(workspace);
- const isHoldStatus = searchParams.status === "hold";
- const { status: _status, ...restSearchParams } = searchParams;
+ const filters = parsePayoutsQuery(searchParams);
- let {
- status,
- partnerId,
- tenantId,
- invoiceId,
- sortBy,
- sortOrder,
- page = 1,
- pageSize,
- } = payoutsQuerySchema.parse(isHoldStatus ? restSearchParams : searchParams);
-
- if (isHoldStatus) {
- status = PayoutStatus.pending;
- }
-
- if (tenantId && !partnerId) {
- const programEnrollment = await prisma.programEnrollment.findUnique({
- where: {
- tenantId_programId: {
- tenantId,
- programId,
- },
- },
- select: {
- partnerId: true,
- },
- });
-
- if (!programEnrollment) {
- throw new DubApiError({
- code: "not_found",
- message: `Partner with specified tenantId ${tenantId} not found.`,
- });
- }
-
- partnerId = programEnrollment.partnerId;
- }
-
- const program = await getProgramOrThrow({
+ const transformedPayouts = await getPayouts({
workspaceId: workspace.id,
programId,
+ filters,
+ page: filters.page ?? 1,
+ pageSize: filters.pageSize ?? PAYOUTS_MAX_PAGE_SIZE,
});
- const payouts = await prisma.payout.findMany({
- where: {
- programId,
- ...(status && { status }),
- ...(partnerId && { partnerId }),
- ...(invoiceId && { invoiceId }),
- ...(isHoldStatus && {
- programEnrollment: {
- fraudEventGroups: {
- some: {
- status: FraudEventStatus.pending,
- },
- },
- },
- }),
- },
- include: {
- programEnrollment: true,
- partner: true,
- user: true,
- },
- skip: (page - 1) * pageSize,
- take: pageSize,
- orderBy: {
- [sortBy]: sortOrder,
- },
- });
-
- const transformedPayouts = payouts.map(
- ({ partner, programEnrollment, ...payout }) => {
- const mode =
- payout.mode ??
- getEffectivePayoutMode({
- payoutMode: program.payoutMode,
- payoutsEnabledAt: partner.payoutsEnabledAt,
- });
-
- return {
- ...payout,
- mode,
- traceId: payout.stripePayoutTraceId,
- partner: {
- ...partner,
- tenantId: programEnrollment.tenantId,
- },
- };
- },
- );
-
return NextResponse.json(
z.array(PayoutResponseSchema).parse(transformedPayouts),
);
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/customers/page.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/customers/page.tsx
index 05492f011a..fbb95e6151 100644
--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/customers/page.tsx
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/customers/page.tsx
@@ -1,5 +1,5 @@
+import { CustomersMenuPopover } from "@/ui/customers/customers-menu-popover";
import { CustomersTable } from "@/ui/customers/customers-table/customers-table";
-import { ExportCustomersButton } from "@/ui/customers/export-customers-button";
import { PageContent } from "@/ui/layout/page-content";
import { PageWidthWrapper } from "@/ui/layout/page-width-wrapper";
@@ -12,7 +12,7 @@ export default function CustomersPage() {
"Get deeper, real-time insights about your customers' demographics, purchasing behavior, and lifetime value (LTV).",
href: "https://dub.co/help/article/customer-insights",
}}
- controls={<ExportCustomersButton />}
+ controls={<CustomersMenuPopover />}
>
<PageWidthWrapper>
<CustomersTable />
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/customers/(index)/layout.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/customers/(index)/layout.tsx
index bae6fb3079..b76391e352 100644
--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/customers/(index)/layout.tsx
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/customers/(index)/layout.tsx
@@ -4,7 +4,7 @@ import { SUBMITTED_LEADS_ENABLED_PROGRAM_IDS } from "@/lib/submitted-leads/const
import useCustomersCount from "@/lib/swr/use-customers-count";
import { useProgramSubmittedLeadsCount } from "@/lib/swr/use-program-submitted-leads-count";
import useWorkspace from "@/lib/swr/use-workspace";
-import { ExportCustomersButton } from "@/ui/customers/export-customers-button";
+import { CustomersMenuPopover } from "@/ui/customers/customers-menu-popover";
import { PageContent } from "@/ui/layout/page-content";
import { PageWidthWrapper } from "@/ui/layout/page-width-wrapper";
import { InfoTooltip } from "@dub/ui";
@@ -65,7 +65,7 @@ export default function PartnerCustomersLayout({
"Get deeper, real-time insights about your referred customers' demographics, purchasing behavior, and lifetime value (LTV).",
href: "https://dub.co/help/article/customer-insights",
}}
- controls={<ExportCustomersButton />}
+ controls={<CustomersMenuPopover />}
>
<PageWidthWrapper className="flex flex-col gap-3 pb-10">
{tabs.length > 0 && (
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/page.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/page.tsx
index f9b79d01c3..773cfd4ddd 100644
--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/page.tsx
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/page.tsx
@@ -1,6 +1,7 @@
import { PageContent } from "@/ui/layout/page-content";
import { PageWidthWrapper } from "@/ui/layout/page-width-wrapper";
import { ProgramPayoutsPageClient } from "./page-client";
+import { PayoutsMenuPopover } from "./payouts-menu-popover";
import { ProgramPayoutSettingsButton } from "./program-payout-settings-button";
export default function ProgramPayoutsPage() {
@@ -12,7 +13,12 @@ export default function ProgramPayoutsPage() {
"Learn more about how you can send payouts to your affiliate partners globally with Dub.",
href: "https://dub.co/help/article/partner-payouts",
}}
- controls={<ProgramPayoutSettingsButton />}
+ controls={
+ <>
+ <ProgramPayoutSettingsButton />
+ <PayoutsMenuPopover />
+ </>
+ }
>
<PageWidthWrapper>
<ProgramPayoutsPageClient />
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payouts-menu-popover.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payouts-menu-popover.tsx
new file mode 100644
index 0000000000..e1b8b5fa7f
--- /dev/null
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/payouts/payouts-menu-popover.tsx
@@ -0,0 +1,52 @@
+"use client";
+
+import { useExportPayoutsModal } from "@/ui/modals/export-payouts-modal";
+import { ThreeDots } from "@/ui/shared/icons";
+import { Button, Download, IconMenu, Popover } from "@dub/ui";
+import { useState } from "react";
+
+export function PayoutsMenuPopover() {
+ const [openPopover, setOpenPopover] = useState(false);
+
+ const { ExportPayoutsModal, setShowExportPayoutsModal } =
+ useExportPayoutsModal();
+
+ return (
+ <>
+ <ExportPayoutsModal />
+ <Popover
+ content={
+ <div className="w-full md:w-52">
+ <div className="grid gap-px p-2">
+ <p className="mb-1.5 mt-1 flex items-center gap-2 px-1 text-xs font-medium text-neutral-500">
+ Export Payouts
+ </p>
+ <button
+ onClick={() => {
+ setOpenPopover(false);
+ setShowExportPayoutsModal(true);
+ }}
+ className="w-full rounded-md p-2 hover:bg-neutral-100 active:bg-neutral-200"
+ >
+ <IconMenu
+ text="Export as CSV"
+ icon={<Download className="h-4 w-4" />}
+ />
+ </button>
+ </div>
+ </div>
+ }
+ openPopover={openPopover}
+ setOpenPopover={setOpenPopover}
+ align="end"
+ >
+ <Button
+ onClick={() => setOpenPopover(!openPopover)}
+ variant="secondary"
+ className="h-8 w-auto px-1.5 sm:h-9"
+ icon={<ThreeDots className="h-5 w-5 text-neutral-500" />}
+ />
+ </Popover>
+ </>
+ );
+}
diff --git a/apps/web/lib/api/payouts/format-payouts-for-export.ts b/apps/web/lib/api/payouts/format-payouts-for-export.ts
new file mode 100644
index 0000000000..2e8872fadc
--- /dev/null
+++ b/apps/web/lib/api/payouts/format-payouts-for-export.ts
@@ -0,0 +1,100 @@
+import { formatMoneyCentsForExport } from "@/lib/api/utils/format-money-cents-for-export";
+import { PAYOUT_EXPORT_COLUMNS } from "@/lib/zod/schemas/payouts";
+import * as z from "zod/v4";
+import { getPayouts } from "./get-payouts";
+
+const COLUMN_LOOKUP: Map<
+ string,
+ { label: string; type: string; order: number }
+> = new Map(
+ PAYOUT_EXPORT_COLUMNS.map((column, index) => [
+ column.id,
+ {
+ label: column.label,
+ type: column.type,
+ order: index + 1,
+ },
+ ]),
+);
+
+const COLUMN_TYPE_SCHEMAS = {
+ number: z.coerce
+ .number()
+ .nullable()
+ .default(0)
+ .transform((value) => value || 0),
+ money: z
+ .string()
+ .nullable()
+ .default("")
+ .transform((value) => value || ""),
+ date: z
+ .union([z.date(), z.string()])
+ .nullable()
+ .transform((date) => {
+ if (!date) {
+ return "";
+ }
+
+ return date instanceof Date ? date.toISOString() : date;
+ }),
+ string: z
+ .string()
+ .nullable()
+ .default("")
+ .transform((value) => value || ""),
+};
+
+export function formatPayoutsForExport(
+ payouts: Awaited<ReturnType<typeof getPayouts>>,
+ columns: string[],
+): Record<string, any>[] {
+ const sortedColumns = [...columns].sort(
+ (a, b) =>
+ (COLUMN_LOOKUP.get(a)?.order || 999) -
+ (COLUMN_LOOKUP.get(b)?.order || 999),
+ );
+
+ const formattedPayouts = payouts.map((payout) => {
+ const row: Record<string, unknown> = {
+ id: payout.id,
+ invoiceId: payout.invoiceId,
+ amount: formatMoneyCentsForExport(
+ payout.amount,
+ payout.currency,
+ `payout ${payout.id}`,
+ ),
+ currency: payout.currency,
+ status: payout.status,
+ description: payout.description,
+ periodStart: payout.periodStart,
+ periodEnd: payout.periodEnd,
+ initiatedAt: payout.initiatedAt,
+ paidAt: payout.paidAt,
+ method: payout.method,
+ traceId: payout.traceId,
+ failureReason: payout.failureReason,
+ partnerId: payout.partner.id,
+ partnerName: payout.partner.name,
+ partnerEmail: payout.partner.email,
+ partnerTenantId: payout.partner.tenantId,
+ };
+
+ return row;
+ });
+
+ const columnSchemas: Record<string, z.ZodTypeAny> = {};
+
+ for (const column of sortedColumns) {
+ const columnInfo = COLUMN_LOOKUP.get(column);
+
+ if (!columnInfo) {
+ continue;
+ }
+
+ columnSchemas[column] =
+ COLUMN_TYPE_SCHEMAS[columnInfo.type as keyof typeof COLUMN_TYPE_SCHEMAS];
+ }
+
+ return z.array(z.object(columnSchemas)).parse(formattedPayouts);
+}
diff --git a/apps/web/lib/api/payouts/get-payouts.ts b/apps/web/lib/api/payouts/get-payouts.ts
new file mode 100644
index 0000000000..538aefe7f3
--- /dev/null
+++ b/apps/web/lib/api/payouts/get-payouts.ts
@@ -0,0 +1,224 @@
+import { getEffectivePayoutMode } from "@/lib/api/payouts/get-effective-payout-mode";
+import { DubApiError } from "@/lib/api/errors";
+import { getProgramOrThrow } from "@/lib/api/programs/get-program-or-throw";
+import { payoutsQuerySchema } from "@/lib/zod/schemas/payouts";
+import { prisma } from "@dub/prisma";
+import { FraudEventStatus, PayoutStatus, Prisma } from "@dub/prisma/client";
+import * as z from "zod/v4";
+
+export type PayoutsQueryFilters = z.infer<typeof payoutsQuerySchema>;
+
+export type ParsedPayoutsFilters = PayoutsQueryFilters & {
+ isHoldStatus: boolean;
+};
+
+function pickPayoutQueryParams(
+ searchParams: Record<string, string | undefined>,
+) {
+ const {
+ status,
+ partnerId,
+ tenantId,
+ invoiceId,
+ sortBy,
+ sortOrder,
+ page,
+ pageSize,
+ } = searchParams;
+
+ return {
+ status,
+ partnerId,
+ tenantId,
+ invoiceId,
+ sortBy,
+ sortOrder,
+ page,
+ pageSize,
+ };
+}
+
+export function parsePayoutsQuery(
+ searchParams: Record<string, string | undefined>,
+): ParsedPayoutsFilters {
+ const isHoldStatus = searchParams.status === "hold";
+ const queryParams = pickPayoutQueryParams(searchParams);
+ const { status: _status, ...restQueryParams } = queryParams;
+
+ let filters = payoutsQuerySchema.parse(
+ isHoldStatus ? restQueryParams : queryParams,
+ );
+
+ if (isHoldStatus) {
+ filters = {
+ ...filters,
+ status: PayoutStatus.pending,
+ };
+ }
+
+ return {
+ ...filters,
+ isHoldStatus,
+ };
+}
+
+export function buildPayoutWhere({
+ programId,
+ filters,
+}: {
+ programId: string;
+ filters: Pick<
+ ParsedPayoutsFilters,
+ "status" | "partnerId" | "invoiceId" | "isHoldStatus"
+ >;
+}): Prisma.PayoutWhereInput {
+ const { status, partnerId, invoiceId, isHoldStatus } = filters;
+
+ return {
+ programId,
+ ...(status && { status }),
+ ...(partnerId && { partnerId }),
+ ...(invoiceId && { invoiceId }),
+ ...(isHoldStatus && {
+ programEnrollment: {
+ fraudEventGroups: {
+ some: {
+ status: FraudEventStatus.pending,
+ },
+ },
+ },
+ }),
+ };
+}
+
+async function resolvePartnerId({
+ programId,
+ partnerId,
+ tenantId,
+}: {
+ programId: string;
+ partnerId?: string;
+ tenantId?: string;
+}) {
+ if (!tenantId || partnerId) {
+ return partnerId;
+ }
+
+ const programEnrollment = await prisma.programEnrollment.findUnique({
+ where: {
+ tenantId_programId: {
+ tenantId,
+ programId,
+ },
+ },
+ select: {
+ partnerId: true,
+ },
+ });
+
+ if (!programEnrollment) {
+ throw new DubApiError({
+ code: "not_found",
+ message: `Partner with specified tenantId ${tenantId} not found.`,
+ });
+ }
+
+ return programEnrollment.partnerId;
+}
+
+export async function getPayouts({
+ workspaceId,
+ programId,
+ filters,
+ page,
+ pageSize,
+}: {
+ workspaceId: string;
+ programId: string;
+ filters: ParsedPayoutsFilters;
+ page: number;
+ pageSize: number;
+}) {
+ const { sortBy, sortOrder, isHoldStatus, tenantId, ...rest } = filters;
+
+ const partnerId = await resolvePartnerId({
+ programId,
+ partnerId: rest.partnerId,
+ tenantId,
+ });
+
+ const program = await getProgramOrThrow({
+ workspaceId,
+ programId,
+ });
+
+ const payouts = await prisma.payout.findMany({
+ where: buildPayoutWhere({
+ programId,
+ filters: {
+ status: rest.status,
+ partnerId,
+ invoiceId: rest.invoiceId,
+ isHoldStatus,
+ },
+ }),
+ include: {
+ programEnrollment: true,
+ partner: true,
+ user: true,
+ },
+ skip: (page - 1) * pageSize,
+ take: pageSize,
+ orderBy: {
+ [sortBy]: sortOrder,
+ },
+ });
+
+ return payouts.map(({ partner, programEnrollment, user, ...payout }) => {
+ const mode =
+ payout.mode ??
+ getEffectivePayoutMode({
+ payoutMode: program.payoutMode,
+ payoutsEnabledAt: partner.payoutsEnabledAt,
+ });
+
+ return {
+ ...payout,
+ mode,
+ traceId: payout.stripePayoutTraceId,
+ partner: {
+ ...partner,
+ tenantId: programEnrollment.tenantId,
+ },
+ user,
+ };
+ });
+}
+
+export async function getPayoutsCount({
+ programId,
+ filters,
+}: {
+ programId: string;
+ filters: ParsedPayoutsFilters;
+}) {
+ const { isHoldStatus, tenantId, ...rest } = filters;
+
+ const partnerId = await resolvePartnerId({
+ programId,
+ partnerId: rest.partnerId,
+ tenantId,
+ });
+
+ return prisma.payout.count({
+ where: buildPayoutWhere({
+ programId,
+ filters: {
+ status: rest.status,
+ partnerId,
+ invoiceId: rest.invoiceId,
+ isHoldStatus,
+ },
+ }),
+ });
+}
diff --git a/apps/web/lib/zod/schemas/commissions.ts b/apps/web/lib/zod/schemas/commissions.ts
index 19be79372f..e1e20a4e03 100644
--- a/apps/web/lib/zod/schemas/commissions.ts
+++ b/apps/web/lib/zod/schemas/commissions.ts
@@ -392,7 +392,12 @@ export const commissionsExportQuerySchema = getCommissionsQuerySchema
columns: z
.string()
.default(DEFAULT_COMMISSION_EXPORT_COLUMNS.join(","))
- .transform((v) => v.split(","))
+ .transform((v) =>
+ v
+ .split(",")
+ .map((s) => s.trim())
+ .filter(Boolean),
+ )
.refine(
(columns): columns is CommissionExportColumnId[] => {
const validColumnIds = COMMISSION_EXPORT_COLUMNS.map((col) => col.id);
diff --git a/apps/web/lib/zod/schemas/customers.ts b/apps/web/lib/zod/schemas/customers.ts
index 9cd0111e1a..96ffbe0ab2 100644
--- a/apps/web/lib/zod/schemas/customers.ts
+++ b/apps/web/lib/zod/schemas/customers.ts
@@ -375,7 +375,12 @@ export const customersExportQuerySchema = getCustomersQuerySchema
.string()
.optional()
.default(CUSTOMER_EXPORT_DEFAULT_COLUMNS.join(","))
- .transform((v) => v.split(","))
+ .transform((v) =>
+ v
+ .split(",")
+ .map((s) => s.trim())
+ .filter(Boolean),
+ )
.refine(
(columns) => {
const validColumnIds = CUSTOMER_EXPORT_COLUMNS.map((col) => col.id);
diff --git a/apps/web/lib/zod/schemas/payouts.ts b/apps/web/lib/zod/schemas/payouts.ts
index 14be896572..fe481f5091 100644
--- a/apps/web/lib/zod/schemas/payouts.ts
+++ b/apps/web/lib/zod/schemas/payouts.ts
@@ -205,3 +205,80 @@ export const eligiblePayoutsCountQuerySchema = eligiblePayoutsInputSchema
});
}
});
+
+export const PAYOUT_EXPORT_COLUMNS = [
+ { id: "id", label: "ID", type: "string", default: true },
+ { id: "amount", label: "Amount", type: "money", default: true },
+ { id: "currency", label: "Currency", type: "string", default: true },
+ { id: "status", label: "Status", type: "string", default: true },
+ { id: "periodStart", label: "Period start", type: "date", default: true },
+ { id: "periodEnd", label: "Period end", type: "date", default: true },
+ { id: "initiatedAt", label: "Initiated at", type: "date", default: true },
+ { id: "paidAt", label: "Paid at", type: "date", default: true },
+ { id: "invoiceId", label: "Invoice ID", type: "string", default: false },
+ { id: "description", label: "Description", type: "string", default: false },
+ { id: "method", label: "Payout method", type: "string", default: false },
+ { id: "traceId", label: "Payout trace ID", type: "string", default: false },
+ {
+ id: "failureReason",
+ label: "Failure reason",
+ type: "string",
+ default: false,
+ },
+ { id: "partnerId", label: "Partner ID", type: "string", default: false },
+ { id: "partnerName", label: "Partner name", type: "string", default: false },
+ {
+ id: "partnerEmail",
+ label: "Partner email",
+ type: "string",
+ default: false,
+ },
+ {
+ id: "partnerTenantId",
+ label: "Partner tenant ID",
+ type: "string",
+ default: false,
+ },
+] as const;
+
+type PayoutExportColumnId = (typeof PAYOUT_EXPORT_COLUMNS)[number]["id"];
+
+export const DEFAULT_PAYOUT_EXPORT_COLUMNS = PAYOUT_EXPORT_COLUMNS.filter(
+ (column) => column.default,
+).map((column) => column.id);
+
+export const payoutsExportQuerySchema = payoutsQuerySchema
+ .omit({
+ page: true,
+ pageSize: true,
+ })
+ .extend({
+ columns: z
+ .string()
+ .default(DEFAULT_PAYOUT_EXPORT_COLUMNS.join(","))
+ .transform((v) =>
+ v
+ .split(",")
+ .map((s) => s.trim())
+ .filter(Boolean),
+ )
+ .refine(
+ (columns): columns is PayoutExportColumnId[] => {
+ const validColumnIds = PAYOUT_EXPORT_COLUMNS.map((col) => col.id);
+
+ return columns.every((column): column is PayoutExportColumnId =>
+ validColumnIds.includes(column as PayoutExportColumnId),
+ );
+ },
+ {
+ message:
+ "Invalid column IDs provided. Please check the available columns.",
+ },
+ ),
+ });
+
+export const payoutsExportCronInputSchema = payoutsExportQuerySchema.extend({
+ workspaceId: z.string(),
+ programId: z.string(),
+ userId: z.string(),
+});
diff --git a/apps/web/ui/customers/export-customers-button.tsx b/apps/web/ui/customers/customers-menu-popover.tsx
similarity index 97%
rename from apps/web/ui/customers/export-customers-button.tsx
rename to apps/web/ui/customers/customers-menu-popover.tsx
index caccc10e2f..310557475b 100644
--- a/apps/web/ui/customers/export-customers-button.tsx
+++ b/apps/web/ui/customers/customers-menu-popover.tsx
@@ -5,7 +5,7 @@ import { ThreeDots } from "@/ui/shared/icons";
import { Button, Download, IconMenu, Popover } from "@dub/ui";
import { useState } from "react";
-export function ExportCustomersButton() {
+export function CustomersMenuPopover() {
const [openPopover, setOpenPopover] = useState(false);
const { ExportCustomersModal, setShowExportCustomersModal } =
diff --git a/apps/web/ui/modals/export-payouts-modal.tsx b/apps/web/ui/modals/export-payouts-modal.tsx
new file mode 100644
index 0000000000..33df4e9464
--- /dev/null
+++ b/apps/web/ui/modals/export-payouts-modal.tsx
@@ -0,0 +1,222 @@
+"use client";
+
+import { generateExportFilename } from "@/lib/api/utils/generate-export-filename";
+import useWorkspace from "@/lib/swr/use-workspace";
+import {
+ DEFAULT_PAYOUT_EXPORT_COLUMNS,
+ PAYOUT_EXPORT_COLUMNS,
+} from "@/lib/zod/schemas/payouts";
+import {
+ Button,
+ Checkbox,
+ InfoTooltip,
+ Modal,
+ Switch,
+ useRouterStuff,
+} from "@dub/ui";
+import { useSession } from "next-auth/react";
+import {
+ Dispatch,
+ SetStateAction,
+ useCallback,
+ useId,
+ useMemo,
+ useState,
+} from "react";
+import { Controller, useForm } from "react-hook-form";
+import { toast } from "sonner";
+
+interface FormData {
+ columns: string[];
+ useFilters: boolean;
+}
+
+function ExportPayoutsModal({
+ showExportPayoutsModal,
+ setShowExportPayoutsModal,
+}: {
+ showExportPayoutsModal: boolean;
+ setShowExportPayoutsModal: Dispatch<SetStateAction<boolean>>;
+}) {
+ const { data: session } = useSession();
+ const columnCheckboxId = useId();
+ const { id: workspaceId } = useWorkspace();
+ const { getQueryString } = useRouterStuff();
+
+ const {
+ control,
+ handleSubmit,
+ formState: { isSubmitting },
+ } = useForm<FormData>({
+ defaultValues: {
+ columns: DEFAULT_PAYOUT_EXPORT_COLUMNS,
+ useFilters: true,
+ },
+ });
+
+ const onSubmit = handleSubmit(async (data) => {
+ const lid = toast.loading("Exporting payouts...");
+
+ try {
+ const params = {
+ workspaceId,
+ ...(data.columns.length
+ ? { columns: data.columns.join(",") }
+ : undefined),
+ };
+
+ const queryString = data.useFilters
+ ? getQueryString(params, {
+ exclude: [
+ "payoutId",
+ "selectedPayoutId",
+ "selectedPayoutIds",
+ "excludedPayoutIds",
+ "confirmPayouts",
+ "page",
+ ],
+ })
+ : `?${new URLSearchParams(params as Record<string, string>).toString()}`;
+
+ const response = await fetch(`/api/payouts/export${queryString}`, {
+ method: "GET",
+ });
+
+ if (!response.ok) {
+ const body = await response.json();
+ throw new Error(body.error?.message ?? "Payout export failed");
+ }
+
+ if (response.status === 202) {
+ toast.success(
+ `Your export is being processed and we'll send you an email (${session?.user?.email}) when it's ready to download.`,
+ );
+ setShowExportPayoutsModal(false);
+ return;
+ }
+
+ const blob = await response.blob();
+ const url = window.URL.createObjectURL(blob);
+ const a = document.createElement("a");
+ a.href = url;
+ a.download = generateExportFilename("payouts");
+ a.click();
+ window.URL.revokeObjectURL(url);
+
+ toast.success("Payouts exported successfully");
+ setShowExportPayoutsModal(false);
+ } catch (error) {
+ toast.error(
+ error instanceof Error ? error.message : "Payout export failed",
+ );
+ } finally {
+ toast.dismiss(lid);
+ }
+ });
+
+ return (
+ <Modal
+ showModal={showExportPayoutsModal}
+ setShowModal={setShowExportPayoutsModal}
+ >
+ <div className="border-b border-neutral-200 p-4 sm:p-6">
+ <h3 className="text-lg font-medium leading-none">Export payouts</h3>
+ </div>
+
+ <form onSubmit={onSubmit}>
+ <div className="bg-neutral-50 p-4 sm:p-6">
+ <div className="space-y-4">
+ <div>
+ <p className="mb-2 block text-sm font-medium text-neutral-700">
+ Columns
+ </p>
+ <Controller
+ name="columns"
+ control={control}
+ render={({ field }) => (
+ <div className="xs:grid-cols-2 grid grid-cols-1 gap-x-4 gap-y-2">
+ {PAYOUT_EXPORT_COLUMNS.map(({ id, label }) => (
+ <div key={id} className="group flex gap-2">
+ <Checkbox
+ value={id}
+ id={`${columnCheckboxId}-${id}`}
+ checked={field.value.includes(id)}
+ onCheckedChange={(checked) => {
+ field.onChange(
+ checked
+ ? [...field.value, id]
+ : field.value.filter((value) => value !== id),
+ );
+ }}
+ />
+ <label
+ htmlFor={`${columnCheckboxId}-${id}`}
+ className="select-none text-sm font-medium text-neutral-600 group-hover:text-neutral-800"
+ >
+ {label}
+ </label>
+ </div>
+ ))}
+ </div>
+ )}
+ />
+ </div>
+ </div>
+ </div>
+
+ <div className="border-t border-neutral-200 bg-neutral-50 px-4 py-4 sm:px-6">
+ <Controller
+ name="useFilters"
+ control={control}
+ render={({ field }) => (
+ <div className="flex items-center justify-between gap-2">
+ <span className="flex select-none items-center gap-2 text-sm font-medium text-neutral-600 group-hover:text-neutral-800">
+ Apply current filters
+ <InfoTooltip content="Filter exported payouts by your currently selected filters" />
+ </span>
+ <Switch checked={field.value} fn={field.onChange} />
+ </div>
+ )}
+ />
+ </div>
+
+ <div className="flex items-center justify-end gap-2 border-t border-neutral-200 bg-neutral-50 px-4 py-5 sm:px-6">
+ <Button
+ onClick={() => setShowExportPayoutsModal(false)}
+ variant="secondary"
+ text="Cancel"
+ className="h-8 w-fit px-3"
+ type="button"
+ />
+ <Button
+ type="submit"
+ loading={isSubmitting}
+ text="Export payouts"
+ className="h-8 w-fit px-3"
+ />
+ </div>
+ </form>
+ </Modal>
+ );
+}
+
+export function useExportPayoutsModal() {
+ const [showExportPayoutsModal, setShowExportPayoutsModal] = useState(false);
+
+ const ExportPayoutsModalCallback = useCallback(() => {
+ return (
+ <ExportPayoutsModal
+ showExportPayoutsModal={showExportPayoutsModal}
+ setShowExportPayoutsModal={setShowExportPayoutsModal}
+ />
+ );
+ }, [showExportPayoutsModal, setShowExportPayoutsModal]);
+
+ return useMemo(
+ () => ({
+ setShowExportPayoutsModal,
+ ExportPayoutsModal: ExportPayoutsModalCallback,
+ }),
+ [setShowExportPayoutsModal, ExportPayoutsModalCallback],
+ );
+}
diff --git a/packages/email/src/templates/export-ready.tsx b/packages/email/src/templates/export-ready.tsx
index 83525f6fa1..64d5eff596 100644
--- a/packages/email/src/templates/export-ready.tsx
+++ b/packages/email/src/templates/export-ready.tsx
@@ -24,7 +24,13 @@ export default function ExportReady({
}: {
email: string;
downloadUrl: string;
- exportType: "partners" | "commissions" | "links" | "events" | "customers";
+ exportType:
+ | "partners"
+ | "commissions"
+ | "links"
+ | "events"
+ | "customers"
+ | "payouts";
expiresInDays?: number;
program?: {
name: string;