Settings

Settings

Creates a new setting record that does not already exist.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The setting that you would like to be saved.

business_unit_id
required
string (Business Unit)

The business unit of the store

merchant_account_id
required
string (Merchant Account)

The merchant account that the store should use to receive payments

bank_account_id
required
string (Bank Account)

The default bank account that the store should use to receive payments

enable_split_payments
boolean (Enable Split Payments)

If set, users are allowed to split payments

enable_electronic_checks
boolean (Enable Electronic Checks)

If set, electronic checks are allowed

enable_payroll_deduction
boolean (Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_pay_later
boolean (Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

enable_bill_my_organization
boolean (Enable Bill My Organization)

If set, the user has the option to bill their organization

enable_bill_my_parent_organization
boolean (Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

use_pro_forma_invoices
boolean (Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

enable_donations_at_checkout
boolean (Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

restocking_fee_product_id
string (Restocking Fee Product)

The ID of the product used for restocking fees

cancellation_fee_product_id
string (Cancellation Fee Product)

The ID of the product used for cancellation fees

special_instructions
string (Special Instructions)

Instructions shown to the user

object (Pay Later Options)
object (Bill My Organization Options)
object (Bill My Parent Organization Options)
credit_card_mode
string (Credit Card Mode)

Determines whether or not credit cards are accepted

Enum: "enabled" "disabled" "range"
credit_card_minimum_range_start
number <float> (Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

credit_card_minimum_range_end
number <float> (Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

credit_card_processing_fee_mode
string (Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum: "do not charge" "charge" "prompt user"
required
object (Credit Card Processing Fee Options)
invoice_template_id
string (Invoice Template)

The template to use for invoices created during this process

invoice_payment_terms_id
string (Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

allow_customer_to_choose_installment_plan
boolean (Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

disable_electronic_payment_vaulting
boolean (Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

required
Array of objects non-empty
required
object (Checkout Donation Options)
apply_soft_credits_to_relationships
boolean (Apply Soft Credits To Relationships)

Whether or not to automatically apply soft credits to relationships

required
Array of objects non-empty
default_giving_process_id
required
string (Default Giving Process)

The default giving process, when non is specified

default_fund_id
required
string (Default Fund)

The default fund to use for donations

automatically_create_gifts_from_donations
boolean (Automatically Create Gifts From Donations)

If true, gifts are automatically created from donations

donation_product_giving_process_id
string (Donation Product Giving Process)

The giving process to use for donation products; if not set, the default giving process is used

required
Array of objects non-empty
automatic_donor_club_assignment
string (Automatic Donor Club Assignment)
Enum: "disabled" "by recent giving" "by lifetime giving"
preceding_months
required
number <float> (Preceding Months) >= 1
required
Array of objects non-empty
notes
string (Notes)

The notes on the setting

sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (Sys Bulk Load Pk)

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

sys_bulk_load_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

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

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

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

sys_has_files_in_s3
boolean (Sys Has Files In S3)

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

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200The setting was saved successfully.
400The setting you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The setting could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add setting based on tenant limits.
500General server error.
post/settings/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    },
  • "apply_soft_credits_to_relationships": true,
  • "soft_credit_relationships": [
    ],
  • "default_giving_process_id": "string",
  • "default_fund_id": "string",
  • "automatically_create_gifts_from_donations": true,
  • "donation_product_giving_process_id": "string",
  • "donation_fund_mappings": [
    ],
  • "automatic_donor_club_assignment": "disabled",
  • "preceding_months": 1,
  • "donor_club_giving_tiers": [
    ],
  • "notes": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    },
  • "apply_soft_credits_to_relationships": true,
  • "soft_credit_relationships": [
    ],
  • "default_giving_process_id": "string",
  • "default_fund_id": "string",
  • "automatically_create_gifts_from_donations": true,
  • "donation_product_giving_process_id": "string",
  • "donation_fund_mappings": [
    ],
  • "automatic_donor_club_assignment": "disabled",
  • "preceding_months": 1,
  • "donor_club_giving_tiers": [
    ],
  • "notes": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a setting from the system by its ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

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

consistentRead
string

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

Responses
200The setting was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The setting could not be found.
429Limit exceeded... unable to retrieve setting based on tenant limits.
500General server error.
get/settings/{tenantId}
Request samples
curl -i -X GET \
  'https://fundraising.api.756794052567.rhythmsoftware.com/settings/:tenantId?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    },
  • "apply_soft_credits_to_relationships": true,
  • "soft_credit_relationships": [
    ],
  • "default_giving_process_id": "string",
  • "default_fund_id": "string",
  • "automatically_create_gifts_from_donations": true,
  • "donation_product_giving_process_id": "string",
  • "donation_fund_mappings": [
    ],
  • "automatic_donor_club_assignment": "disabled",
  • "preceding_months": 1,
  • "donor_club_giving_tiers": [
    ],
  • "notes": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a setting with the specified ID.

This method will update an existing setting with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The updated setting that will be saved.

business_unit_id
required
string (Business Unit)

The business unit of the store

merchant_account_id
required
string (Merchant Account)

The merchant account that the store should use to receive payments

bank_account_id
required
string (Bank Account)

The default bank account that the store should use to receive payments

enable_split_payments
boolean (Enable Split Payments)

If set, users are allowed to split payments

enable_electronic_checks
boolean (Enable Electronic Checks)

If set, electronic checks are allowed

enable_payroll_deduction
boolean (Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_pay_later
boolean (Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

enable_bill_my_organization
boolean (Enable Bill My Organization)

If set, the user has the option to bill their organization

enable_bill_my_parent_organization
boolean (Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

use_pro_forma_invoices
boolean (Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

enable_donations_at_checkout
boolean (Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

restocking_fee_product_id
string (Restocking Fee Product)

The ID of the product used for restocking fees

cancellation_fee_product_id
string (Cancellation Fee Product)

The ID of the product used for cancellation fees

special_instructions
string (Special Instructions)

Instructions shown to the user

object (Pay Later Options)
object (Bill My Organization Options)
object (Bill My Parent Organization Options)
credit_card_mode
string (Credit Card Mode)

Determines whether or not credit cards are accepted

Enum: "enabled" "disabled" "range"
credit_card_minimum_range_start
number <float> (Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

credit_card_minimum_range_end
number <float> (Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

credit_card_processing_fee_mode
string (Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum: "do not charge" "charge" "prompt user"
required
object (Credit Card Processing Fee Options)
invoice_template_id
string (Invoice Template)

The template to use for invoices created during this process

invoice_payment_terms_id
string (Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

allow_customer_to_choose_installment_plan
boolean (Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

disable_electronic_payment_vaulting
boolean (Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

required
Array of objects non-empty
required
object (Checkout Donation Options)
apply_soft_credits_to_relationships
boolean (Apply Soft Credits To Relationships)

Whether or not to automatically apply soft credits to relationships

required
Array of objects non-empty
default_giving_process_id
required
string (Default Giving Process)

The default giving process, when non is specified

default_fund_id
required
string (Default Fund)

The default fund to use for donations

automatically_create_gifts_from_donations
boolean (Automatically Create Gifts From Donations)

If true, gifts are automatically created from donations

donation_product_giving_process_id
string (Donation Product Giving Process)

The giving process to use for donation products; if not set, the default giving process is used

required
Array of objects non-empty
automatic_donor_club_assignment
string (Automatic Donor Club Assignment)
Enum: "disabled" "by recent giving" "by lifetime giving"
preceding_months
required
number <float> (Preceding Months) >= 1
required
Array of objects non-empty
notes
string (Notes)

The notes on the setting

sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (Sys Bulk Load Pk)

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

sys_bulk_load_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

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

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

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

sys_has_files_in_s3
boolean (Sys Has Files In S3)

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

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200The setting was updated successfully.
400The setting supplied was not valid.
401Unauthorized.
403Forbidden.
404The setting could not be found.
409The setting could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve setting based on tenant limits.
500General server error.
put/settings/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    },
  • "apply_soft_credits_to_relationships": true,
  • "soft_credit_relationships": [
    ],
  • "default_giving_process_id": "string",
  • "default_fund_id": "string",
  • "automatically_create_gifts_from_donations": true,
  • "donation_product_giving_process_id": "string",
  • "donation_fund_mappings": [
    ],
  • "automatic_donor_club_assignment": "disabled",
  • "preceding_months": 1,
  • "donor_club_giving_tiers": [
    ],
  • "notes": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    },
  • "apply_soft_credits_to_relationships": true,
  • "soft_credit_relationships": [
    ],
  • "default_giving_process_id": "string",
  • "default_fund_id": "string",
  • "automatically_create_gifts_from_donations": true,
  • "donation_product_giving_process_id": "string",
  • "donation_fund_mappings": [
    ],
  • "automatic_donor_club_assignment": "disabled",
  • "preceding_months": 1,
  • "donor_club_giving_tiers": [
    ],
  • "notes": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a setting with the specified ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The setting was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The setting could not be found.
409The setting could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve setting based on tenant limits.
500General server error.
patch/settings/{tenantId}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    },
  • "apply_soft_credits_to_relationships": true,
  • "soft_credit_relationships": [
    ],
  • "default_giving_process_id": "string",
  • "default_fund_id": "string",
  • "automatically_create_gifts_from_donations": true,
  • "donation_product_giving_process_id": "string",
  • "donation_fund_mappings": [
    ],
  • "automatic_donor_club_assignment": "disabled",
  • "preceding_months": 1,
  • "donor_club_giving_tiers": [
    ],
  • "notes": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a setting from the system by its ID.

This method will delete a setting with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Responses
200The setting was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The setting could not be found.
409The setting could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete setting based on tenant limits.
500General server error.
delete/settings/{tenantId}
Request samples
curl -i -X DELETE \
  https://fundraising.api.756794052567.rhythmsoftware.com/settings/:tenantId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"