Billing Templates

Certifications (v1-2025-04-18)

The Certifications API provides all the capabilities for managing the certification process beginning with your Certification Program. You can also manage Applications, Courses, or Course Offerings from this API.

Like most of the other Rhythm apps, the Certifications API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description
certifications-v1.json
certifications-v1.yaml
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/
https://certifications.api.rhythmsoftware.com/

Activities

Activities

Operations

Activity Reg Processes

Activity Reg Processes

Operations

Activity Types

Activity Types

Operations

App Reference Processes

App Reference Processes

Operations

App Reference Types

App Reference Types

Operations

App Status Reasons

App Status Reasons

Operations

Application Fees

Application Fees

Operations

Application Notices

Application Notices

Operations

Application Processes

Application Processes

Operations

Application References

Application References

Operations

Applications

Applications

Operations

Billing Run Actions

Billing Run Actions

Operations

Billing Runs

Billing Runs

Operations

Billing Templates

Billing Templates

Operations

Gets all of the billing templates in the system.

Request

This method will scan all billing templates and and return them to the caller.

Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKeystring

The start key, if you're making a subsequent request

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingTemplates/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The billing templateswere retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/jsonArray [
activate_applicationsboolean(Activate Applications)

If set, this billing run should activate all applications that have met all requirements

application_activation_optionsobject(Application Activation Options)required
application_activation_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_activation_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_activation_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_activation_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_activation_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_activation_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_activation_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_activation_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_activation_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_expiration_optionsobject(Application Expiration Options)required
application_expiration_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_expiration_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_expiration_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_expiration_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_expiration_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_expiration_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_expiration_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_expiration_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_expiration_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_reminder_optionsobject(Application Reminder Options)required
application_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_reminder_options.​remindersArray of objectsnon-emptyrequired
application_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

application_reminder_options.​reminders[].​namestring(Name)

Optional name

application_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

application_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
bill_training_providersboolean(Bill Training Providers)

When true, training providers should be sent invoices for training registrations

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the template

drop_optionsobject(Drop Options)required
drop_options.​drop_notice_idstring(Drop Notice)

The notice to send when a renewal order is created

drop_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
drop_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
drop_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

drop_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
drop_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
drop_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
expire_applicationsboolean(Expire Applications)

If set, applications that are past their expiration date are expired

forecast_renewalsboolean(Forecast Renewals)

Whether this template should be issuing renewal forecasts

idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

perform_dropsboolean(Perform Drops)

Whether this template should be dropping expired members

renewal_forecasting_optionsobject(Renewal Forecasting Options)required
renewal_forecasting_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_forecasting_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_forecasting_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_forecasting_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
renewal_reminder_optionsobject(Renewal Reminder Options)required
renewal_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
renewal_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_reminder_options.​remindersArray of objectsnon-emptyrequired
renewal_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

renewal_reminder_options.​reminders[].​namestring(Name)

Optional name

renewal_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

renewal_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

renewal_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
send_application_remindersboolean(Send Application Reminders)

If set, this billing run should send out application reminders to applications missing requirements and approaching expiration

send_renewal_remindersboolean(Send Renewal Reminders)

If set, this billing run should send out renewal reminders to those approaching expiration

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_billing_optionsobject(Training Provider Billing Options)required
training_provider_billing_options.​email_invoices_to_training_providersboolean(Email Invoices To Training Providers)

If true, all contact roles that are training provider administrators will receive an email with the invoice

training_provider_billing_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​invoice_template_idstring(Invoice Template)required

The invoice template to use to send out the training provider invoice

training_provider_billing_options.​payment_terms_idstring(Payment Terms)required

The payment terms to use to send out the training provider invoice

training_provider_billing_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
training_provider_billing_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
training_provider_billing_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
training_provider_billing_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
]
Response
application/json
[
  {
    "activate_applications": true,
    "application_activation_options": { … },
    "application_expiration_options": { … },
    "application_reminder_options": { … },
    "bill_training_providers": true,
    "custom_field_values": [ … ],
    "description": "string",
    "drop_options": { … },
    "expire_applications": true,
    "forecast_renewals": true,
    "id": "string",
    "is_active": true,
    "name": "string",
    "notification_email": "string",
    "perform_drops": true,
    "renewal_forecasting_options": { … },
    "renewal_reminder_options": { … },
    "send_application_reminders": true,
    "send_renewal_reminders": true,
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "training_provider_billing_options": { … }
  }
]

