Awards

Returns a setting from the system by its ID.

Awards (Awards & Nominations) (v1-2025-04-18)

Service providing access to Awards (Awards & Nominations) resources and features

Download OpenAPI description

awards-v1.json

awards-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/

https://awards.api.rhythmsoftware.com/

Application Fees

Operations

Application Processes

Operations

Application Status Reasons

Operations

Applications

Operations

Awards

Operations

Coupons

Operations

Nomination Processes

Operations

Nominations

Operations

Nominees

Operations

Query Definitions

Operations

Recipient Categories

Operations

Recipients

Operations

Reference Processes

Operations

Reference Types

Operations

References

Operations

Review Processes

Operations

Review Rounds

Operations

Reviews

Operations

Settings

Operations

Returns a setting from the system by its ID.

Request

This method will delete a setting with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

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

Responses

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

Request

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

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.

consistentReadstring

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

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

Responses

The setting was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

notesstring(Notes)

Notes on the settings

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

special_instructionsstring(Special Instructions)

Instructions shown to the user

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

Response

application/json

{
  "allow_customer_to_choose_installment_plan": true,
  "bank_account_id": "string",
  "bill_my_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "bill_my_parent_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "business_unit_id": "string",
  "cancellation_fee_product_id": "string",
  "checkout_donation_options": {
    "simple_checkout_donation_options": { … },
    "type": "simple"
  },
  "credit_card_minimum_range_end": 0.1,
  "credit_card_minimum_range_start": 0.1,
  "credit_card_mode": "disabled",
  "credit_card_processing_fee_mode": "charge",
  "credit_card_processing_fee_options": {
    "fee_percentage": 0.1,
    "maximum_fee": 0.1,
    "minimum_fee": 0.1,
    "product_id": "string",
    "prompt_sub_text": "string",
    "prompt_text": "string"
  },
  "disable_electronic_payment_vaulting": true,
  "enable_bill_my_organization": true,
  "enable_bill_my_parent_organization": true,
  "enable_donations_at_checkout": true,
  "enable_electronic_checks": true,
  "enable_pay_later": true,
  "enable_payroll_deduction": true,
  "enable_split_payments": true,
  "installment_plan_options": [
    { … }
  ],
  "invoice_payment_terms_id": "string",
  "invoice_template_id": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "pay_later_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "restocking_fee_product_id": "string",
  "special_instructions": "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,
  "use_pro_forma_invoices": true
}

Partially updates a setting with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

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)

The updated value

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/settings/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The setting was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

notesstring(Notes)

Notes on the settings

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

special_instructionsstring(Special Instructions)

Instructions shown to the user

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

Response

application/json

{
  "allow_customer_to_choose_installment_plan": true,
  "bank_account_id": "string",
  "bill_my_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "bill_my_parent_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "business_unit_id": "string",
  "cancellation_fee_product_id": "string",
  "checkout_donation_options": {
    "simple_checkout_donation_options": { … },
    "type": "simple"
  },
  "credit_card_minimum_range_end": 0.1,
  "credit_card_minimum_range_start": 0.1,
  "credit_card_mode": "disabled",
  "credit_card_processing_fee_mode": "charge",
  "credit_card_processing_fee_options": {
    "fee_percentage": 0.1,
    "maximum_fee": 0.1,
    "minimum_fee": 0.1,
    "product_id": "string",
    "prompt_sub_text": "string",
    "prompt_text": "string"
  },
  "disable_electronic_payment_vaulting": true,
  "enable_bill_my_organization": true,
  "enable_bill_my_parent_organization": true,
  "enable_donations_at_checkout": true,
  "enable_electronic_checks": true,
  "enable_pay_later": true,
  "enable_payroll_deduction": true,
  "enable_split_payments": true,
  "installment_plan_options": [
    { … }
  ],
  "invoice_payment_terms_id": "string",
  "invoice_template_id": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "pay_later_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "restocking_fee_product_id": "string",
  "special_instructions": "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,
  "use_pro_forma_invoices": true
}

