Billing Templates

Accounting Projects

Operations

Bank Accounts

Operations

Batch Assignment Settings

Operations

Batch Downloading

Operations

Batch Posting

Operations

Batch Templates

Operations

Batches

Operations

Billing Notices

Operations

Billing Run Actions

Operations

Billing Runs

Operations

Billing Templates

Operations

Gets all of the billing templates in the system.

Request

This method will scan all billing templates and and return them to the caller.

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

fieldsstring

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

exclusiveStartKeystring

The start key, if you're making a subsequent request

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

Responses

The billing templateswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

business_unit_idstring(Business Unit)required

cancel_installment_schedulesboolean(Cancel Installment Schedules)

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

descriptionstring(Description)

A description of the template

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 template

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required

installment_schedule_cancellation_options.date_range_endobject(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_cancellation_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_reminder_options.reminders[].date_range_startobject(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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

is_activeboolean(Is Active)

Whether or not the template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

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

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

]

Response

application/json

[
  {
    "business_unit_id": "string",
    "cancel_installment_schedules": true,
    "description": "string",
    "expiring_credit_card_reminder_options": { … },
    "id": "string",
    "installment_schedule_cancellation_options": { … },
    "installment_schedule_options": { … },
    "installment_schedule_reminder_options": { … },
    "is_active": true,
    "name": "string",
    "notification_email": "string",
    "process_installment_schedules": true,
    "send_expiring_credit_card_reminders": true,
    "send_installment_schedule_reminders": true,
    "send_statements": true,
    "statement_options": { … },
    "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
  }
]

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

Request

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

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The billing template 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

descriptionstring(Description)

A description of the template

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 template

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required

installment_schedule_cancellation_options.date_range_endobject(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_cancellation_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_reminder_options.reminders[].date_range_startobject(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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

is_activeboolean(Is Active)

Whether or not the template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

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

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

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingTemplates/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "business_unit_id": "string",
    "cancel_installment_schedules": true,
    "description": "string",
    "expiring_credit_card_reminder_options": {
      "order_type_restriction": "exclude",
      "order_types": {
        "0": "string"
      },
      "reminders": [
        {
          "card_expiration_date_end": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "card_expiration_date_start": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "id": 0.1,
          "name": "string",
          "notice_id": "string"
        }
      ]
    },
    "id": "string",
    "installment_schedule_cancellation_options": {
      "date_range_end": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "date_range_start": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "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": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "date_range_start": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "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": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "date_range_start": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "id": 0.1,
          "name": "string",
          "notice_id": "string"
        }
      ]
    },
    "is_active": true,
    "name": "string",
    "notification_email": "string",
    "process_installment_schedules": true,
    "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"
    },
    "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
  }'

Responses

The billing template 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

descriptionstring(Description)

A description of the template

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 template

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required

