> For the complete documentation index, see [llms.txt](https://apis.rightrev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apis.rightrev.com/rightrev-rest-api/policy-sets/configuration/revenue-policies/bundle-configuration.md).
# Bundle Configuration
## Get Bundles Policy
> \- To retrieve all the Bundle Policy details having Bundle Parent List, Bundle Component List and Bundle Component Product details.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/policy-sets/v1/policy/bundle":{"get":{"description":"- To retrieve all the Bundle Policy details having Bundle Parent List, Bundle Component List and Bundle Component Product details.\n","parameters":[{"name":"page","in":"path","required":false,"schema":{"type":"string","title":"page"},"description":"This is optional field. Page represents page number of bundle policy list.\n"},{"name":"page_size","in":"path","required":false,"schema":{"type":"string","title":"page_size"},"description":"This is optional field. Page size represents how many records available on each page.\n"},{"name":"active","in":"path","required":false,"schema":{"type":"boolean","title":"active"},"description":"A boolean field indicating whether the policy is Active or not. If set to True, the policy is Active; if false, it's Inactive.\n"},{"name":"config_key","in":"path","required":false,"schema":{"type":"string","title":"config_key"},"description":"This is a unique identifier for bundle policy.This will retrieve details of all components\n"},{"name":"product_name","in":"path","required":false,"schema":{"type":"string","title":"product_name"},"description":"This is the name of child product of parent components. This will retrieve all the product details.\n"}],"responses":{"200":{"description":"Get bundles Policy","content":{"application/json":{"schema":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID to retrieve the Revenue Rules Policies"},"compliance_name":{"type":"string","description":"Name of the policy fetched by the system"},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"bundle_config":{"type":"object","properties":{"carves_eligible":{"type":"Boolean","description":"A boolean field indicating whether the child product is carves eligible or not. If set to True, it's eligible for craves; if false, it's not."},"carves_liability_segment":{"type":"string","description":"Accounting segment for carves liability account."},"carves_revenue_segment":{"type":"string","description":"Accounting segment for carves revenue account."},"component_product_id":{"type":"string","description":"ID of the product"},"component_product_name":{"type":"string","description":"Name of the product."},"config_description":{"type":"string","description":"Description of the bundle config key"},"config_key":{"type":"string","description":"It's a unique identifier for bundle policy."},"contract_liability_segment":{"type":"string","description":"Accounting segment for contract liability account."},"contract_revenue_segment":{"type":"string","description":"Accounting segment for contract revenue account."},"default_option_for_all_fields":{"type":"string","description":" System will copy the values from parent line into child line for all attributes except a few key fields. Value need to provide ***Copy_from_Parent***."},"po_number":{"type":"string","description":"This is Purchase Order number."},"revenue_end_date":{"type":"string","description":"This is the revenue end date of child line"},"revenue_start_date":{"type":"string","description":"This is the revenue start date of contract child line"},"split_percentage":{"type":"string","description":"This is percentage of child line user want to split in from parent line value."},"ssp_date":{"type":"string","description":"This is the date from which user wants to apply SSP on child lines."}},"required":["carves_eligible","carves_liability_segment","carves_revenue_segment","component_product_id","component_product_name","config_description","config_key","contract_liability_segment","contract_revenue_segment","default_option_for_all_fields","po_number","revenue_end_date","revenue_start_date","split_percentage","ssp_date"],"description":"It's a unique identifier for bundle policy."},"config_key":{"type":"string","description":"It's a unique identifier for bundle policy."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com"},"created_on":{"type":"string","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"default_option_for_all_fields":{"type":"string","description":"System will copy the values from parent line into child line for all attributes except a few key fields. Value need to provide ***Copy_from_Parent***."},"file_name":{"type":"string","description":"Name of the CSV file."},"request_response_id":{"type":"string","description":"A system generated alpha-numeric number."},"split_percentage":{"type":"integer","description":"This is percentage of child line user want to split in from parent line value."},"unique_id":{"type":"string","description":"A system generated alpha-numeric number."},"updated_by":{"type":"string","description":"ID of the user who updated the policy. Example: username@rightrev.com"},"updated_on":{"type":"string","description":"Timestamp of the policy updated by the user. This is a unix Epoch timestamp format."}},"required":["bundle_config","config_key","created_by","created_on","default_option_for_all_fields","file_name","request_response_id","split_percentage","unique_id","updated_by","updated_on"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."}},"required":["compliance_id","compliance_name","compliance_spec"]}}}}},"tags":["Policy Sets"],"summary":"Get Bundles Policy","operationId":"get_bundles_policy_apis_policy_sets_v1_policy_bundle_get"}}}}
```
## Post Bundles Policy
> To upload new bundle policy or update the existing one.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/policy-sets/v1/policy/bundle":{"post":{"description":"To upload new bundle policy or update the existing one.\n","responses":{"200":{"description":"Set bundles Policy","content":{"application/json":{"schema":{"type":"object","properties":{"file_id":{"type":"string","description":"A system generated unique alpha-numeric number."},"message":{"type":"string","description":"Displays the outcome of the action. It is commonly used to provide success confirmations, error details, or other informational responses from the API after the operation is executed."}},"required":["file_id","message"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"file","format":"binary","description":"CSV file to be uploaded with Bundle Configuration details. Sample CSV Bundle File is attached below for reference."},"date_format":{"type":"text","format":"%m/%d/%Y","description":"Start Date and End Date must be in mm-dd-yyyy format."}},"required":["file","date_format"]}}},"required":true},"tags":["Policy Sets"],"summary":"Post Bundles Policy","operationId":"post_bundles_policy_apis_policy_sets_v1_policy_bundle_post"}}}}
```
## Download Bundles Policy Csv
> This API is used to download the uploaded CSV Bundle configuration file.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/policy-sets/v1/policy/bundle/download/{file_id}":{"get":{"description":"This API is used to download the uploaded CSV Bundle configuration file.\n","parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","title":"File Id"},"description":"A system generated file ID on uploading CSV file.\n"}],"responses":{"200":{"description":"Get bundles Policy CSV file.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}}},"tags":["Policy Sets"],"summary":"Download Bundles Policy Csv","operationId":"download_bundles_policy_csv_apis_policy_sets_v1_policy_bundle_download__file_id__get"}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://apis.rightrev.com/rightrev-rest-api/policy-sets/configuration/revenue-policies/bundle-configuration.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.