Creates a new setting record that does not already exist.

Request

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.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The setting that you would like to be saved.

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

notesstring(Notes)

Notes on the settings

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

special_instructionsstring(Special Instructions)

Instructions shown to the user

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/settings/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allow_customer_to_choose_installment_plan": true,
    "bank_account_id": "string",
    "bill_my_organization_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "bill_my_parent_organization_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "business_unit_id": "string",
    "cancellation_fee_product_id": "string",
    "checkout_donation_options": {
      "simple_checkout_donation_options": {
        "allow_user_to_specify_custom_amount": true,
        "donation_ask_text": "string",
        "donation_denominations": [
          0.1
        ],
        "donation_information": "string",
        "donation_product_id": "string",
        "override_donation_denominations": true,
        "suggested_donation": 0.1
      },
      "type": "simple"
    },
    "credit_card_minimum_range_end": 0.1,
    "credit_card_minimum_range_start": 0.1,
    "credit_card_mode": "disabled",
    "credit_card_processing_fee_mode": "charge",
    "credit_card_processing_fee_options": {
      "fee_percentage": 0.1,
      "maximum_fee": 0.1,
      "minimum_fee": 0.1,
      "product_id": "string",
      "prompt_sub_text": "string",
      "prompt_text": "string"
    },
    "disable_electronic_payment_vaulting": true,
    "enable_bill_my_organization": true,
    "enable_bill_my_parent_organization": true,
    "enable_donations_at_checkout": true,
    "enable_electronic_checks": true,
    "enable_pay_later": true,
    "enable_payroll_deduction": true,
    "enable_split_payments": true,
    "installment_plan_options": [
      {
        "additional_cost": 0.1,
        "installment_plan_id": "string",
        "is_default": true
      }
    ],
    "invoice_payment_terms_id": "string",
    "invoice_template_id": "string",
    "merchant_account_id": "string",
    "notes": "string",
    "pay_later_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "restocking_fee_product_id": "string",
    "special_instructions": "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,
    "use_pro_forma_invoices": true
  }'

Responses

The setting was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

notesstring(Notes)

Notes on the settings

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

special_instructionsstring(Special Instructions)

Instructions shown to the user

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

Response

application/json

{
  "allow_customer_to_choose_installment_plan": true,
  "bank_account_id": "string",
  "bill_my_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "bill_my_parent_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "business_unit_id": "string",
  "cancellation_fee_product_id": "string",
  "checkout_donation_options": {
    "simple_checkout_donation_options": { … },
    "type": "simple"
  },
  "credit_card_minimum_range_end": 0.1,
  "credit_card_minimum_range_start": 0.1,
  "credit_card_mode": "disabled",
  "credit_card_processing_fee_mode": "charge",
  "credit_card_processing_fee_options": {
    "fee_percentage": 0.1,
    "maximum_fee": 0.1,
    "minimum_fee": 0.1,
    "product_id": "string",
    "prompt_sub_text": "string",
    "prompt_text": "string"
  },
  "disable_electronic_payment_vaulting": true,
  "enable_bill_my_organization": true,
  "enable_bill_my_parent_organization": true,
  "enable_donations_at_checkout": true,
  "enable_electronic_checks": true,
  "enable_pay_later": true,
  "enable_payroll_deduction": true,
  "enable_split_payments": true,
  "installment_plan_options": [
    { … }
  ],
  "invoice_payment_terms_id": "string",
  "invoice_template_id": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "pay_later_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "restocking_fee_product_id": "string",
  "special_instructions": "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,
  "use_pro_forma_invoices": true
}

Updates a setting with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The updated setting that will be saved.

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

notesstring(Notes)

Notes on the settings

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

special_instructionsstring(Special Instructions)

