Billing Runs

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

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The billing run that you would like to be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this billing run
name required	string (Name) The name of the billing run
status required	string (Status) Enum: "draft" "scheduled" "preprocessing" "scheduled for execution" "ready for execution" "running" "completed" "timed out" "cancelled" "error"
notification_email	string (Notification Email) Te address to send notifications
error	string (Error) The error message
error_stack	string (Error Stack) The error stack
recurring_billing_run_id	string (Recurring Billing Run) If this was part of a recurring billing run, the ID
batch_id	string (Batch) The batch to use
scheduled_preprocessing_date	string <date-time> (Scheduled Preprocessing Date) The date which this billing run should be preprocessed
preprocessing_date	string <date-time> (Preprocessing Date) The date this billing run was actually processed
scheduled_run_date	string <date-time> (Scheduled Run Date) The date the billing run is scheduled for execution
run_date	string <date-time> (Run Date) The date of the billing run
last_refresh_date	string <date-time> (Last Refresh Date) The last time the billing run was refreshed
template_id	string (Template) The id of the template that generated this billing run
	object (Statistics)
generate_renewal_orders	boolean (Generate Renewal Orders) Whether this template should be generating renewal orders
required	object (Renewal Order Options)
perform_auto_renewals	boolean (Perform Auto Renewals) Whether this template should be performing auto renewals
required	object (Auto Renewal Options)
generate_renewal_notices	boolean (Generate Renewal Notices) Whether this template should be generating renewal notices
required	object (Renewal Notice Options)
send_renewal_reminders	boolean (Send Renewal Reminders) Whether this template should be generating reminders
required	object (Renewal Reminder Options)
send_auto_renewal_reminders	boolean (Send Auto Renewal Reminders) Whether this template should be generating reminders
required	object (Auto Renewal Reminder Options)
perform_drops	boolean (Perform Drops) Whether this template should be dropping expired members
required	object (Drop Options)
send_expiring_credit_card_reminders	boolean (Send Expiring Credit Card Reminders) Whether to warn that someone's card is going to expire
required	object (Expiring Credit Card Reminders Options)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (Sys Bulk Load Pk) If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
sys_bulk_load_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (Sys Last Bulk Data Operation) If this record was last touched by a bulk data operation, the ID of that operation
sys_last_bulk_data_operation_sys_version	string (Sys Last Bulk Data Operation Sys Version) If this record was last touched by a bulk data operation, the sys_version at the time of that operation
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <float> (Sys Snapshot Base Version) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
sys_has_files_in_s3	boolean (Sys Has Files In S3) If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
sys_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The billing run was saved successfully.

400The billing run you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The billing run could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add billing run based on tenant limits.

500General server error.

post/billingRuns/{tenantId}

Request samples

application/json

