The Membership API provides all the capabilities for managing your membership. Although it is most commonly used to look up the membership information for a single contact or organization, it can also be used to approve, modify, or drop members.
Like most of the other Rhythm apps, the Membership API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/
https://membership.api.rhythmsoftware.com/
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}
https://membership.api.rhythmsoftware.com/groupApplicationProcesses/{tenantId}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The group application processeswere retrieved successfully.
If set, the process used for account deletion if the group admin wants to join/renew members they do not own
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The contact form to show to group administrators when they are registering individuals
The contact roles that can perform group registration
The criteria for eligibility
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If set, then group administrators can request to be delegates for contacts not tied to their organization
If set, only certain people/organizations can use this process
Instructions to show to group administrators
The membership packages that are applicable to this process
The membership types that are applicable to this process
Whether or not to override POC settings
If true, only certain contact roles can perform group registration
If true, only certain membership packages are applicable to this process
If true, only certain membership types are applicable to this process
If true, an email is sent to the administrator of the group once registration is complete
If set, group administrators see instructions
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The amount/percentage to discount
The end range for this rule (one-based)
[ { "account_delegation_process_id": "string", "checkout_settings": { … }, "contact_form_id": "string", "contact_role_ids": [ … ], "description": "string", "display_in_portal": true, "display_in_portal_as": "string", "eligibility_criteria": { … }, "enable_account_delegation": true, "enable_eligibility_criteria": true, "enable_tiered_discounts": true, "group_administrator_confirmation_email": { … }, "group_administrator_instructions": "string", "id": "string", "is_active": true, "membership_package_ids": [ … ], "membership_type_ids": [ … ], "name": "string", "override_checkout_settings": true, "restrict_to_specific_contact_roles": true, "restrict_to_specific_membership_packages": true, "restrict_to_specific_membership_types": true, "send_confirmation_email_to_group_administrator": true, "show_instructions_to_group_administrators": true, "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, "tiered_discount_rules": [ … ] } ]
The group application process that you would like to be saved.
If set, the process used for account deletion if the group admin wants to join/renew members they do not own
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The contact form to show to group administrators when they are registering individuals
The contact roles that can perform group registration
The criteria for eligibility
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If set, then group administrators can request to be delegates for contacts not tied to their organization
If set, only certain people/organizations can use this process
Instructions to show to group administrators
The membership packages that are applicable to this process
The membership types that are applicable to this process
Whether or not to override POC settings
If true, only certain contact roles can perform group registration
If true, only certain membership packages are applicable to this process
If true, only certain membership types are applicable to this process
If true, an email is sent to the administrator of the group once registration is complete
If set, group administrators see instructions
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The amount/percentage to discount
The end range for this rule (one-based)
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}
https://membership.api.rhythmsoftware.com/groupApplicationProcesses/{tenantId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"account_delegation_process_id": "string",
"checkout_settings": {
"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"
},
"custom_order_preprocessing_options": {
"lambda_function_id": "string"
},
"custom_order_pricing_options": {
"lambda_function_id": "string"
},
"disable_electronic_payment_vaulting": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"enable_custom_order_preprocessing": true,
"enable_custom_order_pricing": 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": {
"0": {
"additional_cost": 0.1,
"installment_plan_id": "string",
"is_default": true
}
},
"invoice_payment_terms_id": "string",
"invoice_template_id": "string",
"merchant_account_id": "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",
"use_pro_forma_invoices": true
},
"contact_form_id": "string",
"contact_role_ids": [
"string"
],
"description": "string",
"display_in_portal": true,
"display_in_portal_as": "string",
"eligibility_criteria": {
"advanced_rule_error_message": "string",
"advanced_rules": {},
"age_restrictions": {
"maximum_age": 0.1,
"minimum_age": 0.1
},
"award_options": {
"award_ids": [
"string"
],
"award_type_ids": [
"string"
],
"logic_operator": "and"
},
"award_recipients": true,
"by_location": true,
"certificants": true,
"certification_options": {
"logic_operator": "and",
"program_ids": [
"string"
]
},
"committee_member_options": {
"committee_ids": [
"string"
],
"committee_position_ids": [
"string"
],
"committee_type_ids": [
"string"
],
"logic_operator": "and"
},
"committee_members": true,
"custom_logic_options": {
"lambda_function_id": "string"
},
"customer_type": "contact",
"donor_options": {
"donor_club_ids": [
"string"
],
"logic_operator": "and"
},
"donors": true,
"enable_advanced_rules": true,
"enable_age_restrictions": true,
"enable_custom_logic": true,
"enable_entitlement_restrictions": true,
"enable_expression": true,
"enable_organization_restrictions": true,
"enable_status_restriction": true,
"entitlement_restrictions": [
{
"quantity": 0.1,
"type_id": "string"
}
],
"event_registration_options": {
"event_ids": [
"string"
],
"logic_operator": "and",
"registration_category_ids": [
"string"
]
},
"event_registrations": true,
"expression": "string",
"expression_error_message": "string",
"location": {
"countries": [
"string"
],
"negate_logic": true
},
"logic_operator": "and",
"member_options": {
"chapter_member_options": {
"chapter_ids": [
"string"
],
"chapter_type_ids": [
"string"
],
"logic_operator": "and"
},
"chapter_members": true,
"member_package_ids": [
"string"
],
"member_status_reason_ids": [
"string"
],
"member_statuses": [
"active"
],
"member_type_ids": [
"string"
],
"section_member_options": {
"logic_operator": "and",
"section_ids": [
"string"
],
"section_type_ids": [
"string"
]
},
"section_members": true
},
"members": true,
"non_members": true,
"organization_restrictions": {
"contact_role_ids": [
"string"
],
"organization_type_ids": [
"string"
]
},
"status_restrictions": {
"0": "string"
},
"use_organization_for_eligibility": true
},
"enable_account_delegation": true,
"enable_eligibility_criteria": true,
"enable_tiered_discounts": true,
"group_administrator_confirmation_email": {
"bcc": "string",
"body": "string",
"cc": "string",
"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string"
},
"group_administrator_instructions": "string",
"id": "string",
"is_active": true,
"membership_package_ids": [
"string"
],
"membership_type_ids": [
"string"
],
"name": "string",
"override_checkout_settings": true,
"restrict_to_specific_contact_roles": true,
"restrict_to_specific_membership_packages": true,
"restrict_to_specific_membership_types": true,
"send_confirmation_email_to_group_administrator": true,
"show_instructions_to_group_administrators": true,
"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,
"tiered_discount_rules": [
{
"discount_amount": 0.1,
"discount_type": "amount",
"end_range": 1,
"start_range": 1
}
]
}'The group application process was saved successfully.
If set, the process used for account deletion if the group admin wants to join/renew members they do not own
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The contact form to show to group administrators when they are registering individuals
The contact roles that can perform group registration
The criteria for eligibility
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If set, then group administrators can request to be delegates for contacts not tied to their organization
If set, only certain people/organizations can use this process
Instructions to show to group administrators
The membership packages that are applicable to this process
The membership types that are applicable to this process
Whether or not to override POC settings
If true, only certain contact roles can perform group registration
If true, only certain membership packages are applicable to this process
If true, only certain membership types are applicable to this process
If true, an email is sent to the administrator of the group once registration is complete
If set, group administrators see instructions
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The amount/percentage to discount
The end range for this rule (one-based)
{ "account_delegation_process_id": "string", "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": { … }, "bill_my_parent_organization_options": { … }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": { … }, "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": { … }, "custom_order_preprocessing_options": { … }, "custom_order_pricing_options": { … }, "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": 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", "pay_later_options": { … }, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "contact_form_id": "string", "contact_role_ids": [ "string" ], "description": "string", "display_in_portal": true, "display_in_portal_as": "string", "eligibility_criteria": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_account_delegation": true, "enable_eligibility_criteria": true, "enable_tiered_discounts": true, "group_administrator_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "group_administrator_instructions": "string", "id": "string", "is_active": true, "membership_package_ids": [ "string" ], "membership_type_ids": [ "string" ], "name": "string", "override_checkout_settings": true, "restrict_to_specific_contact_roles": true, "restrict_to_specific_membership_packages": true, "restrict_to_specific_membership_types": true, "send_confirmation_email_to_group_administrator": true, "show_instructions_to_group_administrators": true, "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, "tiered_discount_rules": [ { … } ] }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}/batch
https://membership.api.rhythmsoftware.com/groupApplicationProcesses/{tenantId}/batch
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}/batch' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"operations": [
{
"id": null,
"object": {},
"operation": "create",
"patch_directives": {
"0": {
"op": "add",
"path": "string",
"value": "string"
}
}
}
]
}'{ "error_count": 0.1, "results": [ { … } ], "success_count": 0.1 }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}/eligible/{contactId}
https://membership.api.rhythmsoftware.com/groupApplicationProcesses/{tenantId}/eligible/{contactId}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}/eligible/{contactId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Processes were retrieved successfully
If set, the process used for account deletion if the group admin wants to join/renew members they do not own
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The contact form to show to group administrators when they are registering individuals
The contact roles that can perform group registration
The criteria for eligibility
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If set, then group administrators can request to be delegates for contacts not tied to their organization
If set, only certain people/organizations can use this process
Instructions to show to group administrators
The membership packages that are applicable to this process
The membership types that are applicable to this process
Whether or not to override POC settings
If true, only certain contact roles can perform group registration
If true, only certain membership packages are applicable to this process
If true, only certain membership types are applicable to this process
If true, an email is sent to the administrator of the group once registration is complete
If set, group administrators see instructions
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The amount/percentage to discount
The end range for this rule (one-based)
[ { "account_delegation_process_id": "string", "checkout_settings": { … }, "contact_form_id": "string", "contact_role_ids": [ … ], "description": "string", "display_in_portal": true, "display_in_portal_as": "string", "eligibility_criteria": { … }, "enable_account_delegation": true, "enable_eligibility_criteria": true, "enable_tiered_discounts": true, "group_administrator_confirmation_email": { … }, "group_administrator_instructions": "string", "id": "string", "is_active": true, "membership_package_ids": [ … ], "membership_type_ids": [ … ], "name": "string", "override_checkout_settings": true, "restrict_to_specific_contact_roles": true, "restrict_to_specific_membership_packages": true, "restrict_to_specific_membership_types": true, "send_confirmation_email_to_group_administrator": true, "show_instructions_to_group_administrators": true, "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, "tiered_discount_rules": [ … ] } ]
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}/{id}
https://membership.api.rhythmsoftware.com/groupApplicationProcesses/{tenantId}/{id}
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}/{id}
https://membership.api.rhythmsoftware.com/groupApplicationProcesses/{tenantId}/{id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The group application process was retrieved successfully.
If set, the process used for account deletion if the group admin wants to join/renew members they do not own
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The contact form to show to group administrators when they are registering individuals
The contact roles that can perform group registration
The criteria for eligibility
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If set, then group administrators can request to be delegates for contacts not tied to their organization
If set, only certain people/organizations can use this process
Instructions to show to group administrators
The membership packages that are applicable to this process
The membership types that are applicable to this process
Whether or not to override POC settings
If true, only certain contact roles can perform group registration
If true, only certain membership packages are applicable to this process
If true, only certain membership types are applicable to this process
If true, an email is sent to the administrator of the group once registration is complete
If set, group administrators see instructions
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The amount/percentage to discount
The end range for this rule (one-based)
{ "account_delegation_process_id": "string", "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": { … }, "bill_my_parent_organization_options": { … }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": { … }, "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": { … }, "custom_order_preprocessing_options": { … }, "custom_order_pricing_options": { … }, "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": 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", "pay_later_options": { … }, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "contact_form_id": "string", "contact_role_ids": [ "string" ], "description": "string", "display_in_portal": true, "display_in_portal_as": "string", "eligibility_criteria": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_account_delegation": true, "enable_eligibility_criteria": true, "enable_tiered_discounts": true, "group_administrator_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "group_administrator_instructions": "string", "id": "string", "is_active": true, "membership_package_ids": [ "string" ], "membership_type_ids": [ "string" ], "name": "string", "override_checkout_settings": true, "restrict_to_specific_contact_roles": true, "restrict_to_specific_membership_packages": true, "restrict_to_specific_membership_types": true, "send_confirmation_email_to_group_administrator": true, "show_instructions_to_group_administrators": true, "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, "tiered_discount_rules": [ { … } ] }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}/{id}
https://membership.api.rhythmsoftware.com/groupApplicationProcesses/{tenantId}/{id}
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The group application process was patched successfully.
If set, the process used for account deletion if the group admin wants to join/renew members they do not own
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The contact form to show to group administrators when they are registering individuals
The contact roles that can perform group registration
The criteria for eligibility
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If set, then group administrators can request to be delegates for contacts not tied to their organization
If set, only certain people/organizations can use this process
Instructions to show to group administrators
The membership packages that are applicable to this process
The membership types that are applicable to this process
Whether or not to override POC settings
If true, only certain contact roles can perform group registration
If true, only certain membership packages are applicable to this process
If true, only certain membership types are applicable to this process
If true, an email is sent to the administrator of the group once registration is complete
If set, group administrators see instructions
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The amount/percentage to discount
The end range for this rule (one-based)
{ "account_delegation_process_id": "string", "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": { … }, "bill_my_parent_organization_options": { … }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": { … }, "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": { … }, "custom_order_preprocessing_options": { … }, "custom_order_pricing_options": { … }, "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": 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", "pay_later_options": { … }, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "contact_form_id": "string", "contact_role_ids": [ "string" ], "description": "string", "display_in_portal": true, "display_in_portal_as": "string", "eligibility_criteria": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_account_delegation": true, "enable_eligibility_criteria": true, "enable_tiered_discounts": true, "group_administrator_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "group_administrator_instructions": "string", "id": "string", "is_active": true, "membership_package_ids": [ "string" ], "membership_type_ids": [ "string" ], "name": "string", "override_checkout_settings": true, "restrict_to_specific_contact_roles": true, "restrict_to_specific_membership_packages": true, "restrict_to_specific_membership_types": true, "send_confirmation_email_to_group_administrator": true, "show_instructions_to_group_administrators": true, "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, "tiered_discount_rules": [ { … } ] }
The updated group application process that will be saved.
If set, the process used for account deletion if the group admin wants to join/renew members they do not own
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The contact form to show to group administrators when they are registering individuals
The contact roles that can perform group registration
The criteria for eligibility
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If set, then group administrators can request to be delegates for contacts not tied to their organization
If set, only certain people/organizations can use this process
Instructions to show to group administrators
The membership packages that are applicable to this process
The membership types that are applicable to this process
Whether or not to override POC settings
If true, only certain contact roles can perform group registration
If true, only certain membership packages are applicable to this process
If true, only certain membership types are applicable to this process
If true, an email is sent to the administrator of the group once registration is complete
If set, group administrators see instructions
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The amount/percentage to discount
The end range for this rule (one-based)
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}/{id}
https://membership.api.rhythmsoftware.com/groupApplicationProcesses/{tenantId}/{id}
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/groupApplicationProcesses/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"account_delegation_process_id": "string",
"checkout_settings": {
"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"
},
"custom_order_preprocessing_options": {
"lambda_function_id": "string"
},
"custom_order_pricing_options": {
"lambda_function_id": "string"
},
"disable_electronic_payment_vaulting": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"enable_custom_order_preprocessing": true,
"enable_custom_order_pricing": 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": {
"0": {
"additional_cost": 0.1,
"installment_plan_id": "string",
"is_default": true
}
},
"invoice_payment_terms_id": "string",
"invoice_template_id": "string",
"merchant_account_id": "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",
"use_pro_forma_invoices": true
},
"contact_form_id": "string",
"contact_role_ids": [
"string"
],
"description": "string",
"display_in_portal": true,
"display_in_portal_as": "string",
"eligibility_criteria": {
"advanced_rule_error_message": "string",
"advanced_rules": {},
"age_restrictions": {
"maximum_age": 0.1,
"minimum_age": 0.1
},
"award_options": {
"award_ids": [
"string"
],
"award_type_ids": [
"string"
],
"logic_operator": "and"
},
"award_recipients": true,
"by_location": true,
"certificants": true,
"certification_options": {
"logic_operator": "and",
"program_ids": [
"string"
]
},
"committee_member_options": {
"committee_ids": [
"string"
],
"committee_position_ids": [
"string"
],
"committee_type_ids": [
"string"
],
"logic_operator": "and"
},
"committee_members": true,
"custom_logic_options": {
"lambda_function_id": "string"
},
"customer_type": "contact",
"donor_options": {
"donor_club_ids": [
"string"
],
"logic_operator": "and"
},
"donors": true,
"enable_advanced_rules": true,
"enable_age_restrictions": true,
"enable_custom_logic": true,
"enable_entitlement_restrictions": true,
"enable_expression": true,
"enable_organization_restrictions": true,
"enable_status_restriction": true,
"entitlement_restrictions": [
{
"quantity": 0.1,
"type_id": "string"
}
],
"event_registration_options": {
"event_ids": [
"string"
],
"logic_operator": "and",
"registration_category_ids": [
"string"
]
},
"event_registrations": true,
"expression": "string",
"expression_error_message": "string",
"location": {
"countries": [
"string"
],
"negate_logic": true
},
"logic_operator": "and",
"member_options": {
"chapter_member_options": {
"chapter_ids": [
"string"
],
"chapter_type_ids": [
"string"
],
"logic_operator": "and"
},
"chapter_members": true,
"member_package_ids": [
"string"
],
"member_status_reason_ids": [
"string"
],
"member_statuses": [
"active"
],
"member_type_ids": [
"string"
],
"section_member_options": {
"logic_operator": "and",
"section_ids": [
"string"
],
"section_type_ids": [
"string"
]
},
"section_members": true
},
"members": true,
"non_members": true,
"organization_restrictions": {
"contact_role_ids": [
"string"
],
"organization_type_ids": [
"string"
]
},
"status_restrictions": {
"0": "string"
},
"use_organization_for_eligibility": true
},
"enable_account_delegation": true,
"enable_eligibility_criteria": true,
"enable_tiered_discounts": true,
"group_administrator_confirmation_email": {
"bcc": "string",
"body": "string",
"cc": "string",
"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string"
},
"group_administrator_instructions": "string",
"id": "string",
"is_active": true,
"membership_package_ids": [
"string"
],
"membership_type_ids": [
"string"
],
"name": "string",
"override_checkout_settings": true,
"restrict_to_specific_contact_roles": true,
"restrict_to_specific_membership_packages": true,
"restrict_to_specific_membership_types": true,
"send_confirmation_email_to_group_administrator": true,
"show_instructions_to_group_administrators": true,
"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,
"tiered_discount_rules": [
{
"discount_amount": 0.1,
"discount_type": "amount",
"end_range": 1,
"start_range": 1
}
]
}'The group application process was updated successfully.
If set, the process used for account deletion if the group admin wants to join/renew members they do not own
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
The contact form to show to group administrators when they are registering individuals
The contact roles that can perform group registration
The criteria for eligibility
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
If set, then group administrators can request to be delegates for contacts not tied to their organization
If set, only certain people/organizations can use this process
Instructions to show to group administrators
The membership packages that are applicable to this process
The membership types that are applicable to this process
Whether or not to override POC settings
If true, only certain contact roles can perform group registration
If true, only certain membership packages are applicable to this process
If true, only certain membership types are applicable to this process
If true, an email is sent to the administrator of the group once registration is complete
If set, group administrators see instructions
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The amount/percentage to discount
The end range for this rule (one-based)
{ "account_delegation_process_id": "string", "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": { … }, "bill_my_parent_organization_options": { … }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": { … }, "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": { … }, "custom_order_preprocessing_options": { … }, "custom_order_pricing_options": { … }, "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": 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", "pay_later_options": { … }, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "contact_form_id": "string", "contact_role_ids": [ "string" ], "description": "string", "display_in_portal": true, "display_in_portal_as": "string", "eligibility_criteria": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_account_delegation": true, "enable_eligibility_criteria": true, "enable_tiered_discounts": true, "group_administrator_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "group_administrator_instructions": "string", "id": "string", "is_active": true, "membership_package_ids": [ "string" ], "membership_type_ids": [ "string" ], "name": "string", "override_checkout_settings": true, "restrict_to_specific_contact_roles": true, "restrict_to_specific_membership_packages": true, "restrict_to_specific_membership_types": true, "send_confirmation_email_to_group_administrator": true, "show_instructions_to_group_administrators": true, "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, "tiered_discount_rules": [ { … } ] }