Creates a new billing template record that does not already exist.

Request

This method will auto-generate an ID and create a new billing template. If an ID is specified for the billing template, an error will be thrown.

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The billing template that you would like to be saved.

activate_applicationsboolean(Activate Applications)

If set, this billing run should activate all applications that have met all requirements

application_activation_optionsobject(Application Activation Options)required
application_activation_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_activation_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_activation_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_activation_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_activation_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_activation_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_activation_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_activation_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_activation_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_expiration_optionsobject(Application Expiration Options)required
application_expiration_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_expiration_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_expiration_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_expiration_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_expiration_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_expiration_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_expiration_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_expiration_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_expiration_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_reminder_optionsobject(Application Reminder Options)required
application_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_reminder_options.​remindersArray of objectsnon-emptyrequired
application_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

application_reminder_options.​reminders[].​namestring(Name)

Optional name

application_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

application_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
bill_training_providersboolean(Bill Training Providers)

When true, training providers should be sent invoices for training registrations

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the template

drop_optionsobject(Drop Options)required
drop_options.​drop_notice_idstring(Drop Notice)

The notice to send when a renewal order is created

drop_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
drop_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
drop_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

drop_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
drop_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
drop_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
expire_applicationsboolean(Expire Applications)

If set, applications that are past their expiration date are expired

forecast_renewalsboolean(Forecast Renewals)

Whether this template should be issuing renewal forecasts

idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

perform_dropsboolean(Perform Drops)

Whether this template should be dropping expired members

renewal_forecasting_optionsobject(Renewal Forecasting Options)required
renewal_forecasting_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_forecasting_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_forecasting_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_forecasting_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
renewal_reminder_optionsobject(Renewal Reminder Options)required
renewal_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
renewal_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_reminder_options.​remindersArray of objectsnon-emptyrequired
renewal_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

renewal_reminder_options.​reminders[].​namestring(Name)

Optional name

renewal_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

renewal_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

renewal_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
send_application_remindersboolean(Send Application Reminders)

If set, this billing run should send out application reminders to applications missing requirements and approaching expiration

send_renewal_remindersboolean(Send Renewal Reminders)

If set, this billing run should send out renewal reminders to those approaching expiration

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_billing_optionsobject(Training Provider Billing Options)required
training_provider_billing_options.​email_invoices_to_training_providersboolean(Email Invoices To Training Providers)

If true, all contact roles that are training provider administrators will receive an email with the invoice

training_provider_billing_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​invoice_template_idstring(Invoice Template)required

The invoice template to use to send out the training provider invoice

training_provider_billing_options.​payment_terms_idstring(Payment Terms)required

The payment terms to use to send out the training provider invoice

training_provider_billing_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
training_provider_billing_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
training_provider_billing_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
training_provider_billing_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingTemplates/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "activate_applications": true,
    "application_activation_options": {
      "application_notice_id": "string",
      "application_types": {
        "0": "certification"
      },
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "restrict_application_types": true,
      "restrict_status_reasons": true,
      "status_reason_ids": {
        "0": "string"
      },
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    },
    "application_expiration_options": {
      "application_notice_id": "string",
      "application_types": {
        "0": "certification"
      },
      "expiration_date_range_end": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "expiration_date_range_start": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "restrict_application_types": true,
      "restrict_status_reasons": true,
      "status_reason_ids": {
        "0": "string"
      },
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    },
    "application_reminder_options": {
      "application_types": {
        "0": "certification"
      },
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "reminders": [
        {
          "expiration_date_range_end": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "expiration_date_range_start": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "id": 0.1,
          "name": "string",
          "reminder_notice_id": "string"
        }
      ],
      "restrict_application_types": true,
      "restrict_status_reasons": true,
      "status_reason_ids": {
        "0": "string"
      },
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    },
    "bill_training_providers": true,
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "description": "string",
    "drop_options": {
      "drop_notice_id": "string",
      "expiration_date_range_end": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "expiration_date_range_start": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "restrict_status_reasons": true,
      "status_reason_ids": {
        "0": "string"
      },
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    },
    "expire_applications": true,
    "forecast_renewals": true,
    "id": "string",
    "is_active": true,
    "name": "string",
    "notification_email": "string",
    "perform_drops": true,
    "renewal_forecasting_options": {
      "expiration_date_range_end": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "expiration_date_range_start": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "restrict_status_reasons": true,
      "status_reason_ids": {
        "0": "string"
      },
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    },
    "renewal_reminder_options": {
      "application_types": {
        "0": "certification"
      },
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "reminders": [
        {
          "expiration_date_range_end": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "expiration_date_range_start": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "id": 0.1,
          "name": "string",
          "reminder_notice_id": "string"
        }
      ],
      "restrict_application_types": true,
      "restrict_status_reasons": true,
      "status_reason_ids": {
        "0": "string"
      },
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    },
    "send_application_reminders": true,
    "send_renewal_reminders": true,
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "training_provider_billing_options": {
      "email_invoices_to_training_providers": true,
      "expiration_date_range_end": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "expiration_date_range_start": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "invoice_template_id": "string",
      "payment_terms_id": "string",
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    }
  }'

