Skip to main content
POST
Create a statement schedule for a workflow

Authorizations

Authorization
string
header
required

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

Path Parameters

workflow_id
string
required

Body

application/json
frequency
enum<string>
required
Available options:
weekly,
biweekly,
monthly
email_template
string
required

Email template ID

day_of_week
integer | null
Required range: 0 <= x <= 6
day_of_month
integer | null
Required range: 1 <= x <= 31
week_of_month
integer | null
Required range: 1 <= x <= 5
auto_send
boolean
default:true
attach_xls
boolean
default:false
include_credit_memos
boolean
default:true
include_disputed_items
boolean
default:false
cc
string[]
bcc
string[]
cc_secondary_contacts
boolean
default:false
external_roles_to_cc
enum<string>[]
Available options:
billing_contact,
executive,
economic_user
internal_roles_to_cc
enum<string>[]
Available options:
account_manager,
account_executive,
csm,
lead,
co_lead,
practice_lead

Response

Successful Response

created_at
string<date-time>
required
modified_at
string<date-time> | null
required
id
string
required
is_active
boolean
required
frequency
enum<string>
required

How often to send the statement

Available options:
weekly,
biweekly,
monthly
day_of_week
integer | null
required

Day of week (0=Monday, 6=Sunday). Required for WEEKLY/BIWEEKLY.

day_of_month
integer | null
required

Day of month (1-31). Required for MONTHLY day-of-month mode. Falls back to last day if month is shorter.

week_of_month
integer | null
required

Week occurrence (1-5, where 5=last). Used with day_of_week for monthly day-of-week mode.

biweekly_anchor_date
string<date> | null
required

Anchor date for biweekly cadence calculation. Required for BIWEEKLY.

include_credit_memos
boolean
required
include_disputed_items
boolean
required
auto_send
boolean
required
attach_xls
boolean
required

If True, always attach an XLS to the scheduled statement, ignoring partner.is_xls_attachments_enabled.

cc
string[] | null
required
bcc
string[] | null
required
cc_secondary_contacts
boolean
required
external_roles_to_cc
string[] | null
required
internal_roles_to_cc
string[] | null
required
email_template
EmailTemplateSummary · object | null
required
object
string
required
read-only

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