Fees

Creates a new fee record that does not already exist.

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The fee that you would like to be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this miscellaneous product
type	string (Type) The product type Value: "certifications-fees"
name required	string (Name) The name of the miscellaneous product
business_unit_id required	string (Business Unit) The business unit of the product
price required	number <double> (Price) The price of the product
member_price	number <double> (Member Price) The price of the product for an active member
enable_cancellation_fees	boolean (Enable Cancellation Fees) Whether or not cancellation fees are applicable
cancellation_fee	number <double> (Cancellation Fee) Cancellation fees associated with this product
enable_purchasing_eligibility	boolean (Enable Purchasing Eligibility) If set, purchases of this merchandise are restricted
required	object (Purchasing Eligibility Criteria)
allow_customer_to_choose_installment_plan	boolean (Allow Customer To Choose Installment Plan) If true, the customer can choose their installment plan
enable_bundled_products	boolean (Enable Bundled Products) Whether to enable bundled products
required	Array of objects non-empty
	Array of objects
is_active	boolean (Is Active) Whether this product is active/used
required	Array of objects non-empty
bundled_products_inventory_handling	string (Bundled Products Inventory Handling) Whether to track inventory for the entire bundle, or for each product separately Enum: "bundle" "each product"
publish_to_portal	boolean (Publish To Portal) Whether or not this product should be available in the portal
	object (Portal Options)
notes	string (Notes) Notes
	Array of objects (Custom Field Values)
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic

Responses

200The fee was saved successfully.

400The fee you supplied was invalid.

401Unauthorized.

403Forbidden.

409The fee could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add fee based on tenant limits.

500General server error.

post/fees/{tenantId}

Request samples

application/json