{"id": "string",
"name": "string",
"status": "draft",
"notification_email": "string",
"error": "string",
"error_stack": "string",
"recurring_billing_run_id": "string",
"batch_id": "string",
"scheduled_preprocessing_date": "2019-08-24T14:15:22Z",
"preprocessing_date": "2019-08-24T14:15:22Z",
"scheduled_run_date": "2019-08-24T14:15:22Z",
"run_date": "2019-08-24T14:15:22Z",
"last_refresh_date": "2019-08-24T14:15:22Z",
"template_id": "string",
"statistics": {"renewal_orders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewals": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_notices": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"drops": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"expiring_credit_card_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"all_actions": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
}
},
"generate_renewal_orders": true,
"renewal_order_options": {"pro_forma": true,
"renewal_order_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"perform_auto_renewals": true,
"auto_renewal_options": {"auto_renewal_success_notice_id": "string",
"auto_renewal_failure_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"generate_renewal_notices": true,
"renewal_notice_options": {"renewal_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_renewal_reminders": true,
"renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"send_auto_renewal_reminders": true,
"auto_renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"perform_drops": true,
"drop_options": {"drop_notice_id": "string",
"expire_committee_memberships": true,
"deactivate_certifications": true,
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_expiring_credit_card_reminders": true,
"expiring_credit_card_reminders_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"name": "string",
"status": "draft",
"notification_email": "string",
"error": "string",
"error_stack": "string",
"recurring_billing_run_id": "string",
"batch_id": "string",
"scheduled_preprocessing_date": "2019-08-24T14:15:22Z",
"preprocessing_date": "2019-08-24T14:15:22Z",
"scheduled_run_date": "2019-08-24T14:15:22Z",
"run_date": "2019-08-24T14:15:22Z",
"last_refresh_date": "2019-08-24T14:15:22Z",
"template_id": "string",
"statistics": {"renewal_orders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewals": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_notices": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"drops": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"expiring_credit_card_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"all_actions": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
}
},
"generate_renewal_orders": true,
"renewal_order_options": {"pro_forma": true,
"renewal_order_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"perform_auto_renewals": true,
"auto_renewal_options": {"auto_renewal_success_notice_id": "string",
"auto_renewal_failure_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"generate_renewal_notices": true,
"renewal_notice_options": {"renewal_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_renewal_reminders": true,
"renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"send_auto_renewal_reminders": true,
"auto_renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"perform_drops": true,
"drop_options": {"drop_notice_id": "string",
"expire_committee_memberships": true,
"deactivate_certifications": true,
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_expiring_credit_card_reminders": true,
"expiring_credit_card_reminders_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a billing run from the system by its ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the billing run to return.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The billing run was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The billing run could not be found.

429Limit exceeded... unable to retrieve billing run based on tenant limits.

500General server error.

get/billingRuns/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/billingRuns/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"name": "string",
"status": "draft",
"notification_email": "string",
"error": "string",
"error_stack": "string",
"recurring_billing_run_id": "string",
"batch_id": "string",
"scheduled_preprocessing_date": "2019-08-24T14:15:22Z",
"preprocessing_date": "2019-08-24T14:15:22Z",
"scheduled_run_date": "2019-08-24T14:15:22Z",
"run_date": "2019-08-24T14:15:22Z",
"last_refresh_date": "2019-08-24T14:15:22Z",
"template_id": "string",
"statistics": {"renewal_orders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewals": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_notices": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"drops": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"expiring_credit_card_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"all_actions": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
}
},
"generate_renewal_orders": true,
"renewal_order_options": {"pro_forma": true,
"renewal_order_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"perform_auto_renewals": true,
"auto_renewal_options": {"auto_renewal_success_notice_id": "string",
"auto_renewal_failure_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"generate_renewal_notices": true,
"renewal_notice_options": {"renewal_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_renewal_reminders": true,
"renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"send_auto_renewal_reminders": true,
"auto_renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"perform_drops": true,
"drop_options": {"drop_notice_id": "string",
"expire_committee_memberships": true,
"deactivate_certifications": true,
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_expiring_credit_card_reminders": true,
"expiring_credit_card_reminders_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Updates a billing run with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the billing run to update.

Request Body schema: application/json

The updated billing run that will be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this billing run
name required	string (Name) The name of the billing run
status required	string (Status) Enum: "draft" "scheduled" "preprocessing" "scheduled for execution" "ready for execution" "running" "completed" "timed out" "cancelled" "error"
notification_email	string (Notification Email) Te address to send notifications
error	string (Error) The error message
error_stack	string (Error Stack) The error stack
recurring_billing_run_id	string (Recurring Billing Run) If this was part of a recurring billing run, the ID
batch_id	string (Batch) The batch to use
scheduled_preprocessing_date	string <date-time> (Scheduled Preprocessing Date) The date which this billing run should be preprocessed
preprocessing_date	string <date-time> (Preprocessing Date) The date this billing run was actually processed
scheduled_run_date	string <date-time> (Scheduled Run Date) The date the billing run is scheduled for execution
run_date	string <date-time> (Run Date) The date of the billing run
last_refresh_date	string <date-time> (Last Refresh Date) The last time the billing run was refreshed
template_id	string (Template) The id of the template that generated this billing run
	object (Statistics)
generate_renewal_orders	boolean (Generate Renewal Orders) Whether this template should be generating renewal orders
required	object (Renewal Order Options)
perform_auto_renewals	boolean (Perform Auto Renewals) Whether this template should be performing auto renewals
required	object (Auto Renewal Options)
generate_renewal_notices	boolean (Generate Renewal Notices) Whether this template should be generating renewal notices
required	object (Renewal Notice Options)
send_renewal_reminders	boolean (Send Renewal Reminders) Whether this template should be generating reminders
required	object (Renewal Reminder Options)
send_auto_renewal_reminders	boolean (Send Auto Renewal Reminders) Whether this template should be generating reminders
required	object (Auto Renewal Reminder Options)
perform_drops	boolean (Perform Drops) Whether this template should be dropping expired members
required	object (Drop Options)
send_expiring_credit_card_reminders	boolean (Send Expiring Credit Card Reminders) Whether to warn that someone's card is going to expire
required	object (Expiring Credit Card Reminders Options)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (Sys Bulk Load Pk) If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
sys_bulk_load_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (Sys Last Bulk Data Operation) If this record was last touched by a bulk data operation, the ID of that operation
sys_last_bulk_data_operation_sys_version	string (Sys Last Bulk Data Operation Sys Version) If this record was last touched by a bulk data operation, the sys_version at the time of that operation
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <float> (Sys Snapshot Base Version) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
sys_has_files_in_s3	boolean (Sys Has Files In S3) If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
sys_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The billing run was updated successfully.

400The billing run supplied was not valid.

401Unauthorized.

403Forbidden.

404The billing run could not be found.

409The billing run could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve billing run based on tenant limits.

500General server error.

put/billingRuns/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"name": "string",
"status": "draft",
"notification_email": "string",
"error": "string",
"error_stack": "string",
"recurring_billing_run_id": "string",
"batch_id": "string",
"scheduled_preprocessing_date": "2019-08-24T14:15:22Z",
"preprocessing_date": "2019-08-24T14:15:22Z",
"scheduled_run_date": "2019-08-24T14:15:22Z",
"run_date": "2019-08-24T14:15:22Z",
"last_refresh_date": "2019-08-24T14:15:22Z",
"template_id": "string",
"statistics": {"renewal_orders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewals": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_notices": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"drops": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"expiring_credit_card_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"all_actions": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
}
},
"generate_renewal_orders": true,
"renewal_order_options": {"pro_forma": true,
"renewal_order_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"perform_auto_renewals": true,
"auto_renewal_options": {"auto_renewal_success_notice_id": "string",
"auto_renewal_failure_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"generate_renewal_notices": true,
"renewal_notice_options": {"renewal_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_renewal_reminders": true,
"renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"send_auto_renewal_reminders": true,
"auto_renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"perform_drops": true,
"drop_options": {"drop_notice_id": "string",
"expire_committee_memberships": true,
"deactivate_certifications": true,
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_expiring_credit_card_reminders": true,
"expiring_credit_card_reminders_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"name": "string",
"status": "draft",
"notification_email": "string",
"error": "string",
"error_stack": "string",
"recurring_billing_run_id": "string",
"batch_id": "string",
"scheduled_preprocessing_date": "2019-08-24T14:15:22Z",
"preprocessing_date": "2019-08-24T14:15:22Z",
"scheduled_run_date": "2019-08-24T14:15:22Z",
"run_date": "2019-08-24T14:15:22Z",
"last_refresh_date": "2019-08-24T14:15:22Z",
"template_id": "string",
"statistics": {"renewal_orders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewals": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_notices": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"drops": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"expiring_credit_card_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"all_actions": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
}
},
"generate_renewal_orders": true,
"renewal_order_options": {"pro_forma": true,
"renewal_order_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"perform_auto_renewals": true,
"auto_renewal_options": {"auto_renewal_success_notice_id": "string",
"auto_renewal_failure_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"generate_renewal_notices": true,
"renewal_notice_options": {"renewal_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_renewal_reminders": true,
"renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"send_auto_renewal_reminders": true,
"auto_renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"perform_drops": true,
"drop_options": {"drop_notice_id": "string",
"expire_committee_memberships": true,
"deactivate_certifications": true,
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_expiring_credit_card_reminders": true,
"expiring_credit_card_reminders_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Partially updates a billing run with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the billing run to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array

op required	string (Op) The operation Enum: "add" "remove" "replace" "move" "copy" "test"
path required	string (Path) The JSON path
value	string (Value) The updated value

Responses

200The billing run was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The billing run could not be found.

409The billing run could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve billing run based on tenant limits.

500General server error.

patch/billingRuns/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"name": "string",
"status": "draft",
"notification_email": "string",
"error": "string",
"error_stack": "string",
"recurring_billing_run_id": "string",
"batch_id": "string",
"scheduled_preprocessing_date": "2019-08-24T14:15:22Z",
"preprocessing_date": "2019-08-24T14:15:22Z",
"scheduled_run_date": "2019-08-24T14:15:22Z",
"run_date": "2019-08-24T14:15:22Z",
"last_refresh_date": "2019-08-24T14:15:22Z",
"template_id": "string",
"statistics": {"renewal_orders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewals": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_notices": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"drops": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"expiring_credit_card_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"all_actions": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
}
},
"generate_renewal_orders": true,
"renewal_order_options": {"pro_forma": true,
"renewal_order_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"perform_auto_renewals": true,
"auto_renewal_options": {"auto_renewal_success_notice_id": "string",
"auto_renewal_failure_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"generate_renewal_notices": true,
"renewal_notice_options": {"renewal_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_renewal_reminders": true,
"renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"send_auto_renewal_reminders": true,
"auto_renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"perform_drops": true,
"drop_options": {"drop_notice_id": "string",
"expire_committee_memberships": true,
"deactivate_certifications": true,
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_expiring_credit_card_reminders": true,
"expiring_credit_card_reminders_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a billing run from the system by its ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the billing run to delete.

Responses

200The billing run was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The billing run could not be found.

409The billing run could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete billing run based on tenant limits.

500General server error.

delete/billingRuns/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://membership.api.756794052567.rhythmsoftware.com/billingRuns/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

Searches for billing runs using predefined parameters

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

exclusiveStartKey	string The start key for the search, for paging support
fieldsToReturn	string The fields that you want to retrieve; if omitted, the entire object is returned

Request Body schema: application/json

The billing run that you would like to be saved.

ids	Array of strings (Ids) IDs to search
name	string (Name)
run_date	Array of strings (Run Date) 2 items
scheduled_run_date	Array of strings (Scheduled Run Date) 2 items
status	Array of strings (Status)
generate_renewal_orders	Array of booleans (Generate Renewal Orders)
perform_auto_renewals	Array of booleans (Perform Auto Renewals)
generate_renewal_notices	Array of booleans (Generate Renewal Notices)
send_renewal_reminders	Array of booleans (Send Renewal Reminders)
send_auto_renewal_reminders	Array of booleans (Send Auto Renewal Reminders)
perform_drops	Array of booleans (Perform Drops)
send_expiring_credit_card_reminders	Array of booleans (Send Expiring Credit Card Reminders)

Responses

200The billing run search was saved successfully.

400The billing run you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The billing run could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add billing run based on tenant limits.

500General server error.

post/billingRuns/{tenantId}/search

Request samples

application/json

{"ids": ["string"
],
"name": "string",
"run_date": ["string",
"string"
],
"scheduled_run_date": ["string",
"string"
],
"status": ["string"
],
"generate_renewal_orders": [true
],
"perform_auto_renewals": [true
],
"generate_renewal_notices": [true
],
"send_renewal_reminders": [true
],
"send_auto_renewal_reminders": [true
],
"perform_drops": [true
],
"send_expiring_credit_card_reminders": [true
]
}

Response samples

application/json

{"Items": [{"ids": ["string"
],
"name": "string",
"run_date": "string",
"scheduled_run_date": "string",
"status": "string",
"generate_renewal_orders": true,
"perform_auto_renewals": true,
"generate_renewal_notices": true,
"send_renewal_reminders": true,
"send_auto_renewal_reminders": true,
"perform_drops": true,
"send_expiring_credit_card_reminders": true
}
],
"LastEvaluatedKey": "string"
}

Generates a billing run from a template

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
templateId required	string The template
referenceDate required	string The reference date

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  https://membership.api.756794052567.rhythmsoftware.com/billingRuns/:tenantId/fromTemplate/:templateId/:referenceDate \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"name": "string",
"status": "draft",
"notification_email": "string",
"error": "string",
"error_stack": "string",
"recurring_billing_run_id": "string",
"batch_id": "string",
"scheduled_preprocessing_date": "2019-08-24T14:15:22Z",
"preprocessing_date": "2019-08-24T14:15:22Z",
"scheduled_run_date": "2019-08-24T14:15:22Z",
"run_date": "2019-08-24T14:15:22Z",
"last_refresh_date": "2019-08-24T14:15:22Z",
"template_id": "string",
"statistics": {"renewal_orders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewals": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_notices": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"drops": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"expiring_credit_card_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"all_actions": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
}
},
"generate_renewal_orders": true,
"renewal_order_options": {"pro_forma": true,
"renewal_order_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"perform_auto_renewals": true,
"auto_renewal_options": {"auto_renewal_success_notice_id": "string",
"auto_renewal_failure_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"generate_renewal_notices": true,
"renewal_notice_options": {"renewal_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_renewal_reminders": true,
"renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"send_auto_renewal_reminders": true,
"auto_renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"perform_drops": true,
"drop_options": {"drop_notice_id": "string",
"expire_committee_memberships": true,
"deactivate_certifications": true,
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_expiring_credit_card_reminders": true,
"expiring_credit_card_reminders_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Refreshes a billing run

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
id required	string The billing_run_id to use to refresh

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

post/billingRuns/{tenantId}/refresh/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X POST \
  https://membership.api.756794052567.rhythmsoftware.com/billingRuns/:tenantId/refresh/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"notification_publishKey": "string",
"notification_subscribeKey": "string",
"notification_channel": "string",
"executionArn": "string",
"start_date": "2019-08-24T14:15:22Z"
}

Returns a list of records with the specified recurring_billing_run_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
recurring_billing_run_id required	string The recurring_billing_run_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/billingRuns/:tenantId/recurringBillingRun/:recurring_billing_run_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"name": "string",
"status": "draft",
"notification_email": "string",
"error": "string",
"error_stack": "string",
"recurring_billing_run_id": "string",
"batch_id": "string",
"scheduled_preprocessing_date": "2019-08-24T14:15:22Z",
"preprocessing_date": "2019-08-24T14:15:22Z",
"scheduled_run_date": "2019-08-24T14:15:22Z",
"run_date": "2019-08-24T14:15:22Z",
"last_refresh_date": "2019-08-24T14:15:22Z",
"template_id": "string",
"statistics": {"renewal_orders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewals": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_notices": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"auto_renewal_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"drops": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"expiring_credit_card_reminders": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
},
"all_actions": {"pending": 0,
"processing": 0,
"successful": 0,
"error": 0,
"excluded": 0,
"total": 0
}
},
"generate_renewal_orders": true,
"renewal_order_options": {"pro_forma": true,
"renewal_order_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"perform_auto_renewals": true,
"auto_renewal_options": {"auto_renewal_success_notice_id": "string",
"auto_renewal_failure_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"generate_renewal_notices": true,
"renewal_notice_options": {"renewal_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_renewal_reminders": true,
"renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"send_auto_renewal_reminders": true,
"auto_renewal_reminder_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"perform_drops": true,
"drop_options": {"drop_notice_id": "string",
"expire_committee_memberships": true,
"deactivate_certifications": true,
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24",
"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string"
},
"send_expiring_credit_card_reminders": true,
"expiring_credit_card_reminders_options": {"include_only_certain_membership_types": true,
"membership_type_ids": ["string"
],
"include_only_certain_membership_packages": true,
"membership_package_ids": ["string"
],
"include_only_certain_status_reasons": true,
"status_reason_ids": ["string"
],
"new_status_reason_id": "string",
"reminders": [{"id": 0,
"name": "string",
"reminder_notice_id": "string",
"expiration_date_range_start": "2019-08-24",
"expiration_date_range_end": "2019-08-24"
}
]
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Execute Batch Operations

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects

Responses

200Request completed successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The billing run could not be found.

429Limit exceeded... unable to retrieve billing run based on tenant limits.

500General server error.

post/billingRuns/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { }
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}