The Membership API provides all the capabilities for managing your membership. Although it is most commonly used to look up the membership information for a single contact or organization, it can also be used to approve, modify, or drop members.
Like most of the other Rhythm apps, the Membership 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.
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/
https://membership.api.rhythmsoftware.com/
The billing run that you would like to be saved.
The notice to send when a membership is NOT successfully renewed
The notice to send when a membership is successfully renewed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
If true, any active certifications held by this member are rendered inactive
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
If true, dropped members are renewed from any committees, including any inherited memberships
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
A unique, unchangeable reminder id
Whether this template should be generating renewal notices
Whether this template should be generating renewal orders
Whether this template should be performing auto renewals
The date this billing run was actually processed
If this was part of a recurring billing run, the ID
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
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
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether or not this should generate pro forma orders/invoices
The notice to send when a renewal order is created
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
The date to use to filter out which memberships are candidate
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
Whether this template should be generating reminders
Whether to warn that someone's card is going to expire
Whether this template should be generating reminders
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
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}
https://membership.api.rhythmsoftware.com/billingRuns/{tenantId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"auto_renewal_options": {
"auto_renewal_failure_notice_id": "string",
"auto_renewal_success_notice_id": "string",
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"status_reason_ids": {
"0": "string"
}
},
"auto_renewal_reminder_options": {
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"reminders": [
{
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"id": 0.1,
"name": "string",
"reminder_notice_id": "string"
}
],
"status_reason_ids": {
"0": "string"
}
},
"batch_id": "string",
"drop_options": {
"deactivate_certifications": true,
"drop_notice_id": "string",
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"expire_committee_memberships": true,
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"status_reason_ids": {
"0": "string"
}
},
"error": "string",
"error_stack": "string",
"expiring_credit_card_reminders_options": {
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"reminders": [
{
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"id": 0.1,
"name": "string",
"reminder_notice_id": "string"
}
],
"status_reason_ids": {
"0": "string"
}
},
"generate_renewal_notices": true,
"generate_renewal_orders": true,
"id": "string",
"last_refresh_date": "2019-08-24T14:15:22Z",
"name": "string",
"notification_email": "string",
"perform_auto_renewals": true,
"perform_drops": true,
"preprocessing_date": "2019-08-24T14:15:22Z",
"recurring_billing_run_id": "string",
"renewal_notice_options": {
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"renewal_notice_id": "string",
"status_reason_ids": {
"0": "string"
}
},
"renewal_order_options": {
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"pro_forma": true,
"renewal_order_notice_id": "string",
"status_reason_ids": {
"0": "string"
}
},
"renewal_reminder_options": {
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"reminders": [
{
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"id": 0.1,
"name": "string",
"reminder_notice_id": "string"
}
],
"status_reason_ids": {
"0": "string"
}
},
"run_date": "2019-08-24T14:15:22Z",
"scheduled_preprocessing_date": "2019-08-24T14:15:22Z",
"scheduled_run_date": "2019-08-24T14:15:22Z",
"send_auto_renewal_reminders": true,
"send_expiring_credit_card_reminders": true,
"send_renewal_reminders": true,
"statistics": {
"all_actions": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"auto_renewal_reminders": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"auto_renewals": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"drops": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"expiring_credit_card_reminders": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"renewal_notices": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"renewal_orders": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"renewal_reminders": {
"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"
}'The billing run was saved successfully.
The notice to send when a membership is NOT successfully renewed
The notice to send when a membership is successfully renewed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
If true, any active certifications held by this member are rendered inactive
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
If true, dropped members are renewed from any committees, including any inherited memberships
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
A unique, unchangeable reminder id
Whether this template should be generating renewal notices
Whether this template should be generating renewal orders
Whether this template should be performing auto renewals
The date this billing run was actually processed
If this was part of a recurring billing run, the ID
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
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
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether or not this should generate pro forma orders/invoices
The notice to send when a renewal order is created
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
The date to use to filter out which memberships are candidate
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
Whether this template should be generating reminders
Whether to warn that someone's card is going to expire
Whether this template should be generating reminders
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
{ "auto_renewal_options": { "auto_renewal_failure_notice_id": "string", "auto_renewal_success_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "status_reason_ids": { … } }, "auto_renewal_reminder_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "batch_id": "string", "drop_options": { "deactivate_certifications": true, "drop_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "expire_committee_memberships": true, "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "status_reason_ids": { … } }, "error": "string", "error_stack": "string", "expiring_credit_card_reminders_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "generate_renewal_notices": true, "generate_renewal_orders": true, "id": "string", "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "perform_auto_renewals": true, "perform_drops": true, "preprocessing_date": "2019-08-24T14:15:22Z", "recurring_billing_run_id": "string", "renewal_notice_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "renewal_notice_id": "string", "status_reason_ids": { … } }, "renewal_order_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "pro_forma": true, "renewal_order_notice_id": "string", "status_reason_ids": { … } }, "renewal_reminder_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "run_date": "2019-08-24T14:15:22Z", "scheduled_preprocessing_date": "2019-08-24T14:15:22Z", "scheduled_run_date": "2019-08-24T14:15:22Z", "send_auto_renewal_reminders": true, "send_expiring_credit_card_reminders": true, "send_renewal_reminders": true, "statistics": { "all_actions": { … }, "auto_renewal_reminders": { … }, "auto_renewals": { … }, "drops": { … }, "expiring_credit_card_reminders": { … }, "renewal_notices": { … }, "renewal_orders": { … }, "renewal_reminders": { … } }, "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" }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/batch
https://membership.api.rhythmsoftware.com/billingRuns/{tenantId}/batch
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-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 }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}
https://membership.api.rhythmsoftware.com/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The records were retrieved successfully
The notice to send when a membership is NOT successfully renewed
The notice to send when a membership is successfully renewed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
If true, any active certifications held by this member are rendered inactive
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
If true, dropped members are renewed from any committees, including any inherited memberships
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
A unique, unchangeable reminder id
Whether this template should be generating renewal notices
Whether this template should be generating renewal orders
Whether this template should be performing auto renewals
The date this billing run was actually processed
If this was part of a recurring billing run, the ID
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
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
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether or not this should generate pro forma orders/invoices
The notice to send when a renewal order is created
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
The date to use to filter out which memberships are candidate
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
Whether this template should be generating reminders
Whether to warn that someone's card is going to expire
Whether this template should be generating reminders
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
{ "auto_renewal_options": { "auto_renewal_failure_notice_id": "string", "auto_renewal_success_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "status_reason_ids": { … } }, "auto_renewal_reminder_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "batch_id": "string", "drop_options": { "deactivate_certifications": true, "drop_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "expire_committee_memberships": true, "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "status_reason_ids": { … } }, "error": "string", "error_stack": "string", "expiring_credit_card_reminders_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "generate_renewal_notices": true, "generate_renewal_orders": true, "id": "string", "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "perform_auto_renewals": true, "perform_drops": true, "preprocessing_date": "2019-08-24T14:15:22Z", "recurring_billing_run_id": "string", "renewal_notice_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "renewal_notice_id": "string", "status_reason_ids": { … } }, "renewal_order_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "pro_forma": true, "renewal_order_notice_id": "string", "status_reason_ids": { … } }, "renewal_reminder_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "run_date": "2019-08-24T14:15:22Z", "scheduled_preprocessing_date": "2019-08-24T14:15:22Z", "scheduled_run_date": "2019-08-24T14:15:22Z", "send_auto_renewal_reminders": true, "send_expiring_credit_card_reminders": true, "send_renewal_reminders": true, "statistics": { "all_actions": { … }, "auto_renewal_reminders": { … }, "auto_renewals": { … }, "drops": { … }, "expiring_credit_card_reminders": { … }, "renewal_notices": { … }, "renewal_orders": { … }, "renewal_reminders": { … } }, "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" }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}
https://membership.api.rhythmsoftware.com/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/refresh/{id}
https://membership.api.rhythmsoftware.com/billingRuns/{tenantId}/refresh/{id}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-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" }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/search
https://membership.api.rhythmsoftware.com/billingRuns/{tenantId}/search
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"generate_renewal_notices": [
true
],
"generate_renewal_orders": [
true
],
"ids": [
"string"
],
"name": "string",
"perform_auto_renewals": [
true
],
"perform_drops": [
true
],
"run_date": [
"string",
"string"
],
"scheduled_run_date": [
"string",
"string"
],
"send_auto_renewal_reminders": [
true
],
"send_expiring_credit_card_reminders": [
true
],
"send_renewal_reminders": [
true
],
"status": [
"string"
]
}'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/{id}
https://membership.api.rhythmsoftware.com/billingRuns/{tenantId}/{id}
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/{id}
https://membership.api.rhythmsoftware.com/billingRuns/{tenantId}/{id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The billing run was retrieved successfully.
The notice to send when a membership is NOT successfully renewed
The notice to send when a membership is successfully renewed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
If true, any active certifications held by this member are rendered inactive
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
If true, dropped members are renewed from any committees, including any inherited memberships
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
A unique, unchangeable reminder id
Whether this template should be generating renewal notices
Whether this template should be generating renewal orders
Whether this template should be performing auto renewals
The date this billing run was actually processed
If this was part of a recurring billing run, the ID
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
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
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether or not this should generate pro forma orders/invoices
The notice to send when a renewal order is created
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
The date to use to filter out which memberships are candidate
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
Whether this template should be generating reminders
Whether to warn that someone's card is going to expire
Whether this template should be generating reminders
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
{ "auto_renewal_options": { "auto_renewal_failure_notice_id": "string", "auto_renewal_success_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "status_reason_ids": { … } }, "auto_renewal_reminder_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "batch_id": "string", "drop_options": { "deactivate_certifications": true, "drop_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "expire_committee_memberships": true, "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "status_reason_ids": { … } }, "error": "string", "error_stack": "string", "expiring_credit_card_reminders_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "generate_renewal_notices": true, "generate_renewal_orders": true, "id": "string", "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "perform_auto_renewals": true, "perform_drops": true, "preprocessing_date": "2019-08-24T14:15:22Z", "recurring_billing_run_id": "string", "renewal_notice_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "renewal_notice_id": "string", "status_reason_ids": { … } }, "renewal_order_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "pro_forma": true, "renewal_order_notice_id": "string", "status_reason_ids": { … } }, "renewal_reminder_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "run_date": "2019-08-24T14:15:22Z", "scheduled_preprocessing_date": "2019-08-24T14:15:22Z", "scheduled_run_date": "2019-08-24T14:15:22Z", "send_auto_renewal_reminders": true, "send_expiring_credit_card_reminders": true, "send_renewal_reminders": true, "statistics": { "all_actions": { … }, "auto_renewal_reminders": { … }, "auto_renewals": { … }, "drops": { … }, "expiring_credit_card_reminders": { … }, "renewal_notices": { … }, "renewal_orders": { … }, "renewal_reminders": { … } }, "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" }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/{id}
https://membership.api.rhythmsoftware.com/billingRuns/{tenantId}/{id}
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-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.
The notice to send when a membership is NOT successfully renewed
The notice to send when a membership is successfully renewed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
If true, any active certifications held by this member are rendered inactive
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
If true, dropped members are renewed from any committees, including any inherited memberships
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
A unique, unchangeable reminder id
Whether this template should be generating renewal notices
Whether this template should be generating renewal orders
Whether this template should be performing auto renewals
The date this billing run was actually processed
If this was part of a recurring billing run, the ID
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
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
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether or not this should generate pro forma orders/invoices
The notice to send when a renewal order is created
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
The date to use to filter out which memberships are candidate
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
Whether this template should be generating reminders
Whether to warn that someone's card is going to expire
Whether this template should be generating reminders
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
{ "auto_renewal_options": { "auto_renewal_failure_notice_id": "string", "auto_renewal_success_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "status_reason_ids": { … } }, "auto_renewal_reminder_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "batch_id": "string", "drop_options": { "deactivate_certifications": true, "drop_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "expire_committee_memberships": true, "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "status_reason_ids": { … } }, "error": "string", "error_stack": "string", "expiring_credit_card_reminders_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "generate_renewal_notices": true, "generate_renewal_orders": true, "id": "string", "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "perform_auto_renewals": true, "perform_drops": true, "preprocessing_date": "2019-08-24T14:15:22Z", "recurring_billing_run_id": "string", "renewal_notice_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "renewal_notice_id": "string", "status_reason_ids": { … } }, "renewal_order_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "pro_forma": true, "renewal_order_notice_id": "string", "status_reason_ids": { … } }, "renewal_reminder_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "run_date": "2019-08-24T14:15:22Z", "scheduled_preprocessing_date": "2019-08-24T14:15:22Z", "scheduled_run_date": "2019-08-24T14:15:22Z", "send_auto_renewal_reminders": true, "send_expiring_credit_card_reminders": true, "send_renewal_reminders": true, "statistics": { "all_actions": { … }, "auto_renewal_reminders": { … }, "auto_renewals": { … }, "drops": { … }, "expiring_credit_card_reminders": { … }, "renewal_notices": { … }, "renewal_orders": { … }, "renewal_reminders": { … } }, "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" }
The updated billing run that will be saved.
The notice to send when a membership is NOT successfully renewed
The notice to send when a membership is successfully renewed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
If true, any active certifications held by this member are rendered inactive
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
If true, dropped members are renewed from any committees, including any inherited memberships
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
A unique, unchangeable reminder id
Whether this template should be generating renewal notices
Whether this template should be generating renewal orders
Whether this template should be performing auto renewals
The date this billing run was actually processed
If this was part of a recurring billing run, the ID
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
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
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether or not this should generate pro forma orders/invoices
The notice to send when a renewal order is created
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
The date to use to filter out which memberships are candidate
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
Whether this template should be generating reminders
Whether to warn that someone's card is going to expire
Whether this template should be generating reminders
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
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/{id}
https://membership.api.rhythmsoftware.com/billingRuns/{tenantId}/{id}
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/billingRuns/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"auto_renewal_options": {
"auto_renewal_failure_notice_id": "string",
"auto_renewal_success_notice_id": "string",
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"status_reason_ids": {
"0": "string"
}
},
"auto_renewal_reminder_options": {
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"reminders": [
{
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"id": 0.1,
"name": "string",
"reminder_notice_id": "string"
}
],
"status_reason_ids": {
"0": "string"
}
},
"batch_id": "string",
"drop_options": {
"deactivate_certifications": true,
"drop_notice_id": "string",
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"expire_committee_memberships": true,
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"status_reason_ids": {
"0": "string"
}
},
"error": "string",
"error_stack": "string",
"expiring_credit_card_reminders_options": {
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"reminders": [
{
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"id": 0.1,
"name": "string",
"reminder_notice_id": "string"
}
],
"status_reason_ids": {
"0": "string"
}
},
"generate_renewal_notices": true,
"generate_renewal_orders": true,
"id": "string",
"last_refresh_date": "2019-08-24T14:15:22Z",
"name": "string",
"notification_email": "string",
"perform_auto_renewals": true,
"perform_drops": true,
"preprocessing_date": "2019-08-24T14:15:22Z",
"recurring_billing_run_id": "string",
"renewal_notice_options": {
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"renewal_notice_id": "string",
"status_reason_ids": {
"0": "string"
}
},
"renewal_order_options": {
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"pro_forma": true,
"renewal_order_notice_id": "string",
"status_reason_ids": {
"0": "string"
}
},
"renewal_reminder_options": {
"include_only_certain_membership_packages": true,
"include_only_certain_membership_types": true,
"include_only_certain_status_reasons": true,
"membership_package_ids": {
"0": "string"
},
"membership_type_ids": {
"0": "string"
},
"new_status_reason_id": "string",
"reminders": [
{
"expiration_date_range_end": "2019-08-24",
"expiration_date_range_start": "2019-08-24",
"id": 0.1,
"name": "string",
"reminder_notice_id": "string"
}
],
"status_reason_ids": {
"0": "string"
}
},
"run_date": "2019-08-24T14:15:22Z",
"scheduled_preprocessing_date": "2019-08-24T14:15:22Z",
"scheduled_run_date": "2019-08-24T14:15:22Z",
"send_auto_renewal_reminders": true,
"send_expiring_credit_card_reminders": true,
"send_renewal_reminders": true,
"statistics": {
"all_actions": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"auto_renewal_reminders": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"auto_renewals": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"drops": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"expiring_credit_card_reminders": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"renewal_notices": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"renewal_orders": {
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
},
"renewal_reminders": {
"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"
}'The billing run was updated successfully.
The notice to send when a membership is NOT successfully renewed
The notice to send when a membership is successfully renewed
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
If true, any active certifications held by this member are rendered inactive
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
If true, dropped members are renewed from any committees, including any inherited memberships
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Change the status reason
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
A unique, unchangeable reminder id
Whether this template should be generating renewal notices
Whether this template should be generating renewal orders
Whether this template should be performing auto renewals
The date this billing run was actually processed
If this was part of a recurring billing run, the ID
The date to use to filter out which memberships are candidate
The date to use to filter out which memberships are candidate
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
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
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
Whether or not this should generate pro forma orders/invoices
The notice to send when a renewal order is created
Whether the process should apply only to certain member packages
Whether the process should apply only to certain member types
Whether the process should apply only to certain member status reasons
The date to use to filter out which memberships are candidate
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
Whether this template should be generating reminders
Whether to warn that someone's card is going to expire
Whether this template should be generating reminders
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
{ "auto_renewal_options": { "auto_renewal_failure_notice_id": "string", "auto_renewal_success_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "status_reason_ids": { … } }, "auto_renewal_reminder_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "batch_id": "string", "drop_options": { "deactivate_certifications": true, "drop_notice_id": "string", "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "expire_committee_memberships": true, "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "status_reason_ids": { … } }, "error": "string", "error_stack": "string", "expiring_credit_card_reminders_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "generate_renewal_notices": true, "generate_renewal_orders": true, "id": "string", "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "perform_auto_renewals": true, "perform_drops": true, "preprocessing_date": "2019-08-24T14:15:22Z", "recurring_billing_run_id": "string", "renewal_notice_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "renewal_notice_id": "string", "status_reason_ids": { … } }, "renewal_order_options": { "expiration_date_range_end": "2019-08-24", "expiration_date_range_start": "2019-08-24", "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "pro_forma": true, "renewal_order_notice_id": "string", "status_reason_ids": { … } }, "renewal_reminder_options": { "include_only_certain_membership_packages": true, "include_only_certain_membership_types": true, "include_only_certain_status_reasons": true, "membership_package_ids": { … }, "membership_type_ids": { … }, "new_status_reason_id": "string", "reminders": [ … ], "status_reason_ids": { … } }, "run_date": "2019-08-24T14:15:22Z", "scheduled_preprocessing_date": "2019-08-24T14:15:22Z", "scheduled_run_date": "2019-08-24T14:15:22Z", "send_auto_renewal_reminders": true, "send_expiring_credit_card_reminders": true, "send_renewal_reminders": true, "statistics": { "all_actions": { … }, "auto_renewal_reminders": { … }, "auto_renewals": { … }, "drops": { … }, "expiring_credit_card_reminders": { … }, "renewal_notices": { … }, "renewal_orders": { … }, "renewal_reminders": { … } }, "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" }