STstuut
report-configs

Create

Create a Report Config

Create a new report configuration. Only one config per report type per organization is allowed.

post/v2/report-configs

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

report_type'integration_sync_report' | 'ar_aging_report' | 'invoice_report' | 'customer_report' | 'payments_report' | 'credit_memo_report' required
frequency'daily' | 'weekly' | 'monthly' required
format'csv' | 'xlsx'
timestring time

Time of day (HH:MM) in org timezone. Minutes must be 0 or 30.

weekdayinteger

Day of the week (0=Monday, 6=Sunday). Only used by WEEKLY frequency.

recipient_emailsstring[]

Primary recipient email addresses

cc_emailsstring[] nullable

Optional CC email addresses (e.g., FDE team on failures)

is_enabledboolean nullable
notify_on_issues_onlyboolean

If true, suppress the routine success email and only send when the sync had a failure or an expected entity synced zero records in the window. Only applies to INTEGRATION_SYNC_REPORT.

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
report_type'integration_sync_report' | 'ar_aging_report' | 'invoice_report' | 'customer_report' | 'payments_report' | 'credit_memo_report' required
is_enabledboolean required
frequency'daily' | 'weekly' | 'monthly' required
format'csv' | 'xlsx' required
timestring time required

Time of day (HH:MM) in org timezone. Minutes must be 0 or 30.

weekdayinteger required

Day of the week (0=Monday, 6=Sunday). Only used by WEEKLY frequency.

recipient_emailsstring[] required

Primary recipient email addresses

cc_emailsstring[] nullable required

Optional CC email addresses (e.g., FDE team on failures)

notify_on_issues_onlyboolean required

If true, suppress the routine success email and only send when the sync had a failure or an expected entity synced zero records in the window. Only applies to INTEGRATION_SYNC_REPORT.

last_sent_atstring date-time nullable required

UTC timestamp of the last successful report send

objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

No recorded changes to this operation across all 2 revisions of this API.