Responses

The billing template was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
activate_applicationsboolean(Activate Applications)

If set, this billing run should activate all applications that have met all requirements

application_activation_optionsobject(Application Activation Options)required
application_activation_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_activation_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_activation_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_activation_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_activation_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_activation_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_activation_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_activation_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_activation_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_expiration_optionsobject(Application Expiration Options)required
application_expiration_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_expiration_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_expiration_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_expiration_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_expiration_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_expiration_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_expiration_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_expiration_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_expiration_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_reminder_optionsobject(Application Reminder Options)required
application_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_reminder_options.​remindersArray of objectsnon-emptyrequired
application_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

application_reminder_options.​reminders[].​namestring(Name)

Optional name

application_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

application_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
bill_training_providersboolean(Bill Training Providers)

When true, training providers should be sent invoices for training registrations

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the template

drop_optionsobject(Drop Options)required
drop_options.​drop_notice_idstring(Drop Notice)

The notice to send when a renewal order is created

drop_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
drop_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
drop_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

drop_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
drop_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
drop_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
expire_applicationsboolean(Expire Applications)

If set, applications that are past their expiration date are expired

forecast_renewalsboolean(Forecast Renewals)

Whether this template should be issuing renewal forecasts

idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

perform_dropsboolean(Perform Drops)

Whether this template should be dropping expired members

renewal_forecasting_optionsobject(Renewal Forecasting Options)required
renewal_forecasting_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_forecasting_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_forecasting_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_forecasting_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
renewal_reminder_optionsobject(Renewal Reminder Options)required
renewal_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
renewal_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_reminder_options.​remindersArray of objectsnon-emptyrequired
renewal_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

renewal_reminder_options.​reminders[].​namestring(Name)

Optional name

renewal_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

renewal_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

renewal_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
send_application_remindersboolean(Send Application Reminders)

If set, this billing run should send out application reminders to applications missing requirements and approaching expiration

send_renewal_remindersboolean(Send Renewal Reminders)

If set, this billing run should send out renewal reminders to those approaching expiration

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_billing_optionsobject(Training Provider Billing Options)required
training_provider_billing_options.​email_invoices_to_training_providersboolean(Email Invoices To Training Providers)

If true, all contact roles that are training provider administrators will receive an email with the invoice

training_provider_billing_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​invoice_template_idstring(Invoice Template)required

The invoice template to use to send out the training provider invoice

training_provider_billing_options.​payment_terms_idstring(Payment Terms)required

The payment terms to use to send out the training provider invoice