Instructions shown to the user

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/settings/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allow_customer_to_choose_installment_plan": true,
    "bank_account_id": "string",
    "bill_my_organization_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "bill_my_parent_organization_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "business_unit_id": "string",
    "cancellation_fee_product_id": "string",
    "checkout_donation_options": {
      "simple_checkout_donation_options": {
        "allow_user_to_specify_custom_amount": true,
        "donation_ask_text": "string",
        "donation_denominations": [
          0.1
        ],
        "donation_information": "string",
        "donation_product_id": "string",
        "override_donation_denominations": true,
        "suggested_donation": 0.1
      },
      "type": "simple"
    },
    "credit_card_minimum_range_end": 0.1,
    "credit_card_minimum_range_start": 0.1,
    "credit_card_mode": "disabled",
    "credit_card_processing_fee_mode": "charge",
    "credit_card_processing_fee_options": {
      "fee_percentage": 0.1,
      "maximum_fee": 0.1,
      "minimum_fee": 0.1,
      "product_id": "string",
      "prompt_sub_text": "string",
      "prompt_text": "string"
    },
    "disable_electronic_payment_vaulting": true,
    "enable_bill_my_organization": true,
    "enable_bill_my_parent_organization": true,
    "enable_donations_at_checkout": true,
    "enable_electronic_checks": true,
    "enable_pay_later": true,
    "enable_payroll_deduction": true,
    "enable_split_payments": true,
    "installment_plan_options": [
      {
        "additional_cost": 0.1,
        "installment_plan_id": "string",
        "is_default": true
      }
    ],
    "invoice_payment_terms_id": "string",
    "invoice_template_id": "string",
    "merchant_account_id": "string",
    "notes": "string",
    "pay_later_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "restocking_fee_product_id": "string",
    "special_instructions": "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,
    "use_pro_forma_invoices": true
  }'

Responses

The setting was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

notesstring(Notes)

Notes on the settings

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

special_instructionsstring(Special Instructions)

Instructions shown to the user

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

Response

application/json

{
  "allow_customer_to_choose_installment_plan": true,
  "bank_account_id": "string",
  "bill_my_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "bill_my_parent_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "business_unit_id": "string",
  "cancellation_fee_product_id": "string",
  "checkout_donation_options": {
    "simple_checkout_donation_options": { … },
    "type": "simple"
  },
  "credit_card_minimum_range_end": 0.1,
  "credit_card_minimum_range_start": 0.1,
  "credit_card_mode": "disabled",
  "credit_card_processing_fee_mode": "charge",
  "credit_card_processing_fee_options": {
    "fee_percentage": 0.1,
    "maximum_fee": 0.1,
    "minimum_fee": 0.1,
    "product_id": "string",
    "prompt_sub_text": "string",
    "prompt_text": "string"
  },
  "disable_electronic_payment_vaulting": true,
  "enable_bill_my_organization": true,
  "enable_bill_my_parent_organization": true,
  "enable_donations_at_checkout": true,
  "enable_electronic_checks": true,
  "enable_pay_later": true,
  "enable_payroll_deduction": true,
  "enable_split_payments": true,
  "installment_plan_options": [
    { … }
  ],
  "invoice_payment_terms_id": "string",
  "invoice_template_id": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "pay_later_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "restocking_fee_product_id": "string",
  "special_instructions": "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,
  "use_pro_forma_invoices": true
}

Statistics

Operations

Types

Operations

Awards (Awards & Nominations) (v1-2025-04-18)

Application Fees

Application Processes

Application Status Reasons

Applications

Awards

Categories

Coupons

Nomination Processes

Nominations

Nominees

Query Definitions

Recipient Categories

Recipients

Reference Processes

Reference Types

References

Review Processes

Review Rounds

Reviews

Settings

Returns a setting from the system by its ID.

Request

Responses

Was this helpful?

Returns a setting from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a setting with the specified ID.

Request

Responses

Was this helpful?

Creates a new setting record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Updates a setting with the specified ID.

RequestExpand all

Responses

Was this helpful?

Statistics

Types

Request

Request