Skip to content
/Billing Runs

Collect (Finance & Billing) (v1-2025-04-18)

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.

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

Accounting Projects

Accounting Projects

Operations

Bank Accounts

Bank Accounts

Operations

Batch Assignment Settings

Batch Assignment Settings

Operations

Batch Downloading

Batch Downloading

Operations

Batch Posting

Batch Posting

Operations

Batch Templates

Batch Templates

Operations

Batches

Batches

Operations

Billing Notices

Billing Notices

Operations

Billing Run Actions

Billing Run Actions

Operations

Billing Runs

Billing Runs

Operations

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

Request

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.

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The billing run that you would like to be saved.

business_unit_idstring(Business Unit)required
cancel_installment_schedulesboolean(Cancel Installment Schedules)

If set, reminders are sent to those who have failed installments

errorstring(Error)

The error message

error_stackstring(Error Stack)

The error stack

expiring_credit_card_reminder_optionsobject(Expiring Credit Card Reminder Options)required
expiring_credit_card_reminder_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
expiring_credit_card_reminder_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
expiring_credit_card_reminder_options.​remindersArray of objects
idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing run

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required
installment_schedule_cancellation_options.​date_range_endstring(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.​date_range_startstring(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.​notice_idstring(Notice)

The notice to send to the customer

installment_schedule_cancellation_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_cancellation_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_optionsobject(Installment Schedule Options)required
installment_schedule_options.​card_type_restrictionstring(Card Type Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
installment_schedule_options.​card_typesArray of Card Types (strings)(Card Types)non-empty
One of:
non-empty
installment_schedule_options.​date_range_endstring(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.​date_range_startstring(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.​do_not_send_standard_email_confirmationsboolean(Do Not Send Standard Email Confirmations)

If true, the normal payment/order confirmations are not sent

installment_schedule_options.​failure_notice_idstring(Failure Notice)

The notice to send if processing is unsuccessful

installment_schedule_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_options.​payment_type_restrictionstring(Payment Type Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
installment_schedule_options.​payment_typesArray of Payment Types (strings)(Payment Types)non-empty
One of:
non-empty
installment_schedule_options.​success_notice_idstring(Success Notice)

The notice to send if processing is successful

installment_schedule_reminder_optionsobject(Installment Schedule Reminder Options)required
installment_schedule_reminder_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_reminder_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_reminder_options.​remindersArray of objectsnon-emptyrequired
installment_schedule_reminder_options.​reminders[].​date_range_endstring(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.​reminders[].​date_range_startstring(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

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

Optional name

installment_schedule_reminder_options.​reminders[].​notice_idstring(Notice)required

The reminder notice

last_refresh_datestring(date-time)(Last Refresh Date)

The last time the billing run was refreshed

namestring(Name)required

The name of the billing run

notification_emailstring(Notification Email)

Te address to send notifications

preprocessing_datestring(date-time)(Preprocessing Date)

The date this billing run was actually processed

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

recurring_billing_run_idstring(Recurring Billing Run)

The recurring billing run

run_datestring(date-time)(Run Date)

The date of the billing run

scheduled_preprocessing_datestring(date-time)(Scheduled Preprocessing Date)

The date which this billing run should be preprocessed

scheduled_run_datestring(date-time)(Scheduled Run Date)

The date the billing run is scheduled for execution

send_expiring_credit_card_remindersboolean(Send Expiring Credit Card Reminders)

If set, reminders are sent to those whose credit cards are about to expire

send_installment_schedule_remindersboolean(Send Installment Schedule Reminders)

If set, reminders are to customers who own installment schedules suspended due to payment error

send_statementsboolean(Send Statements)

If set, statements are generated for those who have open invoices

statement_optionsobject(Statement Options)required
statement_options.​business_unit_idsArray of Business Units (strings)(Business Units)non-empty
One of:
non-empty
statement_options.​business_unit_restrictionstring(Business Unit Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
statement_options.​customer_typestring(Customer Type)

The type of customer for whom statements should be generated

Enum"both""contact""organization"
statement_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
statement_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
statement_options.​statement_template_idstring(Statement Template)

The statement template to use; leave blank for default

statisticsArray of objects
statusstring(Status)required
Enum"cancelled""completed""draft""error""preprocessing""ready for execution""running""scheduled""scheduled for execution""timed out"
sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

template_idstring(Template)

The billing template that created this run

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"
  }'

Responses

The billing run was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
business_unit_idstring(Business Unit)required
cancel_installment_schedulesboolean(Cancel Installment Schedules)

If set, reminders are sent to those who have failed installments

errorstring(Error)

The error message

error_stackstring(Error Stack)

The error stack

expiring_credit_card_reminder_optionsobject(Expiring Credit Card Reminder Options)required
expiring_credit_card_reminder_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
expiring_credit_card_reminder_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
expiring_credit_card_reminder_options.​remindersArray of objects
idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing run

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required
installment_schedule_cancellation_options.​date_range_endstring(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.​date_range_startstring(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.​notice_idstring(Notice)

The notice to send to the customer

installment_schedule_cancellation_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_cancellation_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_optionsobject(Installment Schedule Options)required
installment_schedule_options.​card_type_restrictionstring(Card Type Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
installment_schedule_options.​card_typesArray of Card Types (strings)(Card Types)non-empty
One of:
non-empty
installment_schedule_options.​date_range_endstring(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.​date_range_startstring(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.​do_not_send_standard_email_confirmationsboolean(Do Not Send Standard Email Confirmations)

If true, the normal payment/order confirmations are not sent

installment_schedule_options.​failure_notice_idstring(Failure Notice)

The notice to send if processing is unsuccessful

installment_schedule_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_options.​payment_type_restrictionstring(Payment Type Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
installment_schedule_options.​payment_typesArray of Payment Types (strings)(Payment Types)non-empty
One of:
non-empty
installment_schedule_options.​success_notice_idstring(Success Notice)

The notice to send if processing is successful

installment_schedule_reminder_optionsobject(Installment Schedule Reminder Options)required
installment_schedule_reminder_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_reminder_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_reminder_options.​remindersArray of objectsnon-emptyrequired
installment_schedule_reminder_options.​reminders[].​date_range_endstring(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.​reminders[].​date_range_startstring(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

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

Optional name

installment_schedule_reminder_options.​reminders[].​notice_idstring(Notice)required

The reminder notice

last_refresh_datestring(date-time)(Last Refresh Date)

The last time the billing run was refreshed

namestring(Name)required

The name of the billing run

notification_emailstring(Notification Email)

Te address to send notifications

preprocessing_datestring(date-time)(Preprocessing Date)

The date this billing run was actually processed

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

recurring_billing_run_idstring(Recurring Billing Run)

The recurring billing run

run_datestring(date-time)(Run Date)

The date of the billing run

scheduled_preprocessing_datestring(date-time)(Scheduled Preprocessing Date)

The date which this billing run should be preprocessed

scheduled_run_datestring(date-time)(Scheduled Run Date)

The date the billing run is scheduled for execution

send_expiring_credit_card_remindersboolean(Send Expiring Credit Card Reminders)

If set, reminders are sent to those whose credit cards are about to expire

send_installment_schedule_remindersboolean(Send Installment Schedule Reminders)

If set, reminders are to customers who own installment schedules suspended due to payment error

send_statementsboolean(Send Statements)

If set, statements are generated for those who have open invoices

statement_optionsobject(Statement Options)required
statement_options.​business_unit_idsArray of Business Units (strings)(Business Units)non-empty
One of:
non-empty
statement_options.​business_unit_restrictionstring(Business Unit Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
statement_options.​customer_typestring(Customer Type)

The type of customer for whom statements should be generated

Enum"both""contact""organization"
statement_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
statement_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
statement_options.​statement_template_idstring(Statement Template)

The statement template to use; leave blank for default

statisticsArray of objects
statusstring(Status)required
Enum"cancelled""completed""draft""error""preprocessing""ready for execution""running""scheduled""scheduled for execution""timed out"
sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

template_idstring(Template)

The billing template that created this run

Response
application/json
{
  "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"
}

Execute Batch Operations

Request

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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/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"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

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

Number of error results

resultsArray of objects
success_countnumber(float)(Success Count)

Number of successful results

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

Generates a billing run from a template

Request

Security
knox-authorizer
Path
tenantIdstringrequired

The tenant

templateIdstringrequired

The template

referenceDatestringrequired

The reference date

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>'

Responses

The records were retrieved successfully

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

Returns a list of records with the specified recurring_billing_run_id

Request

Returns a list of records with the specified recurring_billing_run_id

Security
knox-authorizer
Path
tenantIdstringrequired

The tenant

recurring_billing_run_idstringrequired

The recurring_billing_run_id to use to for record lookup

Query
fieldsstring

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

exclusiveStartKeystring

If paging, this allows you to return the next set of results

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

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(BillingRun)
LastEvaluatedKeystring
Response
application/json
{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Refreshes a billing run

Request

Security
knox-authorizer
Path
tenantIdstringrequired

The tenant

idstringrequired

The billing_run_id to use to refresh

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRuns/{tenantId}/refresh/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
executionArnstring(Executionarn)required

The arn of the execution

notification_channelstring(Notification Channel)

The id of the channel where progress updates will be posted

notification_publishKeystring(Notification Publishkey)

The publish key for the channel where progress updates will be posted

notification_subscribeKeystring(Notification Subscribekey)

The subscribe key for the channel where progress updates will be posted

start_datestring(date-time)(Start Date)

The start date of the execution

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

Searches for billing runs using predefined parameters

Request

Searches for billing runs using predefined parameters

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

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

Bodyapplication/jsonrequired

The billing run that you would like to be saved.

activate_applicationsArray of booleans(Activate Applications)
application_expiration_optionsArray of booleans(Application Expiration Options)
bill_training_providersArray of booleans(Bill Training Providers)
idsArray of strings(Ids)

IDs to search

namestring(Name)
perform_dropsArray of booleans(Perform Drops)
run_dateArray of strings(Run Date)= 2 items
scheduled_run_dateArray of strings(Scheduled Run Date)= 2 items
send_application_remindersArray of booleans(Send Application Reminders)
send_renewal_remindersArray of booleans(Send Renewal Reminders)
statusArray of strings(Status)
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"
    ]
  }'

Responses

The billing run search was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
ItemsArray of objects(BillingRunSearchResults)
LastEvaluatedKeystring
Response
application/json
{
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a billing run from the system by its ID.

Request

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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing run to delete.

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

Responses

The billing run was deleted successfully.

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

Returns a billing run from the system by its ID.

Request

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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing run to return.

Query
fieldsstring

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

consistentReadstring

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

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

Responses

The billing run was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
business_unit_idstring(Business Unit)required
cancel_installment_schedulesboolean(Cancel Installment Schedules)

If set, reminders are sent to those who have failed installments

errorstring(Error)

The error message

error_stackstring(Error Stack)

The error stack

expiring_credit_card_reminder_optionsobject(Expiring Credit Card Reminder Options)required
expiring_credit_card_reminder_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
expiring_credit_card_reminder_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
expiring_credit_card_reminder_options.​remindersArray of objects
idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing run

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required
installment_schedule_cancellation_options.​date_range_endstring(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.​date_range_startstring(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.​notice_idstring(Notice)

The notice to send to the customer

installment_schedule_cancellation_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_cancellation_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_optionsobject(Installment Schedule Options)required
installment_schedule_options.​card_type_restrictionstring(Card Type Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
installment_schedule_options.​card_typesArray of Card Types (strings)(Card Types)non-empty
One of:
non-empty
installment_schedule_options.​date_range_endstring(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.​date_range_startstring(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.​do_not_send_standard_email_confirmationsboolean(Do Not Send Standard Email Confirmations)

If true, the normal payment/order confirmations are not sent

installment_schedule_options.​failure_notice_idstring(Failure Notice)

The notice to send if processing is unsuccessful

installment_schedule_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_options.​payment_type_restrictionstring(Payment Type Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
installment_schedule_options.​payment_typesArray of Payment Types (strings)(Payment Types)non-empty
One of:
non-empty
installment_schedule_options.​success_notice_idstring(Success Notice)

The notice to send if processing is successful

installment_schedule_reminder_optionsobject(Installment Schedule Reminder Options)required
installment_schedule_reminder_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_reminder_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_reminder_options.​remindersArray of objectsnon-emptyrequired
installment_schedule_reminder_options.​reminders[].​date_range_endstring(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.​reminders[].​date_range_startstring(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

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

Optional name

installment_schedule_reminder_options.​reminders[].​notice_idstring(Notice)required

The reminder notice

last_refresh_datestring(date-time)(Last Refresh Date)

The last time the billing run was refreshed

namestring(Name)required

The name of the billing run

notification_emailstring(Notification Email)

Te address to send notifications

preprocessing_datestring(date-time)(Preprocessing Date)

The date this billing run was actually processed

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

recurring_billing_run_idstring(Recurring Billing Run)

The recurring billing run

run_datestring(date-time)(Run Date)

The date of the billing run

scheduled_preprocessing_datestring(date-time)(Scheduled Preprocessing Date)

The date which this billing run should be preprocessed

scheduled_run_datestring(date-time)(Scheduled Run Date)

The date the billing run is scheduled for execution

send_expiring_credit_card_remindersboolean(Send Expiring Credit Card Reminders)

If set, reminders are sent to those whose credit cards are about to expire

send_installment_schedule_remindersboolean(Send Installment Schedule Reminders)

If set, reminders are to customers who own installment schedules suspended due to payment error

send_statementsboolean(Send Statements)

If set, statements are generated for those who have open invoices

statement_optionsobject(Statement Options)required
statement_options.​business_unit_idsArray of Business Units (strings)(Business Units)non-empty
One of:
non-empty
statement_options.​business_unit_restrictionstring(Business Unit Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
statement_options.​customer_typestring(Customer Type)

The type of customer for whom statements should be generated

Enum"both""contact""organization"
statement_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
statement_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
statement_options.​statement_template_idstring(Statement Template)

The statement template to use; leave blank for default

statisticsArray of objects
statusstring(Status)required
Enum"cancelled""completed""draft""error""preprocessing""ready for execution""running""scheduled""scheduled for execution""timed out"
sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

template_idstring(Template)

The billing template that created this run

Response
application/json
{
  "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"
}

Partially updates a billing run with the specified ID.

Request

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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing run to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [
opstring(Op)required

The operation

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

The JSON path

valuestring(Value)
]
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"
    }
  ]'

Responses

The billing run was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
business_unit_idstring(Business Unit)required
cancel_installment_schedulesboolean(Cancel Installment Schedules)

If set, reminders are sent to those who have failed installments

errorstring(Error)

The error message

error_stackstring(Error Stack)

The error stack

expiring_credit_card_reminder_optionsobject(Expiring Credit Card Reminder Options)required
expiring_credit_card_reminder_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
expiring_credit_card_reminder_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
expiring_credit_card_reminder_options.​remindersArray of objects
idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing run

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required
installment_schedule_cancellation_options.​date_range_endstring(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.​date_range_startstring(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.​notice_idstring(Notice)

The notice to send to the customer

installment_schedule_cancellation_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_cancellation_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_optionsobject(Installment Schedule Options)required
installment_schedule_options.​card_type_restrictionstring(Card Type Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
installment_schedule_options.​card_typesArray of Card Types (strings)(Card Types)non-empty
One of:
non-empty
installment_schedule_options.​date_range_endstring(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.​date_range_startstring(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.​do_not_send_standard_email_confirmationsboolean(Do Not Send Standard Email Confirmations)

If true, the normal payment/order confirmations are not sent

installment_schedule_options.​failure_notice_idstring(Failure Notice)

The notice to send if processing is unsuccessful

installment_schedule_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_options.​payment_type_restrictionstring(Payment Type Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
installment_schedule_options.​payment_typesArray of Payment Types (strings)(Payment Types)non-empty
One of:
non-empty
installment_schedule_options.​success_notice_idstring(Success Notice)

The notice to send if processing is successful

installment_schedule_reminder_optionsobject(Installment Schedule Reminder Options)required
installment_schedule_reminder_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_reminder_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_reminder_options.​remindersArray of objectsnon-emptyrequired
installment_schedule_reminder_options.​reminders[].​date_range_endstring(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.​reminders[].​date_range_startstring(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

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

Optional name

installment_schedule_reminder_options.​reminders[].​notice_idstring(Notice)required

The reminder notice

last_refresh_datestring(date-time)(Last Refresh Date)

The last time the billing run was refreshed

namestring(Name)required

The name of the billing run

notification_emailstring(Notification Email)

Te address to send notifications

preprocessing_datestring(date-time)(Preprocessing Date)

The date this billing run was actually processed

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

recurring_billing_run_idstring(Recurring Billing Run)

The recurring billing run

run_datestring(date-time)(Run Date)

The date of the billing run

scheduled_preprocessing_datestring(date-time)(Scheduled Preprocessing Date)

The date which this billing run should be preprocessed

scheduled_run_datestring(date-time)(Scheduled Run Date)

The date the billing run is scheduled for execution

send_expiring_credit_card_remindersboolean(Send Expiring Credit Card Reminders)

If set, reminders are sent to those whose credit cards are about to expire

send_installment_schedule_remindersboolean(Send Installment Schedule Reminders)

If set, reminders are to customers who own installment schedules suspended due to payment error

send_statementsboolean(Send Statements)

If set, statements are generated for those who have open invoices

statement_optionsobject(Statement Options)required
statement_options.​business_unit_idsArray of Business Units (strings)(Business Units)non-empty
One of:
non-empty
statement_options.​business_unit_restrictionstring(Business Unit Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
statement_options.​customer_typestring(Customer Type)

The type of customer for whom statements should be generated

Enum"both""contact""organization"
statement_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
statement_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
statement_options.​statement_template_idstring(Statement Template)

The statement template to use; leave blank for default

statisticsArray of objects
statusstring(Status)required
Enum"cancelled""completed""draft""error""preprocessing""ready for execution""running""scheduled""scheduled for execution""timed out"
sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

template_idstring(Template)

The billing template that created this run

Response
application/json
{
  "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"
}

Updates a billing run with the specified ID.

Request

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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing run to update.

Bodyapplication/jsonrequired

The updated billing run that will be saved.

business_unit_idstring(Business Unit)required
cancel_installment_schedulesboolean(Cancel Installment Schedules)

If set, reminders are sent to those who have failed installments

errorstring(Error)

The error message

error_stackstring(Error Stack)

The error stack

expiring_credit_card_reminder_optionsobject(Expiring Credit Card Reminder Options)required
expiring_credit_card_reminder_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
expiring_credit_card_reminder_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
expiring_credit_card_reminder_options.​remindersArray of objects
idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing run

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required
installment_schedule_cancellation_options.​date_range_endstring(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.​date_range_startstring(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.​notice_idstring(Notice)

The notice to send to the customer

installment_schedule_cancellation_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_cancellation_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_optionsobject(Installment Schedule Options)required
installment_schedule_options.​card_type_restrictionstring(Card Type Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
installment_schedule_options.​card_typesArray of Card Types (strings)(Card Types)non-empty
One of:
non-empty
installment_schedule_options.​date_range_endstring(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.​date_range_startstring(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.​do_not_send_standard_email_confirmationsboolean(Do Not Send Standard Email Confirmations)

If true, the normal payment/order confirmations are not sent

installment_schedule_options.​failure_notice_idstring(Failure Notice)

The notice to send if processing is unsuccessful

installment_schedule_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_options.​payment_type_restrictionstring(Payment Type Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
installment_schedule_options.​payment_typesArray of Payment Types (strings)(Payment Types)non-empty
One of:
non-empty
installment_schedule_options.​success_notice_idstring(Success Notice)

The notice to send if processing is successful

installment_schedule_reminder_optionsobject(Installment Schedule Reminder Options)required
installment_schedule_reminder_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_reminder_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_reminder_options.​remindersArray of objectsnon-emptyrequired
installment_schedule_reminder_options.​reminders[].​date_range_endstring(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.​reminders[].​date_range_startstring(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

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

Optional name

installment_schedule_reminder_options.​reminders[].​notice_idstring(Notice)required

The reminder notice

last_refresh_datestring(date-time)(Last Refresh Date)

The last time the billing run was refreshed

namestring(Name)required

The name of the billing run

notification_emailstring(Notification Email)

Te address to send notifications

preprocessing_datestring(date-time)(Preprocessing Date)

The date this billing run was actually processed

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

recurring_billing_run_idstring(Recurring Billing Run)

The recurring billing run

run_datestring(date-time)(Run Date)

The date of the billing run

scheduled_preprocessing_datestring(date-time)(Scheduled Preprocessing Date)

The date which this billing run should be preprocessed

scheduled_run_datestring(date-time)(Scheduled Run Date)

The date the billing run is scheduled for execution

send_expiring_credit_card_remindersboolean(Send Expiring Credit Card Reminders)

If set, reminders are sent to those whose credit cards are about to expire

send_installment_schedule_remindersboolean(Send Installment Schedule Reminders)

If set, reminders are to customers who own installment schedules suspended due to payment error

send_statementsboolean(Send Statements)

If set, statements are generated for those who have open invoices

statement_optionsobject(Statement Options)required
statement_options.​business_unit_idsArray of Business Units (strings)(Business Units)non-empty
One of:
non-empty
statement_options.​business_unit_restrictionstring(Business Unit Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
statement_options.​customer_typestring(Customer Type)

The type of customer for whom statements should be generated

Enum"both""contact""organization"
statement_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
statement_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
statement_options.​statement_template_idstring(Statement Template)

The statement template to use; leave blank for default

statisticsArray of objects
statusstring(Status)required
Enum"cancelled""completed""draft""error""preprocessing""ready for execution""running""scheduled""scheduled for execution""timed out"
sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

template_idstring(Template)

The billing template that created this run

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"
  }'

Responses

The billing run was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
business_unit_idstring(Business Unit)required
cancel_installment_schedulesboolean(Cancel Installment Schedules)

If set, reminders are sent to those who have failed installments

errorstring(Error)

The error message

error_stackstring(Error Stack)

The error stack

expiring_credit_card_reminder_optionsobject(Expiring Credit Card Reminder Options)required
expiring_credit_card_reminder_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
expiring_credit_card_reminder_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
expiring_credit_card_reminder_options.​remindersArray of objects
idstring(ID)^[\w|-]+$required

The unique, string identifier of this billing run

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required
installment_schedule_cancellation_options.​date_range_endstring(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.​date_range_startstring(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.​notice_idstring(Notice)

The notice to send to the customer

installment_schedule_cancellation_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_cancellation_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_optionsobject(Installment Schedule Options)required
installment_schedule_options.​card_type_restrictionstring(Card Type Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
installment_schedule_options.​card_typesArray of Card Types (strings)(Card Types)non-empty
One of:
non-empty
installment_schedule_options.​date_range_endstring(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.​date_range_startstring(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.​do_not_send_standard_email_confirmationsboolean(Do Not Send Standard Email Confirmations)

If true, the normal payment/order confirmations are not sent

installment_schedule_options.​failure_notice_idstring(Failure Notice)

The notice to send if processing is unsuccessful

installment_schedule_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_options.​payment_type_restrictionstring(Payment Type Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
installment_schedule_options.​payment_typesArray of Payment Types (strings)(Payment Types)non-empty
One of:
non-empty
installment_schedule_options.​success_notice_idstring(Success Notice)

The notice to send if processing is successful

installment_schedule_reminder_optionsobject(Installment Schedule Reminder Options)required
installment_schedule_reminder_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
installment_schedule_reminder_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
installment_schedule_reminder_options.​remindersArray of objectsnon-emptyrequired
installment_schedule_reminder_options.​reminders[].​date_range_endstring(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.​reminders[].​date_range_startstring(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.​reminders[].​idnumber(float)(ID)

A unique, unchangeable reminder id

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

Optional name

installment_schedule_reminder_options.​reminders[].​notice_idstring(Notice)required

The reminder notice

last_refresh_datestring(date-time)(Last Refresh Date)

The last time the billing run was refreshed

namestring(Name)required

The name of the billing run

notification_emailstring(Notification Email)

Te address to send notifications

preprocessing_datestring(date-time)(Preprocessing Date)

The date this billing run was actually processed

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

recurring_billing_run_idstring(Recurring Billing Run)

The recurring billing run

run_datestring(date-time)(Run Date)

The date of the billing run

scheduled_preprocessing_datestring(date-time)(Scheduled Preprocessing Date)

The date which this billing run should be preprocessed

scheduled_run_datestring(date-time)(Scheduled Run Date)

The date the billing run is scheduled for execution

send_expiring_credit_card_remindersboolean(Send Expiring Credit Card Reminders)

If set, reminders are sent to those whose credit cards are about to expire

send_installment_schedule_remindersboolean(Send Installment Schedule Reminders)

If set, reminders are to customers who own installment schedules suspended due to payment error

send_statementsboolean(Send Statements)

If set, statements are generated for those who have open invoices

statement_optionsobject(Statement Options)required
statement_options.​business_unit_idsArray of Business Units (strings)(Business Units)non-empty
One of:
non-empty
statement_options.​business_unit_restrictionstring(Business Unit Restriction)

Determines if/how to restrict the type of invoices to

Enum"exclude""include""none"
statement_options.​customer_typestring(Customer Type)

The type of customer for whom statements should be generated

Enum"both""contact""organization"
statement_options.​order_type_restrictionstring(Order Type Restriction)

Determines if/how to restrict the type of orders to

Enum"exclude""include""none"
statement_options.​order_typesArray of Order Types (strings)(Order Types)non-empty
One of:
non-empty
statement_options.​statement_template_idstring(Statement Template)

The statement template to use; leave blank for default

statisticsArray of objects
statusstring(Status)required
Enum"cancelled""completed""draft""error""preprocessing""ready for execution""running""scheduled""scheduled for execution""timed out"
sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

template_idstring(Template)

The billing template that created this run

Response
application/json
{
  "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"
}

Billing Templates

Billing Templates

Operations

Business Units

Business Units

Operations

Check Request Processes

Check Request Processes

Operations

Check Request Templates

Check Request Templates

Operations

Check Requests

Check Requests

Operations

Cogs Entries

Cogs Entries

Operations

Credit Memos

Credit Memos

Operations

Credits

Credits

Operations

Currency Mapping Policies

Currency Mapping Policies

Operations

Debit Memos

Debit Memos

Operations

Departments

Departments

Operations

Donation Products

Donation Products

Operations

Exchange Rates

Exchange Rates

Operations

External Payments

External Payments

Operations

Fiscal Years

Fiscal Years

Operations

Gateway Entities

Gateway Entities

Operations

Gateway Entries

Gateway Entries

Operations

Gateway Fees

Gateway Fees

Operations

Gl Accounts

Gl Accounts

Operations

Installment Plans

Installment Plans

Operations

Installment Schedules

Installment Schedules

Operations

Invoice Payment Terms

Invoice Payment Terms

Operations

Invoice Templates

Invoice Templates

Operations

Invoice Types

Invoice Types

Operations

Invoices

Invoices

Operations

Late Fee Rules

Late Fee Rules

Operations

Late Fees

Late Fees

Operations

Legacy Import Products

Legacy Import Products

Operations

Merchant Accounts

Merchant Accounts

Operations

Miscellaneous Products

Miscellaneous Products

Operations

Payment Receipt Templates

Payment Receipt Templates

Operations

Payments

Payments

Operations

Product Financial Configs

Product Financial Configs

Operations

Query Definitions

Query Definitions

Operations

Recurring Batches

Recurring Batches

Operations

Recurring Billing Runs

Recurring Billing Runs

Operations

Refund Receipt Templates

Refund Receipt Templates

Operations

Refunds

Refunds

Operations

Revenue Recognition Schedules

Revenue Recognition Schedules

Operations

Settings

Settings

Operations

Statement Templates

Statement Templates

Operations

Statements

Statements

Operations

Statistics

Statistics

Operations

Stored Payment Methods

Stored Payment Methods

Operations

Subledger Entries

Subledger Entries

Operations

Write Offs

Write Offs

Operations