installment_schedule_cancellation_options.date_range_endobject(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_cancellation_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_reminder_options.reminders[].date_range_startobject(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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

is_activeboolean(Is Active)

Whether or not the template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

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

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

Response

application/json

{
  "business_unit_id": "string",
  "cancel_installment_schedules": true,
  "description": "string",
  "expiring_credit_card_reminder_options": {
    "order_type_restriction": "exclude",
    "order_types": { … },
    "reminders": [ … ]
  },
  "id": "string",
  "installment_schedule_cancellation_options": {
    "date_range_end": { … },
    "date_range_start": { … },
    "notice_id": "string",
    "order_type_restriction": "exclude",
    "order_types": { … }
  },
  "installment_schedule_options": {
    "card_type_restriction": "exclude",
    "card_types": { … },
    "date_range_end": { … },
    "date_range_start": { … },
    "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": [ … ]
  },
  "is_active": true,
  "name": "string",
  "notification_email": "string",
  "process_installment_schedules": true,
  "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"
  },
  "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
}

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/billingTemplates/{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
}

Returns a billing template from the system by its ID.

Request

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

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing template to delete.

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

Responses

The billing template 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 template from the system by its ID.

Request

This method will look up a billing template 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 template 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/billingTemplates/{tenantId}/{id}?fields=string&consistentRead=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The billing template 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

descriptionstring(Description)

A description of the template

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 template

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required

installment_schedule_cancellation_options.date_range_endobject(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_cancellation_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_reminder_options.reminders[].date_range_startobject(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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

is_activeboolean(Is Active)

Whether or not the template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

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

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

Response

application/json

{
  "business_unit_id": "string",
  "cancel_installment_schedules": true,
  "description": "string",
  "expiring_credit_card_reminder_options": {
    "order_type_restriction": "exclude",
    "order_types": { … },
    "reminders": [ … ]
  },
  "id": "string",
  "installment_schedule_cancellation_options": {
    "date_range_end": { … },
    "date_range_start": { … },
    "notice_id": "string",
    "order_type_restriction": "exclude",
    "order_types": { … }
  },
  "installment_schedule_options": {
    "card_type_restriction": "exclude",
    "card_types": { … },
    "date_range_end": { … },
    "date_range_start": { … },
    "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": [ … ]
  },
  "is_active": true,
  "name": "string",
  "notification_email": "string",
  "process_installment_schedules": true,
  "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"
  },
  "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
}

Partially updates a billing template with the specified ID.

Request

This method will patch an existing billing template 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 template 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/billingTemplates/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The billing template 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

descriptionstring(Description)

A description of the template

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 template

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required

installment_schedule_cancellation_options.date_range_endobject(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_cancellation_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_reminder_options.reminders[].date_range_startobject(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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

is_activeboolean(Is Active)

Whether or not the template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

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

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

Response

application/json

{
  "business_unit_id": "string",
  "cancel_installment_schedules": true,
  "description": "string",
  "expiring_credit_card_reminder_options": {
    "order_type_restriction": "exclude",
    "order_types": { … },
    "reminders": [ … ]
  },
  "id": "string",
  "installment_schedule_cancellation_options": {
    "date_range_end": { … },
    "date_range_start": { … },
    "notice_id": "string",
    "order_type_restriction": "exclude",
    "order_types": { … }
  },
  "installment_schedule_options": {
    "card_type_restriction": "exclude",
    "card_types": { … },
    "date_range_end": { … },
    "date_range_start": { … },
    "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": [ … ]
  },
  "is_active": true,
  "name": "string",
  "notification_email": "string",
  "process_installment_schedules": true,
  "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"
  },
  "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
}

Updates a billing template with the specified ID.

Request

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

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing template to update.

Bodyapplication/jsonrequired

The updated billing template 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

descriptionstring(Description)

A description of the template

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 template

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required

installment_schedule_cancellation_options.date_range_endobject(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_cancellation_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_reminder_options.reminders[].date_range_startobject(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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

is_activeboolean(Is Active)

Whether or not the template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

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

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

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingTemplates/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "business_unit_id": "string",
    "cancel_installment_schedules": true,
    "description": "string",
    "expiring_credit_card_reminder_options": {
      "order_type_restriction": "exclude",
      "order_types": {
        "0": "string"
      },
      "reminders": [
        {
          "card_expiration_date_end": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "card_expiration_date_start": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "id": 0.1,
          "name": "string",
          "notice_id": "string"
        }
      ]
    },
    "id": "string",
    "installment_schedule_cancellation_options": {
      "date_range_end": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "date_range_start": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "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": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "date_range_start": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "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": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "date_range_start": {
            "number": null,
            "position": "after",
            "relative_to": "the beginning of the month",
            "unit_of_time": "days"
          },
          "id": 0.1,
          "name": "string",
          "notice_id": "string"
        }
      ]
    },
    "is_active": true,
    "name": "string",
    "notification_email": "string",
    "process_installment_schedules": true,
    "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"
    },
    "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
  }'

Responses

The billing template 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

descriptionstring(Description)

A description of the template

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 template

installment_schedule_cancellation_optionsobject(Installment Schedule Cancellation Options)required

installment_schedule_cancellation_options.date_range_endobject(Date Range End)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_cancellation_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to cancel

installment_schedule_cancellation_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_cancellation_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_cancellation_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_cancellation_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_options.date_range_startobject(Date Range Start)required

Date used to filter out schedules to bill

installment_schedule_options.date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_options.date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_options.date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_options.date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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_endobject(Date Range End)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_end.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_end.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

installment_schedule_reminder_options.reminders[].date_range_startobject(Date Range Start)required

Date used to filter out schedules to send reminders

installment_schedule_reminder_options.reminders[].date_range_start.numberNumber (number)(float)(Number)>= 0required

The unit of time

One of:

The unit of time

>= 0

number(float)(Number)>= 0

installment_schedule_reminder_options.reminders[].date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

installment_schedule_reminder_options.reminders[].date_range_start.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

installment_schedule_reminder_options.reminders[].date_range_start.unit_of_timeUnit Of Time (string)(Unit Of Time)required

Enum"days""months""weeks""years"

One of:

string(Unit Of Time)

Enum"days""months""weeks""years"

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

is_activeboolean(Is Active)

Whether or not the template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

process_installment_schedulesboolean(Process Installment Schedules)

If set, installment schedules should be processed

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

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

Response

application/json

{
  "business_unit_id": "string",
  "cancel_installment_schedules": true,
  "description": "string",
  "expiring_credit_card_reminder_options": {
    "order_type_restriction": "exclude",
    "order_types": { … },
    "reminders": [ … ]
  },
  "id": "string",
  "installment_schedule_cancellation_options": {
    "date_range_end": { … },
    "date_range_start": { … },
    "notice_id": "string",
    "order_type_restriction": "exclude",
    "order_types": { … }
  },
  "installment_schedule_options": {
    "card_type_restriction": "exclude",
    "card_types": { … },
    "date_range_end": { … },
    "date_range_start": { … },
    "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": [ … ]
  },
  "is_active": true,
  "name": "string",
  "notification_email": "string",
  "process_installment_schedules": true,
  "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"
  },
  "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
}

