Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

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

Body

application/json

Request body for creating a report config.

report_type
enum<string>
required

Discriminator for report type

Available options:
integration_sync_report,
ar_aging_report
frequency
enum<string>
required

How often to send the report (DAILY, WEEKLY, MONTHLY)

Available options:
daily,
weekly,
monthly
time
string<time>
default:08:00:00

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

weekday
integer
default:4

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

Required range: 0 <= x <= 6
recipient_emails
string[]

Primary recipient email addresses

cc_emails
string[] | null

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

is_enabled
boolean | null

Response

Successful Response

Report configuration response.

created_at
string<date-time>
required
modified_at
string<date-time> | null
required
id
string
required
report_type
enum<string>
required

Discriminator for report type

Available options:
integration_sync_report,
ar_aging_report
is_enabled
boolean
required
frequency
enum<string>
required

How often to send the report (DAILY, WEEKLY, MONTHLY)

Available options:
daily,
weekly,
monthly
time
string<time>
required

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

weekday
integer
required

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

recipient_emails
string[]
required

Primary recipient email addresses

cc_emails
string[] | null
required

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

last_sent_at
string<date-time> | null
required

UTC timestamp of the last successful report send

object
string
required
read-only

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