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.
The billing run that you would like to be saved.
If set, this billing run should activate all applications that have met all requirements
The notice to send when a renewal order is created
Determines if/how to restrict the programs in this run
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
The notice to send when a renewal order is created
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
Determines if/how to restrict the programs in this run
The date to use to filter out which memberships are candidate
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
When true, training providers should be sent invoices for training registrations
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only applications with certain status reasons will be included
If set, applications that are past their expiration date are expired
Whether this billing run should be issuing renewal forecasts
The date this billing run was actually processed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only applications with certain status reasons will be included
Determines if/how to restrict the programs in this run
The date to use to filter out which memberships are candidate
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
If set, this billing run should send out application reminders to applications missing requirements and approaching expiration
If set, this billing run should send out renewal reminders to those approaching expiration
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
If true, all contact roles that are training provider administrators will receive an email with the invoice
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
The invoice template to use to send out the training provider invoice
The payment terms to use to send out the training provider invoice
Determines if/how to restrict the programs in this run
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingRuns/{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": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"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": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"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,
"drop_options": {
"drop_notice_id": "string",
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"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"
},
"error": "string",
"error_stack": "string",
"expire_applications": true,
"forecast_renewals": true,
"id": "string",
"last_refresh_date": "2019-08-24T14:15:22Z",
"name": "string",
"notification_email": "string",
"perform_drops": true,
"preprocessing_date": "2019-08-24T14:15:22Z",
"recurring_billing_run_id": "string",
"renewal_forecasting_options": {
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"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": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"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"
},
"run_date": "2019-08-24T14:15:22Z",
"scheduled_preprocessing_date": "2019-08-24T14:15:22Z",
"scheduled_run_date": "2019-08-24T14:15:22Z",
"send_application_reminders": true,
"send_renewal_reminders": true,
"statistics": [
{
"action": "string",
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
}
],
"status": "cancelled",
"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,
"template_id": "string",
"training_provider_billing_options": {
"email_invoices_to_training_providers": true,
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"invoice_template_id": "string",
"payment_terms_id": "string",
"program_ids": {
"0": "string"
},
"program_restriction": "exclude",
"training_provider_ids": {
"0": "string"
},
"training_provider_restriction": "exclude"
}
}'The billing run was saved successfully.
If set, this billing run should activate all applications that have met all requirements
The notice to send when a renewal order is created
Determines if/how to restrict the programs in this run
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
The notice to send when a renewal order is created
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
Determines if/how to restrict the programs in this run
The date to use to filter out which memberships are candidate
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
When true, training providers should be sent invoices for training registrations
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only applications with certain status reasons will be included
If set, applications that are past their expiration date are expired
Whether this billing run should be issuing renewal forecasts
The date this billing run was actually processed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only applications with certain status reasons will be included
Determines if/how to restrict the programs in this run
The date to use to filter out which memberships are candidate
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
If set, this billing run should send out application reminders to applications missing requirements and approaching expiration
If set, this billing run should send out renewal reminders to those approaching expiration
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
If true, all contact roles that are training provider administrators will receive an email with the invoice
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
The invoice template to use to send out the training provider invoice
The payment terms to use to send out the training provider invoice
Determines if/how to restrict the programs in this run
{ "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": "2019-08-24", "expiration_date_range_start": "2019-08-24", "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, "drop_options": { "drop_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "program_ids": { … }, "program_restriction": "exclude", "restrict_status_reasons": true, "status_reason_ids": { … }, "training_provider_ids": { … }, "training_provider_restriction": "exclude" }, "error": "string", "error_stack": "string", "expire_applications": true, "forecast_renewals": true, "id": "string", "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "perform_drops": true, "preprocessing_date": "2019-08-24T14:15:22Z", "recurring_billing_run_id": "string", "renewal_forecasting_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "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" }, "run_date": "2019-08-24T14:15:22Z", "scheduled_preprocessing_date": "2019-08-24T14:15:22Z", "scheduled_run_date": "2019-08-24T14:15:22Z", "send_application_reminders": true, "send_renewal_reminders": true, "statistics": [ { … } ], "status": "cancelled", "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, "template_id": "string", "training_provider_billing_options": { "email_invoices_to_training_providers": true, "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "invoice_template_id": "string", "payment_terms_id": "string", "program_ids": { … }, "program_restriction": "exclude", "training_provider_ids": { … }, "training_provider_restriction": "exclude" } }
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingRuns/{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"
}
}
}
]
}'{ "error_count": 0.1, "results": [ { … } ], "success_count": 0.1 }
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingRuns/{tenantId}/refresh/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "executionArn": "string", "notification_channel": "string", "notification_publishKey": "string", "notification_subscribeKey": "string", "start_date": "2019-08-24T14:15:22Z" }
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingRuns/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"activate_applications": [
true
],
"application_expiration_options": [
true
],
"bill_training_providers": [
true
],
"ids": [
"string"
],
"name": "string",
"perform_drops": [
true
],
"run_date": [
"string",
"string"
],
"scheduled_run_date": [
"string",
"string"
],
"send_application_reminders": [
true
],
"send_renewal_reminders": [
true
],
"status": [
"string"
]
}'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingRuns/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingRuns/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The billing run was retrieved successfully.
If set, this billing run should activate all applications that have met all requirements
The notice to send when a renewal order is created
Determines if/how to restrict the programs in this run
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
The notice to send when a renewal order is created
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
Determines if/how to restrict the programs in this run
The date to use to filter out which memberships are candidate
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
When true, training providers should be sent invoices for training registrations
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only applications with certain status reasons will be included
If set, applications that are past their expiration date are expired
Whether this billing run should be issuing renewal forecasts
The date this billing run was actually processed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only applications with certain status reasons will be included
Determines if/how to restrict the programs in this run
The date to use to filter out which memberships are candidate
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
If set, this billing run should send out application reminders to applications missing requirements and approaching expiration
If set, this billing run should send out renewal reminders to those approaching expiration
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
If true, all contact roles that are training provider administrators will receive an email with the invoice
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
The invoice template to use to send out the training provider invoice
The payment terms to use to send out the training provider invoice
Determines if/how to restrict the programs in this run
{ "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": "2019-08-24", "expiration_date_range_start": "2019-08-24", "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, "drop_options": { "drop_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "program_ids": { … }, "program_restriction": "exclude", "restrict_status_reasons": true, "status_reason_ids": { … }, "training_provider_ids": { … }, "training_provider_restriction": "exclude" }, "error": "string", "error_stack": "string", "expire_applications": true, "forecast_renewals": true, "id": "string", "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "perform_drops": true, "preprocessing_date": "2019-08-24T14:15:22Z", "recurring_billing_run_id": "string", "renewal_forecasting_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "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" }, "run_date": "2019-08-24T14:15:22Z", "scheduled_preprocessing_date": "2019-08-24T14:15:22Z", "scheduled_run_date": "2019-08-24T14:15:22Z", "send_application_reminders": true, "send_renewal_reminders": true, "statistics": [ { … } ], "status": "cancelled", "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, "template_id": "string", "training_provider_billing_options": { "email_invoices_to_training_providers": true, "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "invoice_template_id": "string", "payment_terms_id": "string", "program_ids": { … }, "program_restriction": "exclude", "training_provider_ids": { … }, "training_provider_restriction": "exclude" } }
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingRuns/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The billing run was patched successfully.
If set, this billing run should activate all applications that have met all requirements
The notice to send when a renewal order is created
Determines if/how to restrict the programs in this run
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
The notice to send when a renewal order is created
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
Determines if/how to restrict the programs in this run
The date to use to filter out which memberships are candidate
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
When true, training providers should be sent invoices for training registrations
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only applications with certain status reasons will be included
If set, applications that are past their expiration date are expired
Whether this billing run should be issuing renewal forecasts
The date this billing run was actually processed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only applications with certain status reasons will be included
Determines if/how to restrict the programs in this run
The date to use to filter out which memberships are candidate
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
If set, this billing run should send out application reminders to applications missing requirements and approaching expiration
If set, this billing run should send out renewal reminders to those approaching expiration
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
If true, all contact roles that are training provider administrators will receive an email with the invoice
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
The invoice template to use to send out the training provider invoice
The payment terms to use to send out the training provider invoice
Determines if/how to restrict the programs in this run
{ "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": "2019-08-24", "expiration_date_range_start": "2019-08-24", "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, "drop_options": { "drop_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "program_ids": { … }, "program_restriction": "exclude", "restrict_status_reasons": true, "status_reason_ids": { … }, "training_provider_ids": { … }, "training_provider_restriction": "exclude" }, "error": "string", "error_stack": "string", "expire_applications": true, "forecast_renewals": true, "id": "string", "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "perform_drops": true, "preprocessing_date": "2019-08-24T14:15:22Z", "recurring_billing_run_id": "string", "renewal_forecasting_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "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" }, "run_date": "2019-08-24T14:15:22Z", "scheduled_preprocessing_date": "2019-08-24T14:15:22Z", "scheduled_run_date": "2019-08-24T14:15:22Z", "send_application_reminders": true, "send_renewal_reminders": true, "statistics": [ { … } ], "status": "cancelled", "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, "template_id": "string", "training_provider_billing_options": { "email_invoices_to_training_providers": true, "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "invoice_template_id": "string", "payment_terms_id": "string", "program_ids": { … }, "program_restriction": "exclude", "training_provider_ids": { … }, "training_provider_restriction": "exclude" } }
The updated billing run that will be saved.
If set, this billing run should activate all applications that have met all requirements
The notice to send when a renewal order is created
Determines if/how to restrict the programs in this run
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
The notice to send when a renewal order is created
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
Determines if/how to restrict the programs in this run
The date to use to filter out which memberships are candidate
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
When true, training providers should be sent invoices for training registrations
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only applications with certain status reasons will be included
If set, applications that are past their expiration date are expired
Whether this billing run should be issuing renewal forecasts
The date this billing run was actually processed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only applications with certain status reasons will be included
Determines if/how to restrict the programs in this run
The date to use to filter out which memberships are candidate
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
If set, this billing run should send out application reminders to applications missing requirements and approaching expiration
If set, this billing run should send out renewal reminders to those approaching expiration
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
If true, all contact roles that are training provider administrators will receive an email with the invoice
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
The invoice template to use to send out the training provider invoice
The payment terms to use to send out the training provider invoice
Determines if/how to restrict the programs in this run
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/billingRuns/{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": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"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": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"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,
"drop_options": {
"drop_notice_id": "string",
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"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"
},
"error": "string",
"error_stack": "string",
"expire_applications": true,
"forecast_renewals": true,
"id": "string",
"last_refresh_date": "2019-08-24T14:15:22Z",
"name": "string",
"notification_email": "string",
"perform_drops": true,
"preprocessing_date": "2019-08-24T14:15:22Z",
"recurring_billing_run_id": "string",
"renewal_forecasting_options": {
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"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": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"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"
},
"run_date": "2019-08-24T14:15:22Z",
"scheduled_preprocessing_date": "2019-08-24T14:15:22Z",
"scheduled_run_date": "2019-08-24T14:15:22Z",
"send_application_reminders": true,
"send_renewal_reminders": true,
"statistics": [
{
"action": "string",
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
}
],
"status": "cancelled",
"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,
"template_id": "string",
"training_provider_billing_options": {
"email_invoices_to_training_providers": true,
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"invoice_template_id": "string",
"payment_terms_id": "string",
"program_ids": {
"0": "string"
},
"program_restriction": "exclude",
"training_provider_ids": {
"0": "string"
},
"training_provider_restriction": "exclude"
}
}'The billing run was updated successfully.
If set, this billing run should activate all applications that have met all requirements
The notice to send when a renewal order is created
Determines if/how to restrict the programs in this run
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
The notice to send when a renewal order is created
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
Determines if/how to restrict the programs in this run
The date to use to filter out which memberships are candidate
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
When true, training providers should be sent invoices for training registrations
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only applications with certain status reasons will be included
If set, applications that are past their expiration date are expired
Whether this billing run should be issuing renewal forecasts
The date this billing run was actually processed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Determines if/how to restrict the programs in this run
If true, only applications with certain status reasons will be included
Determines if/how to restrict the programs in this run
The date to use to filter out which memberships are candidate
If true, only certain types of applications are included
If true, only applications with certain status reasons will be included
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
If set, this billing run should send out application reminders to applications missing requirements and approaching expiration
If set, this billing run should send out renewal reminders to those approaching expiration
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
If true, all contact roles that are training provider administrators will receive an email with the invoice
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
The invoice template to use to send out the training provider invoice
The payment terms to use to send out the training provider invoice
Determines if/how to restrict the programs in this run
{ "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": "2019-08-24", "expiration_date_range_start": "2019-08-24", "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, "drop_options": { "drop_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "program_ids": { … }, "program_restriction": "exclude", "restrict_status_reasons": true, "status_reason_ids": { … }, "training_provider_ids": { … }, "training_provider_restriction": "exclude" }, "error": "string", "error_stack": "string", "expire_applications": true, "forecast_renewals": true, "id": "string", "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "perform_drops": true, "preprocessing_date": "2019-08-24T14:15:22Z", "recurring_billing_run_id": "string", "renewal_forecasting_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "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" }, "run_date": "2019-08-24T14:15:22Z", "scheduled_preprocessing_date": "2019-08-24T14:15:22Z", "scheduled_run_date": "2019-08-24T14:15:22Z", "send_application_reminders": true, "send_renewal_reminders": true, "statistics": [ { … } ], "status": "cancelled", "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, "template_id": "string", "training_provider_billing_options": { "email_invoices_to_training_providers": true, "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "invoice_template_id": "string", "payment_terms_id": "string", "program_ids": { … }, "program_restriction": "exclude", "training_provider_ids": { … }, "training_provider_restriction": "exclude" } }