The Finance, or Collect, API provides all the accounts receivable capabilities in Rhythm. This includes all aspects of Invoices, Credits, Payments, Credit Memos, and Debit Memos. Additionally, this API manages Batches and Fiscal Periods and can be used to download batches for import into your accounting package.
Like most of the other Rhythm apps, the Collect 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/collect/collect-v1/
https://collect.api.rhythmsoftware.com/
The billing run that you would like to be saved.
If set, reminders are sent to those who have failed installments
Date used to filter out schedules to cancel
Date used to filter out schedules to cancel
The notice to send to the customer
Determines if/how to restrict the type of orders to
Determines if/how to restrict the type of invoices to
Date used to filter out schedules to bill
Date used to filter out schedules to bill
If true, the normal payment/order confirmations are not sent
The notice to send if processing is unsuccessful
Determines if/how to restrict the type of orders to
Determines if/how to restrict the type of invoices to
Determines if/how to restrict the type of orders to
The date this billing run was actually processed
If set, installment schedules should be processed
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
If set, reminders are sent to those whose credit cards are about to expire
If set, reminders are to customers who own installment schedules suspended due to payment error
If set, statements are generated for those who have open invoices
Determines if/how to restrict the type of invoices to
The type of customer for whom statements should be generated
Determines if/how to restrict the type of orders to
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/collect/collect-v1/billingRuns/{tenantId}
https://collect.api.rhythmsoftware.com/billingRuns/{tenantId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"business_unit_id": "string",
"cancel_installment_schedules": true,
"error": "string",
"error_stack": "string",
"expiring_credit_card_reminder_options": {
"order_type_restriction": "exclude",
"order_types": {
"0": "string"
},
"reminders": [
{
"card_expiration_date_end": "string",
"card_expiration_date_start": "string",
"id": 0.1,
"name": "string",
"notice_id": "string"
}
]
},
"id": "string",
"installment_schedule_cancellation_options": {
"date_range_end": "string",
"date_range_start": "string",
"notice_id": "string",
"order_type_restriction": "exclude",
"order_types": {
"0": "string"
}
},
"installment_schedule_options": {
"card_type_restriction": "exclude",
"card_types": {
"0": "american express"
},
"date_range_end": "string",
"date_range_start": "string",
"do_not_send_standard_email_confirmations": true,
"failure_notice_id": "string",
"order_type_restriction": "exclude",
"order_types": {
"0": "string"
},
"payment_type_restriction": "exclude",
"payment_types": {
"0": "credit card"
},
"success_notice_id": "string"
},
"installment_schedule_reminder_options": {
"order_type_restriction": "exclude",
"order_types": {
"0": "string"
},
"reminders": [
{
"date_range_end": "string",
"date_range_start": "string",
"id": 0.1,
"name": "string",
"notice_id": "string"
}
]
},
"last_refresh_date": "2019-08-24T14:15:22Z",
"name": "string",
"notification_email": "string",
"preprocessing_date": "2019-08-24T14:15:22Z",
"process_installment_schedules": true,
"recurring_billing_run_id": "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_expiring_credit_card_reminders": true,
"send_installment_schedule_reminders": true,
"send_statements": true,
"statement_options": {
"business_unit_ids": {
"0": "string"
},
"business_unit_restriction": "exclude",
"customer_type": "both",
"order_type_restriction": "exclude",
"order_types": {
"0": "string"
},
"statement_template_id": "string"
},
"statistics": [
{
"action": "string",
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
}
],
"status": "cancelled",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_pk": "string",
"sys_bulk_load_record_no": 0.1,
"sys_bulk_load_source_file": "string",
"sys_calculated_field_error": "string",
"sys_calculated_field_errors": [
{
"error": "string",
"field": "string"
}
],
"sys_configuration_snapshot_id": "string",
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_deleted_by_id": "string",
"sys_directive": "string",
"sys_external_id": "string",
"sys_has_files_in_s3": true,
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_last_modified_by_id": "string",
"sys_last_security_context": {},
"sys_locked": true,
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"template_id": "string"
}'The billing run was saved successfully.
If set, reminders are sent to those who have failed installments
Date used to filter out schedules to cancel
Date used to filter out schedules to cancel
The notice to send to the customer
Determines if/how to restrict the type of orders to
Determines if/how to restrict the type of invoices to
Date used to filter out schedules to bill
Date used to filter out schedules to bill
If true, the normal payment/order confirmations are not sent
The notice to send if processing is unsuccessful
Determines if/how to restrict the type of orders to
Determines if/how to restrict the type of invoices to
Determines if/how to restrict the type of orders to
The date this billing run was actually processed
If set, installment schedules should be processed
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
If set, reminders are sent to those whose credit cards are about to expire
If set, reminders are to customers who own installment schedules suspended due to payment error
If set, statements are generated for those who have open invoices
Determines if/how to restrict the type of invoices to
The type of customer for whom statements should be generated
Determines if/how to restrict the type of orders to
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
{ "business_unit_id": "string", "cancel_installment_schedules": true, "error": "string", "error_stack": "string", "expiring_credit_card_reminder_options": { "order_type_restriction": "exclude", "order_types": { … }, "reminders": [ … ] }, "id": "string", "installment_schedule_cancellation_options": { "date_range_end": "string", "date_range_start": "string", "notice_id": "string", "order_type_restriction": "exclude", "order_types": { … } }, "installment_schedule_options": { "card_type_restriction": "exclude", "card_types": { … }, "date_range_end": "string", "date_range_start": "string", "do_not_send_standard_email_confirmations": true, "failure_notice_id": "string", "order_type_restriction": "exclude", "order_types": { … }, "payment_type_restriction": "exclude", "payment_types": { … }, "success_notice_id": "string" }, "installment_schedule_reminder_options": { "order_type_restriction": "exclude", "order_types": { … }, "reminders": [ … ] }, "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "preprocessing_date": "2019-08-24T14:15:22Z", "process_installment_schedules": true, "recurring_billing_run_id": "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_expiring_credit_card_reminders": true, "send_installment_schedule_reminders": true, "send_statements": true, "statement_options": { "business_unit_ids": { … }, "business_unit_restriction": "exclude", "customer_type": "both", "order_type_restriction": "exclude", "order_types": { … }, "statement_template_id": "string" }, "statistics": [ { … } ], "status": "cancelled", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "template_id": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/batch
https://collect.api.rhythmsoftware.com/billingRuns/{tenantId}/batch
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-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/collect/collect-v1/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}
https://collect.api.rhythmsoftware.com/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}
https://collect.api.rhythmsoftware.com/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-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/collect/collect-v1/billingRuns/{tenantId}/refresh/{id}
https://collect.api.rhythmsoftware.com/billingRuns/{tenantId}/refresh/{id}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-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/collect/collect-v1/billingRuns/{tenantId}/search
https://collect.api.rhythmsoftware.com/billingRuns/{tenantId}/search
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"activate_applications": [
true
],
"application_expiration_options": [
true
],
"bill_training_providers": [
true
],
"ids": [
"string"
],
"name": "string",
"perform_drops": [
true
],
"run_date": [
"string",
"string"
],
"scheduled_run_date": [
"string",
"string"
],
"send_application_reminders": [
true
],
"send_renewal_reminders": [
true
],
"status": [
"string"
]
}'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/{id}
https://collect.api.rhythmsoftware.com/billingRuns/{tenantId}/{id}
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/{id}
https://collect.api.rhythmsoftware.com/billingRuns/{tenantId}/{id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The billing run was retrieved successfully.
If set, reminders are sent to those who have failed installments
Date used to filter out schedules to cancel
Date used to filter out schedules to cancel
The notice to send to the customer
Determines if/how to restrict the type of orders to
Determines if/how to restrict the type of invoices to
Date used to filter out schedules to bill
Date used to filter out schedules to bill
If true, the normal payment/order confirmations are not sent
The notice to send if processing is unsuccessful
Determines if/how to restrict the type of orders to
Determines if/how to restrict the type of invoices to
Determines if/how to restrict the type of orders to
The date this billing run was actually processed
If set, installment schedules should be processed
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
If set, reminders are sent to those whose credit cards are about to expire
If set, reminders are to customers who own installment schedules suspended due to payment error
If set, statements are generated for those who have open invoices
Determines if/how to restrict the type of invoices to
The type of customer for whom statements should be generated
Determines if/how to restrict the type of orders to
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
{ "business_unit_id": "string", "cancel_installment_schedules": true, "error": "string", "error_stack": "string", "expiring_credit_card_reminder_options": { "order_type_restriction": "exclude", "order_types": { … }, "reminders": [ … ] }, "id": "string", "installment_schedule_cancellation_options": { "date_range_end": "string", "date_range_start": "string", "notice_id": "string", "order_type_restriction": "exclude", "order_types": { … } }, "installment_schedule_options": { "card_type_restriction": "exclude", "card_types": { … }, "date_range_end": "string", "date_range_start": "string", "do_not_send_standard_email_confirmations": true, "failure_notice_id": "string", "order_type_restriction": "exclude", "order_types": { … }, "payment_type_restriction": "exclude", "payment_types": { … }, "success_notice_id": "string" }, "installment_schedule_reminder_options": { "order_type_restriction": "exclude", "order_types": { … }, "reminders": [ … ] }, "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "preprocessing_date": "2019-08-24T14:15:22Z", "process_installment_schedules": true, "recurring_billing_run_id": "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_expiring_credit_card_reminders": true, "send_installment_schedule_reminders": true, "send_statements": true, "statement_options": { "business_unit_ids": { … }, "business_unit_restriction": "exclude", "customer_type": "both", "order_type_restriction": "exclude", "order_types": { … }, "statement_template_id": "string" }, "statistics": [ { … } ], "status": "cancelled", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "template_id": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/{id}
https://collect.api.rhythmsoftware.com/billingRuns/{tenantId}/{id}
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The billing run was patched successfully.
If set, reminders are sent to those who have failed installments
Date used to filter out schedules to cancel
Date used to filter out schedules to cancel
The notice to send to the customer
Determines if/how to restrict the type of orders to
Determines if/how to restrict the type of invoices to
Date used to filter out schedules to bill
Date used to filter out schedules to bill
If true, the normal payment/order confirmations are not sent
The notice to send if processing is unsuccessful
Determines if/how to restrict the type of orders to
Determines if/how to restrict the type of invoices to
Determines if/how to restrict the type of orders to
The date this billing run was actually processed
If set, installment schedules should be processed
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
If set, reminders are sent to those whose credit cards are about to expire
If set, reminders are to customers who own installment schedules suspended due to payment error
If set, statements are generated for those who have open invoices
Determines if/how to restrict the type of invoices to
The type of customer for whom statements should be generated
Determines if/how to restrict the type of orders to
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
{ "business_unit_id": "string", "cancel_installment_schedules": true, "error": "string", "error_stack": "string", "expiring_credit_card_reminder_options": { "order_type_restriction": "exclude", "order_types": { … }, "reminders": [ … ] }, "id": "string", "installment_schedule_cancellation_options": { "date_range_end": "string", "date_range_start": "string", "notice_id": "string", "order_type_restriction": "exclude", "order_types": { … } }, "installment_schedule_options": { "card_type_restriction": "exclude", "card_types": { … }, "date_range_end": "string", "date_range_start": "string", "do_not_send_standard_email_confirmations": true, "failure_notice_id": "string", "order_type_restriction": "exclude", "order_types": { … }, "payment_type_restriction": "exclude", "payment_types": { … }, "success_notice_id": "string" }, "installment_schedule_reminder_options": { "order_type_restriction": "exclude", "order_types": { … }, "reminders": [ … ] }, "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "preprocessing_date": "2019-08-24T14:15:22Z", "process_installment_schedules": true, "recurring_billing_run_id": "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_expiring_credit_card_reminders": true, "send_installment_schedule_reminders": true, "send_statements": true, "statement_options": { "business_unit_ids": { … }, "business_unit_restriction": "exclude", "customer_type": "both", "order_type_restriction": "exclude", "order_types": { … }, "statement_template_id": "string" }, "statistics": [ { … } ], "status": "cancelled", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "template_id": "string" }
The updated billing run that will be saved.
If set, reminders are sent to those who have failed installments
Date used to filter out schedules to cancel
Date used to filter out schedules to cancel
The notice to send to the customer
Determines if/how to restrict the type of orders to
Determines if/how to restrict the type of invoices to
Date used to filter out schedules to bill
Date used to filter out schedules to bill
If true, the normal payment/order confirmations are not sent
The notice to send if processing is unsuccessful
Determines if/how to restrict the type of orders to
Determines if/how to restrict the type of invoices to
Determines if/how to restrict the type of orders to
The date this billing run was actually processed
If set, installment schedules should be processed
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
If set, reminders are sent to those whose credit cards are about to expire
If set, reminders are to customers who own installment schedules suspended due to payment error
If set, statements are generated for those who have open invoices
Determines if/how to restrict the type of invoices to
The type of customer for whom statements should be generated
Determines if/how to restrict the type of orders to
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/collect/collect-v1/billingRuns/{tenantId}/{id}
https://collect.api.rhythmsoftware.com/billingRuns/{tenantId}/{id}
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"business_unit_id": "string",
"cancel_installment_schedules": true,
"error": "string",
"error_stack": "string",
"expiring_credit_card_reminder_options": {
"order_type_restriction": "exclude",
"order_types": {
"0": "string"
},
"reminders": [
{
"card_expiration_date_end": "string",
"card_expiration_date_start": "string",
"id": 0.1,
"name": "string",
"notice_id": "string"
}
]
},
"id": "string",
"installment_schedule_cancellation_options": {
"date_range_end": "string",
"date_range_start": "string",
"notice_id": "string",
"order_type_restriction": "exclude",
"order_types": {
"0": "string"
}
},
"installment_schedule_options": {
"card_type_restriction": "exclude",
"card_types": {
"0": "american express"
},
"date_range_end": "string",
"date_range_start": "string",
"do_not_send_standard_email_confirmations": true,
"failure_notice_id": "string",
"order_type_restriction": "exclude",
"order_types": {
"0": "string"
},
"payment_type_restriction": "exclude",
"payment_types": {
"0": "credit card"
},
"success_notice_id": "string"
},
"installment_schedule_reminder_options": {
"order_type_restriction": "exclude",
"order_types": {
"0": "string"
},
"reminders": [
{
"date_range_end": "string",
"date_range_start": "string",
"id": 0.1,
"name": "string",
"notice_id": "string"
}
]
},
"last_refresh_date": "2019-08-24T14:15:22Z",
"name": "string",
"notification_email": "string",
"preprocessing_date": "2019-08-24T14:15:22Z",
"process_installment_schedules": true,
"recurring_billing_run_id": "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_expiring_credit_card_reminders": true,
"send_installment_schedule_reminders": true,
"send_statements": true,
"statement_options": {
"business_unit_ids": {
"0": "string"
},
"business_unit_restriction": "exclude",
"customer_type": "both",
"order_type_restriction": "exclude",
"order_types": {
"0": "string"
},
"statement_template_id": "string"
},
"statistics": [
{
"action": "string",
"error": 0.1,
"excluded": 0.1,
"pending": 0.1,
"processing": 0.1,
"successful": 0.1,
"total": 0.1
}
],
"status": "cancelled",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_pk": "string",
"sys_bulk_load_record_no": 0.1,
"sys_bulk_load_source_file": "string",
"sys_calculated_field_error": "string",
"sys_calculated_field_errors": [
{
"error": "string",
"field": "string"
}
],
"sys_configuration_snapshot_id": "string",
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_deleted_by_id": "string",
"sys_directive": "string",
"sys_external_id": "string",
"sys_has_files_in_s3": true,
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_last_modified_by_id": "string",
"sys_last_security_context": {},
"sys_locked": true,
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"template_id": "string"
}'The billing run was updated successfully.
If set, reminders are sent to those who have failed installments
Date used to filter out schedules to cancel
Date used to filter out schedules to cancel
The notice to send to the customer
Determines if/how to restrict the type of orders to
Determines if/how to restrict the type of invoices to
Date used to filter out schedules to bill
Date used to filter out schedules to bill
If true, the normal payment/order confirmations are not sent
The notice to send if processing is unsuccessful
Determines if/how to restrict the type of orders to
Determines if/how to restrict the type of invoices to
Determines if/how to restrict the type of orders to
The date this billing run was actually processed
If set, installment schedules should be processed
The date which this billing run should be preprocessed
The date the billing run is scheduled for execution
If set, reminders are sent to those whose credit cards are about to expire
If set, reminders are to customers who own installment schedules suspended due to payment error
If set, statements are generated for those who have open invoices
Determines if/how to restrict the type of invoices to
The type of customer for whom statements should be generated
Determines if/how to restrict the type of orders to
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
{ "business_unit_id": "string", "cancel_installment_schedules": true, "error": "string", "error_stack": "string", "expiring_credit_card_reminder_options": { "order_type_restriction": "exclude", "order_types": { … }, "reminders": [ … ] }, "id": "string", "installment_schedule_cancellation_options": { "date_range_end": "string", "date_range_start": "string", "notice_id": "string", "order_type_restriction": "exclude", "order_types": { … } }, "installment_schedule_options": { "card_type_restriction": "exclude", "card_types": { … }, "date_range_end": "string", "date_range_start": "string", "do_not_send_standard_email_confirmations": true, "failure_notice_id": "string", "order_type_restriction": "exclude", "order_types": { … }, "payment_type_restriction": "exclude", "payment_types": { … }, "success_notice_id": "string" }, "installment_schedule_reminder_options": { "order_type_restriction": "exclude", "order_types": { … }, "reminders": [ … ] }, "last_refresh_date": "2019-08-24T14:15:22Z", "name": "string", "notification_email": "string", "preprocessing_date": "2019-08-24T14:15:22Z", "process_installment_schedules": true, "recurring_billing_run_id": "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_expiring_credit_card_reminders": true, "send_installment_schedule_reminders": true, "send_statements": true, "statement_options": { "business_unit_ids": { … }, "business_unit_restriction": "exclude", "customer_type": "both", "order_type_restriction": "exclude", "order_types": { … }, "statement_template_id": "string" }, "statistics": [ { … } ], "status": "cancelled", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "template_id": "string" }