{"id": "string",
"type": "certifications-fees",
"name": "string",
"business_unit_id": "string",
"price": 0,
"member_price": 0,
"enable_cancellation_fees": true,
"cancellation_fee": 0,
"enable_purchasing_eligibility": true,
"purchasing_eligibility_criteria": {"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"program_ids": ["string"
]
},
"minimum_age": 0,
"maximum_age": 0
},
"allow_customer_to_choose_installment_plan": true,
"enable_bundled_products": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"foreign_currency_prices": [{"currency_code": "AED",
"price": 0,
"member_price": 0,
"cancellation_fee": 0,
"restocking_fee": 0
}
],
"is_active": true,
"bundled_products": [{"type": "bundled product",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"bundled_products_inventory_handling": "bundle",
"publish_to_portal": true,
"portal_options": {"available_from": "2019-08-24T14:15:22Z",
"available_until": "2019-08-24T14:15:22Z"
},
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Response samples

application/json

{"id": "string",
"type": "certifications-fees",
"name": "string",
"business_unit_id": "string",
"price": 0,
"member_price": 0,
"enable_cancellation_fees": true,
"cancellation_fee": 0,
"enable_purchasing_eligibility": true,
"purchasing_eligibility_criteria": {"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"program_ids": ["string"
]
},
"minimum_age": 0,
"maximum_age": 0
},
"allow_customer_to_choose_installment_plan": true,
"enable_bundled_products": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"foreign_currency_prices": [{"currency_code": "AED",
"price": 0,
"member_price": 0,
"cancellation_fee": 0,
"restocking_fee": 0
}
],
"is_active": true,
"bundled_products": [{"type": "bundled product",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"bundled_products_inventory_handling": "bundle",
"publish_to_portal": true,
"portal_options": {"available_from": "2019-08-24T14:15:22Z",
"available_until": "2019-08-24T14:15:22Z"
},
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Gets all of the fees in the system.

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
exclusiveStartKey	string The start key, if you're making a subsequent request

Responses

200The feeswere retrieved successfully.

400The request was invalid.

401Unauthorized.

403Forbidden.

429Limit exceeded... unable to add contact role based on tenant limits.

500General server error.

get/fees/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/fees/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

[{"id": "string",
"type": "certifications-fees",
"name": "string",
"business_unit_id": "string",
"price": 0,
"member_price": 0,
"enable_cancellation_fees": true,
"cancellation_fee": 0,
"enable_purchasing_eligibility": true,
"purchasing_eligibility_criteria": {"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"program_ids": ["string"
]
},
"minimum_age": 0,
"maximum_age": 0
},
"allow_customer_to_choose_installment_plan": true,
"enable_bundled_products": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"foreign_currency_prices": [{"currency_code": "AED",
"price": 0,
"member_price": 0,
"cancellation_fee": 0,
"restocking_fee": 0
}
],
"is_active": true,
"bundled_products": [{"type": "bundled product",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"bundled_products_inventory_handling": "bundle",
"publish_to_portal": true,
"portal_options": {"available_from": "2019-08-24T14:15:22Z",
"available_until": "2019-08-24T14:15:22Z"
},
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}
]

Returns a fee from the system by its ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the fee to return.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The fee was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The fee could not be found.

429Limit exceeded... unable to retrieve fee based on tenant limits.

500General server error.

get/fees/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://certifications.api.756794052567.rhythmsoftware.com/fees/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"type": "certifications-fees",
"name": "string",
"business_unit_id": "string",
"price": 0,
"member_price": 0,
"enable_cancellation_fees": true,
"cancellation_fee": 0,
"enable_purchasing_eligibility": true,
"purchasing_eligibility_criteria": {"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"program_ids": ["string"
]
},
"minimum_age": 0,
"maximum_age": 0
},
"allow_customer_to_choose_installment_plan": true,
"enable_bundled_products": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"foreign_currency_prices": [{"currency_code": "AED",
"price": 0,
"member_price": 0,
"cancellation_fee": 0,
"restocking_fee": 0
}
],
"is_active": true,
"bundled_products": [{"type": "bundled product",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"bundled_products_inventory_handling": "bundle",
"publish_to_portal": true,
"portal_options": {"available_from": "2019-08-24T14:15:22Z",
"available_until": "2019-08-24T14:15:22Z"
},
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Updates a fee with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the fee to update.

Request Body schema: application/json

The updated fee that will be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this miscellaneous product
type	string (Type) The product type Value: "certifications-fees"
name required	string (Name) The name of the miscellaneous product
business_unit_id required	string (Business Unit) The business unit of the product
price required	number <double> (Price) The price of the product
member_price	number <double> (Member Price) The price of the product for an active member
enable_cancellation_fees	boolean (Enable Cancellation Fees) Whether or not cancellation fees are applicable
cancellation_fee	number <double> (Cancellation Fee) Cancellation fees associated with this product
enable_purchasing_eligibility	boolean (Enable Purchasing Eligibility) If set, purchases of this merchandise are restricted
required	object (Purchasing Eligibility Criteria)
allow_customer_to_choose_installment_plan	boolean (Allow Customer To Choose Installment Plan) If true, the customer can choose their installment plan
enable_bundled_products	boolean (Enable Bundled Products) Whether to enable bundled products
required	Array of objects non-empty
	Array of objects
is_active	boolean (Is Active) Whether this product is active/used
required	Array of objects non-empty
bundled_products_inventory_handling	string (Bundled Products Inventory Handling) Whether to track inventory for the entire bundle, or for each product separately Enum: "bundle" "each product"
publish_to_portal	boolean (Publish To Portal) Whether or not this product should be available in the portal
	object (Portal Options)
notes	string (Notes) Notes
	Array of objects (Custom Field Values)
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic

Responses

200The fee was updated successfully.

400The fee supplied was not valid.

401Unauthorized.

403Forbidden.

404The fee could not be found.

409The fee could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve fee based on tenant limits.

500General server error.

put/fees/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"type": "certifications-fees",
"name": "string",
"business_unit_id": "string",
"price": 0,
"member_price": 0,
"enable_cancellation_fees": true,
"cancellation_fee": 0,
"enable_purchasing_eligibility": true,
"purchasing_eligibility_criteria": {"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"program_ids": ["string"
]
},
"minimum_age": 0,
"maximum_age": 0
},
"allow_customer_to_choose_installment_plan": true,
"enable_bundled_products": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"foreign_currency_prices": [{"currency_code": "AED",
"price": 0,
"member_price": 0,
"cancellation_fee": 0,
"restocking_fee": 0
}
],
"is_active": true,
"bundled_products": [{"type": "bundled product",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"bundled_products_inventory_handling": "bundle",
"publish_to_portal": true,
"portal_options": {"available_from": "2019-08-24T14:15:22Z",
"available_until": "2019-08-24T14:15:22Z"
},
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Response samples

application/json

{"id": "string",
"type": "certifications-fees",
"name": "string",
"business_unit_id": "string",
"price": 0,
"member_price": 0,
"enable_cancellation_fees": true,
"cancellation_fee": 0,
"enable_purchasing_eligibility": true,
"purchasing_eligibility_criteria": {"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"program_ids": ["string"
]
},
"minimum_age": 0,
"maximum_age": 0
},
"allow_customer_to_choose_installment_plan": true,
"enable_bundled_products": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"foreign_currency_prices": [{"currency_code": "AED",
"price": 0,
"member_price": 0,
"cancellation_fee": 0,
"restocking_fee": 0
}
],
"is_active": true,
"bundled_products": [{"type": "bundled product",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"bundled_products_inventory_handling": "bundle",
"publish_to_portal": true,
"portal_options": {"available_from": "2019-08-24T14:15:22Z",
"available_until": "2019-08-24T14:15:22Z"
},
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Partially updates a fee with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the fee to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array

op required	string (Op) The operation Enum: "add" "remove" "replace" "move" "copy" "test"
path required	string (Path) The JSON path
value	string (Value) The updated value

Responses

200The fee was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The fee could not be found.

409The fee could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve fee based on tenant limits.

500General server error.

patch/fees/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"type": "certifications-fees",
"name": "string",
"business_unit_id": "string",
"price": 0,
"member_price": 0,
"enable_cancellation_fees": true,
"cancellation_fee": 0,
"enable_purchasing_eligibility": true,
"purchasing_eligibility_criteria": {"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"program_ids": ["string"
]
},
"minimum_age": 0,
"maximum_age": 0
},
"allow_customer_to_choose_installment_plan": true,
"enable_bundled_products": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"foreign_currency_prices": [{"currency_code": "AED",
"price": 0,
"member_price": 0,
"cancellation_fee": 0,
"restocking_fee": 0
}
],
"is_active": true,
"bundled_products": [{"type": "bundled product",
"product_type": "string",
"product_id": "string",
"quantity": 0
}
],
"bundled_products_inventory_handling": "bundle",
"publish_to_portal": true,
"portal_options": {"available_from": "2019-08-24T14:15:22Z",
"available_until": "2019-08-24T14:15:22Z"
},
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Returns a fee from the system by its ID.

This method will delete a fee with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the fee to delete.

Responses

200The fee was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The fee could not be found.

409The fee could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete fee based on tenant limits.

500General server error.

delete/fees/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://certifications.api.756794052567.rhythmsoftware.com/fees/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"