training_provider_billing_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
training_provider_billing_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
training_provider_billing_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
training_provider_billing_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
Response
application/json
{
  "activate_applications": true,
  "application_activation_options": {
    "application_notice_id": "string",
    "application_types": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "application_expiration_options": {
    "application_notice_id": "string",
    "application_types": { … },
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "application_reminder_options": {
    "application_types": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "reminders": [ … ],
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "bill_training_providers": true,
  "custom_field_values": [
    { … }
  ],
  "description": "string",
  "drop_options": {
    "drop_notice_id": "string",
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "expire_applications": true,
  "forecast_renewals": true,
  "id": "string",
  "is_active": true,
  "name": "string",
  "notification_email": "string",
  "perform_drops": true,
  "renewal_forecasting_options": {
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "renewal_reminder_options": {
    "application_types": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "reminders": [ … ],
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "send_application_reminders": true,
  "send_renewal_reminders": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "training_provider_billing_options": {
    "email_invoices_to_training_providers": true,
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "invoice_template_id": "string",
    "payment_terms_id": "string",
    "program_ids": { … },
    "program_restriction": "exclude",
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  }
}

Execute Batch Operations

Request

TAllows you to perform up to 100 parallel patch/delete operations

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingTemplates/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects
success_countnumber(float)(Success Count)

Number of successful results

Response
application/json
{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Generates a billing run from a template

Request

Path
tenantIdstringrequired

The tenant

templateIdstringrequired

The template

referenceDatestringrequired

The reference date

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingTemplates/{tenantId}/fromTemplate/{templateId}/{referenceDate}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring

Returns a billing template from the system by its ID.

Request

This method will delete a billing template with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing template to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingTemplates/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The billing template was deleted successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
string
Response
application/json
"string"

Returns a billing template from the system by its ID.

Request

This method will look up a billing template by the specified ID and return it back.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing template to return.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingTemplates/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The billing template was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
activate_applicationsboolean(Activate Applications)

If set, this billing run should activate all applications that have met all requirements

application_activation_optionsobject(Application Activation Options)required
application_activation_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_activation_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_activation_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_activation_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_activation_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_activation_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_activation_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_activation_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_activation_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_expiration_optionsobject(Application Expiration Options)required
application_expiration_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_expiration_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_expiration_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_expiration_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_expiration_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_expiration_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_expiration_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_expiration_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_expiration_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_reminder_optionsobject(Application Reminder Options)required
application_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_reminder_options.​remindersArray of objectsnon-emptyrequired
application_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

application_reminder_options.​reminders[].​namestring(Name)

Optional name

application_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

application_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
bill_training_providersboolean(Bill Training Providers)

When true, training providers should be sent invoices for training registrations

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the template

drop_optionsobject(Drop Options)required
drop_options.​drop_notice_idstring(Drop Notice)

The notice to send when a renewal order is created

drop_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
drop_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
drop_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

drop_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
drop_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
drop_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
expire_applicationsboolean(Expire Applications)

If set, applications that are past their expiration date are expired

forecast_renewalsboolean(Forecast Renewals)

Whether this template should be issuing renewal forecasts

idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

perform_dropsboolean(Perform Drops)

Whether this template should be dropping expired members

renewal_forecasting_optionsobject(Renewal Forecasting Options)required
renewal_forecasting_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_forecasting_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_forecasting_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_forecasting_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
renewal_reminder_optionsobject(Renewal Reminder Options)required
renewal_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
renewal_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_reminder_options.​remindersArray of objectsnon-emptyrequired
renewal_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

renewal_reminder_options.​reminders[].​namestring(Name)

Optional name

renewal_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

renewal_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

renewal_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
send_application_remindersboolean(Send Application Reminders)

If set, this billing run should send out application reminders to applications missing requirements and approaching expiration

send_renewal_remindersboolean(Send Renewal Reminders)

If set, this billing run should send out renewal reminders to those approaching expiration

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_billing_optionsobject(Training Provider Billing Options)required
training_provider_billing_options.​email_invoices_to_training_providersboolean(Email Invoices To Training Providers)

If true, all contact roles that are training provider administrators will receive an email with the invoice

training_provider_billing_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​invoice_template_idstring(Invoice Template)required

The invoice template to use to send out the training provider invoice

training_provider_billing_options.​payment_terms_idstring(Payment Terms)required

The payment terms to use to send out the training provider invoice

training_provider_billing_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
training_provider_billing_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
training_provider_billing_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
training_provider_billing_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
Response
application/json
{
  "activate_applications": true,
  "application_activation_options": {
    "application_notice_id": "string",
    "application_types": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "application_expiration_options": {
    "application_notice_id": "string",
    "application_types": { … },
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "application_reminder_options": {
    "application_types": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "reminders": [ … ],
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "bill_training_providers": true,
  "custom_field_values": [
    { … }
  ],
  "description": "string",
  "drop_options": {
    "drop_notice_id": "string",
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "expire_applications": true,
  "forecast_renewals": true,
  "id": "string",
  "is_active": true,
  "name": "string",
  "notification_email": "string",
  "perform_drops": true,
  "renewal_forecasting_options": {
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "renewal_reminder_options": {
    "application_types": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "reminders": [ … ],
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "send_application_reminders": true,
  "send_renewal_reminders": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "training_provider_billing_options": {
    "email_invoices_to_training_providers": true,
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "invoice_template_id": "string",
    "payment_terms_id": "string",
    "program_ids": { … },
    "program_restriction": "exclude",
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  }
}

Partially updates a billing template with the specified ID.

Request

This method will patch an existing billing template with the specified ID, using the HTTP PATCH specification.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing template to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [
opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"
pathstring(Path)required

The JSON path

valuestring(Value)

The updated value

]
curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingTemplates/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The billing template was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
activate_applicationsboolean(Activate Applications)

If set, this billing run should activate all applications that have met all requirements

application_activation_optionsobject(Application Activation Options)required
application_activation_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_activation_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_activation_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_activation_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_activation_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_activation_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_activation_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_activation_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_activation_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_expiration_optionsobject(Application Expiration Options)required
application_expiration_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_expiration_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_expiration_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_expiration_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_expiration_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_expiration_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_expiration_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_expiration_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_expiration_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_reminder_optionsobject(Application Reminder Options)required
application_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_reminder_options.​remindersArray of objectsnon-emptyrequired
application_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

application_reminder_options.​reminders[].​namestring(Name)

Optional name

application_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

application_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
bill_training_providersboolean(Bill Training Providers)

When true, training providers should be sent invoices for training registrations

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the template

drop_optionsobject(Drop Options)required
drop_options.​drop_notice_idstring(Drop Notice)

The notice to send when a renewal order is created

drop_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
drop_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
drop_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

drop_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
drop_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
drop_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
expire_applicationsboolean(Expire Applications)

If set, applications that are past their expiration date are expired

forecast_renewalsboolean(Forecast Renewals)

Whether this template should be issuing renewal forecasts

idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

perform_dropsboolean(Perform Drops)

Whether this template should be dropping expired members

renewal_forecasting_optionsobject(Renewal Forecasting Options)required
renewal_forecasting_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_forecasting_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_forecasting_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_forecasting_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
renewal_reminder_optionsobject(Renewal Reminder Options)required
renewal_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
renewal_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_reminder_options.​remindersArray of objectsnon-emptyrequired
renewal_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

renewal_reminder_options.​reminders[].​namestring(Name)

Optional name

renewal_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

renewal_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

renewal_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
send_application_remindersboolean(Send Application Reminders)

If set, this billing run should send out application reminders to applications missing requirements and approaching expiration

send_renewal_remindersboolean(Send Renewal Reminders)

If set, this billing run should send out renewal reminders to those approaching expiration

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_billing_optionsobject(Training Provider Billing Options)required
training_provider_billing_options.​email_invoices_to_training_providersboolean(Email Invoices To Training Providers)

If true, all contact roles that are training provider administrators will receive an email with the invoice

training_provider_billing_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​invoice_template_idstring(Invoice Template)required

The invoice template to use to send out the training provider invoice

training_provider_billing_options.​payment_terms_idstring(Payment Terms)required

The payment terms to use to send out the training provider invoice

training_provider_billing_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
training_provider_billing_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
training_provider_billing_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
training_provider_billing_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
Response
application/json
{
  "activate_applications": true,
  "application_activation_options": {
    "application_notice_id": "string",
    "application_types": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "application_expiration_options": {
    "application_notice_id": "string",
    "application_types": { … },
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "application_reminder_options": {
    "application_types": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "reminders": [ … ],
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "bill_training_providers": true,
  "custom_field_values": [
    { … }
  ],
  "description": "string",
  "drop_options": {
    "drop_notice_id": "string",
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "expire_applications": true,
  "forecast_renewals": true,
  "id": "string",
  "is_active": true,
  "name": "string",
  "notification_email": "string",
  "perform_drops": true,
  "renewal_forecasting_options": {
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "renewal_reminder_options": {
    "application_types": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "reminders": [ … ],
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "send_application_reminders": true,
  "send_renewal_reminders": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "training_provider_billing_options": {
    "email_invoices_to_training_providers": true,
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "invoice_template_id": "string",
    "payment_terms_id": "string",
    "program_ids": { … },
    "program_restriction": "exclude",
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  }
}

Updates a billing template with the specified ID.

Request

This method will update an existing billing template with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing template to update.

Bodyapplication/jsonrequired

The updated billing template that will be saved.

activate_applicationsboolean(Activate Applications)

If set, this billing run should activate all applications that have met all requirements

application_activation_optionsobject(Application Activation Options)required
application_activation_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_activation_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_activation_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_activation_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_activation_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_activation_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_activation_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_activation_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_activation_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_expiration_optionsobject(Application Expiration Options)required
application_expiration_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_expiration_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_expiration_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_expiration_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_expiration_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_expiration_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_expiration_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_expiration_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_expiration_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_reminder_optionsobject(Application Reminder Options)required
application_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_reminder_options.​remindersArray of objectsnon-emptyrequired
application_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

application_reminder_options.​reminders[].​namestring(Name)

Optional name

application_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

application_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
bill_training_providersboolean(Bill Training Providers)

When true, training providers should be sent invoices for training registrations

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the template

drop_optionsobject(Drop Options)required
drop_options.​drop_notice_idstring(Drop Notice)

The notice to send when a renewal order is created

drop_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
drop_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
drop_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

drop_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
drop_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
drop_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
expire_applicationsboolean(Expire Applications)

If set, applications that are past their expiration date are expired

forecast_renewalsboolean(Forecast Renewals)

Whether this template should be issuing renewal forecasts

idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

perform_dropsboolean(Perform Drops)

Whether this template should be dropping expired members

renewal_forecasting_optionsobject(Renewal Forecasting Options)required
renewal_forecasting_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_forecasting_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_forecasting_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_forecasting_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
renewal_reminder_optionsobject(Renewal Reminder Options)required
renewal_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
renewal_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_reminder_options.​remindersArray of objectsnon-emptyrequired
renewal_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

renewal_reminder_options.​reminders[].​namestring(Name)

Optional name

renewal_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

renewal_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

renewal_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
send_application_remindersboolean(Send Application Reminders)

If set, this billing run should send out application reminders to applications missing requirements and approaching expiration

send_renewal_remindersboolean(Send Renewal Reminders)

If set, this billing run should send out renewal reminders to those approaching expiration

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_billing_optionsobject(Training Provider Billing Options)required
training_provider_billing_options.​email_invoices_to_training_providersboolean(Email Invoices To Training Providers)

If true, all contact roles that are training provider administrators will receive an email with the invoice

training_provider_billing_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​invoice_template_idstring(Invoice Template)required

The invoice template to use to send out the training provider invoice

training_provider_billing_options.​payment_terms_idstring(Payment Terms)required

The payment terms to use to send out the training provider invoice

training_provider_billing_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
training_provider_billing_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
training_provider_billing_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
training_provider_billing_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingTemplates/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "activate_applications": true,
    "application_activation_options": {
      "application_notice_id": "string",
      "application_types": {
        "0": "certification"
      },
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "restrict_application_types": true,
      "restrict_status_reasons": true,
      "status_reason_ids": {
        "0": "string"
      },
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    },
    "application_expiration_options": {
      "application_notice_id": "string",
      "application_types": {
        "0": "certification"
      },
      "expiration_date_range_end": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "expiration_date_range_start": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "restrict_application_types": true,
      "restrict_status_reasons": true,
      "status_reason_ids": {
        "0": "string"
      },
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    },
    "application_reminder_options": {
      "application_types": {
        "0": "certification"
      },
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "reminders": [
        {
          "expiration_date_range_end": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "expiration_date_range_start": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "id": 0.1,
          "name": "string",
          "reminder_notice_id": "string"
        }
      ],
      "restrict_application_types": true,
      "restrict_status_reasons": true,
      "status_reason_ids": {
        "0": "string"
      },
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    },
    "bill_training_providers": true,
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "description": "string",
    "drop_options": {
      "drop_notice_id": "string",
      "expiration_date_range_end": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "expiration_date_range_start": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "restrict_status_reasons": true,
      "status_reason_ids": {
        "0": "string"
      },
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    },
    "expire_applications": true,
    "forecast_renewals": true,
    "id": "string",
    "is_active": true,
    "name": "string",
    "notification_email": "string",
    "perform_drops": true,
    "renewal_forecasting_options": {
      "expiration_date_range_end": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "expiration_date_range_start": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "restrict_status_reasons": true,
      "status_reason_ids": {
        "0": "string"
      },
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    },
    "renewal_reminder_options": {
      "application_types": {
        "0": "certification"
      },
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "reminders": [
        {
          "expiration_date_range_end": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "expiration_date_range_start": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "id": 0.1,
          "name": "string",
          "reminder_notice_id": "string"
        }
      ],
      "restrict_application_types": true,
      "restrict_status_reasons": true,
      "status_reason_ids": {
        "0": "string"
      },
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    },
    "send_application_reminders": true,
    "send_renewal_reminders": true,
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "training_provider_billing_options": {
      "email_invoices_to_training_providers": true,
      "expiration_date_range_end": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "expiration_date_range_start": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "invoice_template_id": "string",
      "payment_terms_id": "string",
      "program_ids": {
        "0": "string"
      },
      "program_restriction": "exclude",
      "training_provider_ids": {
        "0": "string"
      },
      "training_provider_restriction": "exclude"
    }
  }'

Responses

The billing template was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
activate_applicationsboolean(Activate Applications)

If set, this billing run should activate all applications that have met all requirements

application_activation_optionsobject(Application Activation Options)required
application_activation_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_activation_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_activation_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_activation_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_activation_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_activation_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_activation_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_activation_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_activation_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_expiration_optionsobject(Application Expiration Options)required
application_expiration_options.​application_notice_idstring(Application Notice)

The notice to send when a renewal order is created

application_expiration_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_expiration_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_expiration_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_expiration_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_expiration_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_expiration_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_expiration_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_expiration_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_expiration_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_expiration_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_expiration_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_expiration_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_expiration_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
application_reminder_optionsobject(Application Reminder Options)required
application_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
application_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
application_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
application_reminder_options.​remindersArray of objectsnon-emptyrequired
application_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

application_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

application_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
application_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
application_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
application_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

application_reminder_options.​reminders[].​namestring(Name)

Optional name

application_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

application_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

application_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

application_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
application_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
application_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
bill_training_providersboolean(Bill Training Providers)

When true, training providers should be sent invoices for training registrations

custom_field_valuesArray of objects(Custom Field Values)
descriptionstring(Description)

A description of the template

drop_optionsobject(Drop Options)required
drop_options.​drop_notice_idstring(Drop Notice)

The notice to send when a renewal order is created

drop_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

drop_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

drop_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
drop_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
drop_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
drop_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
drop_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
drop_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

drop_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
drop_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
drop_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
expire_applicationsboolean(Expire Applications)

If set, applications that are past their expiration date are expired

forecast_renewalsboolean(Forecast Renewals)

Whether this template should be issuing renewal forecasts

idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

perform_dropsboolean(Perform Drops)

Whether this template should be dropping expired members

renewal_forecasting_optionsobject(Renewal Forecasting Options)required
renewal_forecasting_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_forecasting_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_forecasting_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_forecasting_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_forecasting_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_forecasting_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_forecasting_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_forecasting_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_forecasting_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_forecasting_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
renewal_reminder_optionsobject(Renewal Reminder Options)required
renewal_reminder_options.​application_typesArray of Application Types (strings)(Application Types)non-empty
One of:
non-empty
renewal_reminder_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
renewal_reminder_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
renewal_reminder_options.​remindersArray of objectsnon-emptyrequired
renewal_reminder_options.​reminders[].​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

renewal_reminder_options.​reminders[].​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

renewal_reminder_options.​reminders[].​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
renewal_reminder_options.​reminders[].​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
renewal_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

renewal_reminder_options.​reminders[].​namestring(Name)

Optional name

renewal_reminder_options.​reminders[].​reminder_notice_idstring(Reminder Notice)required

The reminder notice

renewal_reminder_options.​restrict_application_typesboolean(Restrict Application Types)

If true, only certain types of applications are included

renewal_reminder_options.​restrict_status_reasonsboolean(Restrict Status Reasons)

If true, only applications with certain status reasons will be included

renewal_reminder_options.​status_reason_idsArray of Status Reasons (strings)(Status Reasons)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
renewal_reminder_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
send_application_remindersboolean(Send Application Reminders)

If set, this billing run should send out application reminders to applications missing requirements and approaching expiration

send_renewal_remindersboolean(Send Renewal Reminders)

If set, this billing run should send out renewal reminders to those approaching expiration

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_billing_optionsobject(Training Provider Billing Options)required
training_provider_billing_options.​email_invoices_to_training_providersboolean(Email Invoices To Training Providers)

If true, all contact roles that are training provider administrators will receive an email with the invoice

training_provider_billing_options.​expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_end.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_end.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_end.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_end.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

training_provider_billing_options.​expiration_date_range_start.​numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0
number(float)(Number)>= 0

The unit of time

training_provider_billing_options.​expiration_date_range_start.​positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"
training_provider_billing_options.​expiration_date_range_start.​relative_tostring(Relative To)required
Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"
training_provider_billing_options.​expiration_date_range_start.​unit_of_timeUnit Of Time (string)(Unit Of Time)required
Enum"days""months""weeks""years"
One of:
string(Unit Of Time)
Enum"days""months""weeks""years"
training_provider_billing_options.​invoice_template_idstring(Invoice Template)required

The invoice template to use to send out the training provider invoice

training_provider_billing_options.​payment_terms_idstring(Payment Terms)required

The payment terms to use to send out the training provider invoice

training_provider_billing_options.​program_idsArray of Programs (strings)(Programs)non-empty
One of:
non-empty
training_provider_billing_options.​program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"
training_provider_billing_options.​training_provider_idsArray of Training Providers (strings)(Training Providers)non-empty
One of:
non-empty
training_provider_billing_options.​training_provider_restrictionstring(Training Provider Restriction)

Determines if/how to restrict the training providers in this run

Enum"exclude""include""none"
Response
application/json
{
  "activate_applications": true,
  "application_activation_options": {
    "application_notice_id": "string",
    "application_types": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "application_expiration_options": {
    "application_notice_id": "string",
    "application_types": { … },
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "application_reminder_options": {
    "application_types": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "reminders": [ … ],
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "bill_training_providers": true,
  "custom_field_values": [
    { … }
  ],
  "description": "string",
  "drop_options": {
    "drop_notice_id": "string",
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "expire_applications": true,
  "forecast_renewals": true,
  "id": "string",
  "is_active": true,
  "name": "string",
  "notification_email": "string",
  "perform_drops": true,
  "renewal_forecasting_options": {
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "renewal_reminder_options": {
    "application_types": { … },
    "program_ids": { … },
    "program_restriction": "exclude",
    "reminders": [ … ],
    "restrict_application_types": true,
    "restrict_status_reasons": true,
    "status_reason_ids": { … },
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  },
  "send_application_reminders": true,
  "send_renewal_reminders": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "training_provider_billing_options": {
    "email_invoices_to_training_providers": true,
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "invoice_template_id": "string",
    "payment_terms_id": "string",
    "program_ids": { … },
    "program_restriction": "exclude",
    "training_provider_ids": { … },
    "training_provider_restriction": "exclude"
  }
}

Certifications

Certifications

Operations

Coupons

Coupons

Operations

Course Fees

Course Fees

Operations

Course Instructors

Course Instructors

Operations

Course Offerings

Course Offerings

Operations

Course Reg Processes

Course Reg Processes

Operations

Course Registrations

Course Registrations

Operations

Course Types

Course Types

Operations

Courses

Courses

Operations

Credit Types

Credit Types

Operations

Credits

Credits

Operations

Directories

Directories

Operations

Exam Fees

Exam Fees

Operations

Exam Notices

Exam Notices

Operations

Exam Offerings

Exam Offerings

Operations

Exam Reg Processes

Exam Reg Processes

Operations

Exam Registrations

Exam Registrations

Operations

Exam Sites

Exam Sites

Operations

Exams

Exams

Operations

Expiration Rule Sets

Expiration Rule Sets

Operations

Fees

Fees

Operations

Instructors

Instructors

Operations

License Types

License Types

Operations

Notices

Notices

Operations

Profiles

Profiles

Operations

Program Groups

Program Groups

Operations

Programs

Programs

Operations

Project Types

Project Types

Operations

Query Definitions

Query Definitions

Operations

Recurring Billing Runs

Recurring Billing Runs

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations

Status Reasons

Status Reasons

Operations

Testing Facilities

Testing Facilities

Operations

Training Locations

Training Locations

Operations

Training Prov Programs

Training Prov Programs

Operations

Training Providers

Training Providers

Operations