Skip to main content
POST
Generate report

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
report_type
enum<string>
required
Available options:
bill_pay_donations_dfa,
invoicing,
cogs,
partner_summary_total,
partner_members,
younegotiate_revenue,
compliance_consumer_pii_opt_out,
compliance_consumer_disputes_no_pay,
compliance_auto_expired_deleted_accounts,
consumer_payments,
super_admin_all_accounts
Example:

"bill_pay_donations_dfa"

start_date
string<date>
required

Start date in YYYY-MM-DD format. The request cannot span more than two months.

Example:

"2026-06-01"

end_date
string<date>
required

End date in YYYY-MM-DD format. Must be on or after start_date and not in the future.

Example:

"2026-06-30"

company_id

Use all_members, omit the field, or pass a company ID from the options endpoint.

Available options:
all_members
Example:

"all_members"

Response

CSV report download returned. Columns depend on report_type; YouNegotiate Revenue exports include platform member counts plus hosting, add-on, payment, ecoCommunication, and Superadmin communication revenue metrics. Compliance Consumer PII Comm Opt Out exports include consumer name, SSN, ten mobile opt-out slots, ten email opt-out slots, and mobile/email PII profile verification flags. Compliance Consumer Disputes/No Pay exports include consumer account identifiers, date reported by consumer, and dispute/no-pay reason. Compliance Auto Expired Deleted Accounts exports include member name, consumer identifiers, account identifiers, placement/expiry dates, balance, and auto-deleted date. Consumer Payments exports include consumer identifiers, member paid to, payment type/date/amount/status, payment ID, payer source, processing fee percent, and processing fee revenue. Super Admin All Accounts exports include account/contact fields, current negotiation status, pay terms, negotiated payment values, balances, last/next plan payment details, and payment-plan schedule counts.

The response is of type file.

Last modified on July 20, 2026