Business Units

Operations

Check Request Processes

Operations

Check Request Templates

Operations

Check Requests

Operations

Cogs Entries

Operations

Credit Memos

Operations

Credits

Operations

Currency Mapping Policies

Operations

Debit Memos

Operations

Departments

Operations

Donation Products

Operations

Exchange Rates

Operations

External Payments

Operations

Fiscal Years

Operations

Gateway Entities

Operations

Gateway Entries

Operations

Gateway Fees

Operations

Gl Accounts

Operations

Installment Plans

Operations

Installment Schedules

Operations

Invoice Payment Terms

Operations

Invoice Templates

Operations

Invoice Types

Operations

Invoices

Operations

Late Fee Rules

Operations

Late Fees

Operations

Legacy Import Products

Operations

Merchant Accounts

Operations

Miscellaneous Products

Operations

Payment Receipt Templates

Operations

Payments

Operations

Product Financial Configs

Operations

Query Definitions

Operations

Recurring Batches

Operations

Recurring Billing Runs

Operations

Refund Receipt Templates

Operations

Refunds

Operations

Revenue Recognition Schedules

Operations

Settings

Operations

Statement Templates

Operations

Statements

Operations

Statistics

Operations

Stored Payment Methods

Operations

Subledger Entries

Operations

Write Offs

Operations

Accounting Projects

Bank Accounts

Batch Assignment Settings

Batch Downloading

Batch Posting

Batch Templates

Batches

Billing Notices

Billing Run Actions

Billing Runs

Billing Templates

Gets all of the billing templates in the system.

Request

Responses

Was this helpful?

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

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a billing template from the system by its ID.

Request

Responses

Was this helpful?

Returns a billing template from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a billing template with the specified ID.

Request

Responses

Was this helpful?

Updates a billing template with the specified ID.

RequestExpand all

Responses

Was this helpful?

Business Units

Check Request Processes

Check Request Templates

Check Requests

Cogs Entries

Credit Memos

Credits

Currency Mapping Policies

Debit Memos

Departments

Donation Products

Exchange Rates

External Payments

Fiscal Years

Gateway Entities

Gateway Entries

Gateway Fees

Gl Accounts

Installment Plans

Installment Schedules

Invoice Payment Terms

Invoice Templates

Invoice Types

Invoices

Late Fee Rules

Late Fees

Legacy Import Products

Merchant Accounts

Miscellaneous Products

Payment Receipt Templates

Payments

Product Financial Configs

Query Definitions

Recurring Batches

Recurring Billing Runs

Refund Receipt Templates

Refunds

Revenue Recognition Schedules

Settings

Statement Templates

Statements

Request

Request

Request