> 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/platform/outbound-app-registry.md).
# Outbound App Registry
## Get Outbound Integration Application Names
> \- This API is to retrieve the details of Outbound App Registry configuration fields.\
> \- RightRev supports NetSuite(NS), Microsoft Dynamics 365 (D365), SAGE, Rillets(Ri) and QuickBooks Online (QBO) GL Integraion systems.
```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/outbound_integration/v1/application-name":{"get":{"description":"- This API is to retrieve the details of Outbound App Registry configuration fields.\n- RightRev supports NetSuite(NS), Microsoft Dynamics 365 (D365), SAGE, Rillets(Ri) and QuickBooks Online (QBO) GL Integraion systems. \n","responses":{"200":{"description":"Get OutboundIntegration Application Names","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID on creating or updating the policy"},"compliance_name":{"type":"string","description":"Name of the policy."},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"app_registry_fields":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Unique key used internally to identify the field in the system."},"label":{"type":"string","description":"User-friendly display name shown in the UI for the field."},"sequence_no":{"type":"integer","description":"Defines the display order of the field in the form or layout."},"type":{"type":"string","description":"Specifies the input type of the field (e.g., text) that determines how it is rendered in the UI"}},"required":["code","label","sequence_no","type"]},"description":"Configuration element that defines the properties and metadata of a field required for integrating with an external application."},"application_desc":{"type":"string","description":"Description of the GL Integration system (Outbound registry application)"},"application_name":{"type":"string","description":"Name of the GL Integration system (Outbound registry application)"}},"required":["app_registry_fields","application_desc","application_name"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."}},"required":["compliance_id","compliance_name","compliance_spec"]}}}}}},"tags":["Outbound Integration"],"summary":"Get Outbound Integration Application Names","operationId":"get_outbound_integration_application_names_apis_outbound_integration_v1_application_name_get"}}}}
```
## Post Outbound Integration Application Registry
> This API is to retrieve the details of application level fields, the status of connection for all configured GL Integration systems.
```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/outbound_integration/v1/application-registry-list":{"post":{"description":"This API is to retrieve the details of application level fields, the status of connection for all configured GL Integration systems.\n","responses":{"200":{"description":"Get OutboundIntegration Application Registry","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID on creating or updating the policy"},"compliance_name":{"type":"string","description":"name of the policy."},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","description":"A boolean field indicating whether the the respective GL Integration System is Active or not. If set to True, the GL Integration System is Active; if false, it's Inactive."},"application_desc":{"type":"string","description":"Description of the GL Integration system (Outbound registry application)"},"application_name":{"type":"string","description":"Name of the GL Integration system (Outbound registry application)"},"details":{"type":"object","properties":{"user_name":{"type":"string","description":"User ID of the GL Integration system (Outbound registry application) "}},"required":["user_name"],"description":"Details of the test connection"},"test_connection_error":{"type":"null","description":"Captures error details if the connection test fails; null indicates no error occurred."},"test_connection_status":{"type":"string","description":"Indicates the result of the connection test (e.g., SUCCESS or FAILURE)."},"test_connection_timestamp_utc":{"type":"string","description":"Stores the date and time (in UTC) when the connection test was executed."}},"required":["active","application_desc","application_name","details","test_connection_error","test_connection_status","test_connection_timestamp_utc"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"total_records":{"type":"integer","description":"Total no of records."}},"required":["compliance_id","compliance_name","compliance_spec","total_records"]}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"tags":["Outbound Integration"],"summary":"Post Outbound Integration Application Registry","operationId":"post_outbound_integration_application_registry_apis_outbound_integration_v1_application_registry_list_post"}}}}
```
## Post Outbound Integration Application Registry
> \- This API is used to configure Outbound app registry.\
> \- RightRev supports NetSuite(NS), Microsoft Dynamics 365 (D365), SAGE, Rillets(Ri) and QuickBooks Online (QBO) GL Integraion systems.
```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/outbound_integration/v1/application-registry":{"post":{"description":"- This API is used to configure Outbound app registry.\n- RightRev supports NetSuite(NS), Microsoft Dynamics 365 (D365), SAGE, Rillets(Ri) and QuickBooks Online (QBO) GL Integraion systems.\n","responses":{"200":{"description":"Create OutboundIntegration Application Registry","content":{"application/json":{"schema":{"type":"object","properties":{"compliance_id":{"type":"string","description":" A system-generated compliance ID on configuring the Outbound app registry."},"compliance_name":{"type":"string","description":"Name of the Policy."},"compliance_spec":{"type":"object","properties":{"active":{"type":"boolean","description":"A boolean field indicating whether the outbound integration app is Active or not. If set to True, the policy is Active; if false, it's Inactive."},"application_desc":{"type":"string","description":"Description of the Outbound App registry"},"application_name":{"type":"string","description":"Name of the Outbound App registry"},"details":{"type":"object","properties":{"user_name":{"type":"string","description":"User ID of the GL Integration system (Outbound registry application)"}},"required":["user_name"],"description":"Details of the test connection"},"test_connection_error":{"type":"null","description":"Captures error details if the connection test fails; null indicates no error occurred."},"test_connection_status":{"type":"string","description":"Indicates the result of the connection test (e.g., SUCCESS or FAILURE)."},"test_connection_timestamp_utc":{"type":"string","description":"Stores the date and time (in UTC) when the connection test was executed."}},"required":["active","application_desc","application_name","details","test_connection_error","test_connection_status","test_connection_timestamp_utc"],"description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"message":{"type":"string","description":"Success or failure message on configuration of the outbound app registry."},"object_unique_value":{"type":"string","description":"Name of the Outbound App Registry."}},"required":["compliance_id","compliance_name","compliance_spec","message","object_unique_value"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_name":{"type":"string","description":"User ID of the GL Integration system (Outbound registry application)"},"compliance_name":{"type":"string","description":"Name of the policy."},"compliance_spec":{"type":"object","properties":{"application_name":{"type":"string","description":"Name of the Outbound app registry."},"user_name":{"type":"string","description":"User ID of the GL Integration system (Outbound registry application)"},"client_id":{"type":"string","description":"Unique identifier provided by the application for API authentication."},"client_secret":{"type":"string","description":"Secret key associated with the client ID used for secure authentication."},"copy_map_fields_from_last_version":{"type":"boolean","description":"This boolean if marked as TRUE field will copy all field mapping details from the previous version."}},"required":["application_name","client_id","client_secret","copy_map_fields_from_last_version","user_name"],"description":"Defines the specific rules and standards where a system must process adhering to the compliant."}},"required":["compliance_name","compliance_spec","user_name"]}}},"required":true},"tags":["Outbound Integration"],"summary":"Post Outbound Integration Application Registry","operationId":"post_outbound_integration_application_registry_apis_outbound_integration_v1_application_registry_post"}}}}
```
## Post Outbound Integration Test Connection
> This API is to check the status of connection of the configured GL Integration systems.
```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/outbound_integration/v1/application-test-connection":{"post":{"description":"This API is to check the status of connection of the configured GL Integration systems.\n","responses":{"200":{"description":"Get OutboundIntegration Application Registry","content":{"application/json":{"schema":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID on creating or updating the policy"},"compliance_name":{"type":"string","description":"Name of the policy."},"compliance_spec":{"type":"object","description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"message":{"type":"string","description":"Success or failure message on checking test connection."}},"required":["compliance_id","compliance_name","compliance_spec","message"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"object_unique_value":{"type":"string","description":"name of the GL Integration system (Outbound App Registry)"}},"required":["object_unique_value"]}}},"required":true},"tags":["Outbound Integration"],"summary":"Post Outbound Integration Test Connection","operationId":"post_outbound_integration_test_connection_apis_outbound_integration_v1_application_test_connection_post"}}}}
```
## Get Outbound Integration Entity Field Mapping
> This API is to retrieve the field mapping details between Source System (RightRev) & Traget system (GL Integration system)
```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/outbound_integration/v1/entity-field-mapping/{integration_app_name}/{entity_name}":{"get":{"parameters":[{"name":"integration_app_name","in":"path","required":true,"schema":{"type":"string","title":"Integration App Name"},"description":"Name of the GL Integration system.\n"},{"name":"entity_name","in":"path","required":true,"schema":{"type":"string","title":"Entity Name"},"description":"entity name will be - JOURNAL_ENTRY\n"}],"responses":{"200":{"description":"Get Outbound Integration Application Registry By ID","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID to retrieve Outbound Integration Application Registryfiled mapping details "},"compliance_name":{"type":"string","description":"Name of the policy"},"compliance_spec":{"type":"object","properties":{"entity_field_mapping":{"type":"array","items":{"type":"object","properties":{"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the policy is defined by the user or not. If set to True, the user is allowed to define the policy; if False, defining the policy is not permitted."},"node_type":{"type":"string","description":"Node types are - ARRAY_ITEM or ROOT."},"sequence_no":{"type":"integer","description":"Defines the display order of the field in the form or layout."},"source_field":{"type":"array","items":{"type":"string"},"description":"This is the field data coming from RightRev system."},"source_field_type":{"type":"string","description":"FIELD OR CONSTANT. And for CONSTANT user can't configure transaformation rule."},"target_field_path":{"type":"string","description":"This is where the data is going in the target GL Integration system "},"target_field_type":{"type":"string","description":"Target field types define the data type expected by the GL Integration system for each mapped field."},"transformation_rule":{"type":"string","description":"This field is used to pick dynamic values from source data and convert it as required by GL systems by using transaformation rule."}},"required":["is_user_defined","node_type","sequence_no","source_field","source_field_type","target_field_path","target_field_type"]},"description":"Filed mapping for journal entry"},"entity_name":{"type":"string","description":"This will be JOURNAL_ENTRY"},"integration_app_name":{"type":"string","description":"Name of GL Integration system."},"updated_at":{"type":"integer","description":"Timestamp of the policy updated by the user. This is a unix Epoch timestamp format."},"updated_by":{"type":"string","description":"ID of the user who updated the policy. Example: username@rightrev.com"}},"required":["entity_field_mapping","entity_name","integration_app_name","updated_at","updated_by"],"description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"source_fields":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Unique key used internally to identify the field in the system."},"label":{"type":"string","description":"User-friendly display name shown in the UI for the field."}},"required":["code","label"]},"description":"This is the field data coming from RightRev system."}},"required":["compliance_id","compliance_name","compliance_spec","source_fields"]}}}}}},"description":"This API is to retrieve the field mapping details between Source System (RightRev) & Traget system (GL Integration system)\n","tags":["Outbound Integration"],"summary":"Get Outbound Integration Entity Field Mapping","operationId":"get_outbound_integration_entity_field_mapping_apis_outbound_integration_v1_entity_field_mapping__integration_app_name___entity_name__get"}}}}
```
## Update Outbound Integration Entity Field Mapping
> This API is to update the field mapping details between Source System (RightRev) & Traget system (GL Integration system)
```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/outbound_integration/v1/entity-field-mapping/{integration_app_name}/{entity_name}":{"put":{"parameters":[{"name":"integration_app_name","in":"path","required":true,"schema":{"type":"string","title":"Integration App Name"},"description":"Name of the GL Integration system.\n"},{"name":"entity_name","in":"path","required":true,"schema":{"type":"string","title":"Entity Name"},"description":"Entity name will be - JOURNAL_ENTRY\n"}],"responses":{"200":{"description":"Update OutboundIntegration Application Registry","content":{"application/json":{"schema":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID to update Outbound Integration Application Registryfiled mapping details"},"compliance_name":{"type":"string","description":"Name of the policy"},"compliance_spec":{"type":"object","description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"message":{"type":"string","description":"Success or failure message on updating the mapping details."}},"required":["compliance_id","compliance_name","compliance_spec","message"]}}}}},"description":"This API is to update the field mapping details between Source System (RightRev) & Traget system (GL Integration system)\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"compliance_spec":{"type":"object","properties":{"integration_app_name":{"type":"string","description":"Name of the GL integration system"},"entity_name":{"type":"string","description":"This will be JOURNAL_ENTRY"},"entity_field_mapping":{"type":"array","items":{"type":"object","properties":{"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the policy is defined by the user or not. If set to True, the user is allowed to define the policy; if False, defining the policy is not permitted."},"node_type":{"type":"string","description":"Node types are - ARRAY_ITEM or ROOT."},"sequence_no":{"type":"integer","description":"Defines the display order of the field in the form or layout."},"source_field":{"type":"array","items":{"type":"string"},"description":"This is the field data coming from RightRev system."},"source_field_type":{"type":"string","description":"FIELD OR CONSTANT. And for CONSTANT user can't configure transaformation rule."},"target_field_path":{"type":"string","description":"This is where the data is going in the target GL Integration system"},"target_field_type":{"type":"string","description":"Target field types define the data type expected by the GL Integration system for each mapped field."},"transformation_rule":{"type":"string","description":"This field is used to pick dynamic values from source data and convert it as required by GL systems by using transaformation rule."}},"required":["is_user_defined","node_type","sequence_no","source_field","source_field_type","target_field_path","target_field_type"]},"description":"Field mapping for journal entry"}},"required":["entity_field_mapping","entity_name","integration_app_name"],"description":"Defines the specific rules and standards where a system must process adhering to the compliant."}},"required":["compliance_spec"]}}},"required":true},"tags":["Outbound Integration"],"summary":"Update Outbound Integration Entity Field Mapping","operationId":"update_outbound_integration_entity_field_mapping_apis_outbound_integration_v1_entity_field_mapping__integration_app_name___entity_name__put"}}}}
```
## Update Outbound Integration Entity Field Mapping
> This API is used to configurte fist time the field mapping details between Source System (RightRev) & Traget system (GL Integration system)
```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/outbound_integration/v1/entity-field-mapping/{integration_app_name}/{entity_name}":{"post":{"parameters":[{"name":"integration_app_name","in":"path","required":true,"schema":{"type":"string","title":"Integration App Name"},"description":"Name of the GL Integration system.\n"},{"name":"entity_name","in":"path","required":true,"schema":{"type":"string","title":"Entity Name"},"description":"Entity name will be - JOURNAL_ENTRY\n"}],"responses":{"200":{"description":"Configure first time OutboundIntegration Application Registry","content":{"application/json":{"schema":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID to configure Outbound Integration Application Registryfiled mapping details"},"compliance_name":{"type":"string","description":"Name of the policy"},"compliance_spec":{"type":"object","description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"message":{"type":"string","description":"Success or failure message on updating the mapping details."}},"required":["compliance_id","compliance_name","compliance_spec","message"]}}}}},"description":"This API is used to configurte fist time the field mapping details between Source System (RightRev) & Traget system (GL Integration system)\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"compliance_spec":{"type":"object","properties":{"integration_app_name":{"type":"string","description":"Name of the GL integration system"},"entity_name":{"type":"string","description":"This will be JOURNAL_ENTRY"},"entity_field_mapping":{"type":"array","items":{"type":"object","properties":{"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the policy is defined by the user or not. If set to True, the user is allowed to define the policy; if False, defining the policy is not permitted."},"node_type":{"type":"string","description":"Node types are - ARRAY_ITEM or ROOT."},"sequence_no":{"type":"integer","description":"Defines the display order of the field in the form or layout."},"source_field":{"type":"array","items":{"type":"string"},"description":"This is the field data coming from RightRev system."},"source_field_type":{"type":"string","description":"FIELD OR CONSTANT. And for CONSTANT user can't configure transaformation rule."},"target_field_path":{"type":"string","description":"This is where the data is going in the target GL Integration system"},"target_field_type":{"type":"string","description":"Target field types define the data type expected by the GL Integration system for each mapped field."},"transformation_rule":{"type":"string","description":"This field is used to pick dynamic values from source data and convert it as required by GL systems by using transaformation rule."}},"required":["is_user_defined","node_type","sequence_no","source_field","source_field_type","target_field_path","target_field_type"]},"description":"Field mapping for journal entry"}},"required":["entity_field_mapping","entity_name","integration_app_name"],"description":"Defines the specific rules and standards where a system must process adhering to the compliant."}},"required":["compliance_spec"]}}},"required":true},"tags":["Outbound Integration"],"summary":"Update Outbound Integration Entity Field Mapping","operationId":"update_outbound_integration_entity_field_mapping_apis_outbound_integration_v1_entity_field_mapping__integration_app_name___entity_name__post"}}}}
```
## Get Outbound Integration Application Registry
> This API is to retrieve the OutboundIntegration Application Registry details by ID
```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/outbound_integration/v1/application-registry/{object_unique_value}":{"get":{"description":"This API is to retrieve the OutboundIntegration Application Registry details by ID\n","parameters":[{"name":"object_unique_value","in":"path","required":true,"schema":{"type":"string","title":"Object Unique Value"},"description":"- Abbreviated names of Outbound App Registries \n- User can provide values provided below in brackets for respective GL systems\n- NetSuite, Microsoft Dynamics 365 (D365), SAGE Intact (SAGE), Rillets(Ri) and QuickBooks Online (QBO)\n"}],"responses":{"200":{"description":"Get OutboundIntegration Application Registry By ID","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID on creating or updating the policy."},"compliance_name":{"type":"string","description":"Name of the policy."},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","description":"A boolean field indicating whether the the respective GL Integration System is Active or not. If set to True, the GL Integration System is Active; if false, it's Inactive."},"application_desc":{"type":"string","description":"Description of the GL Integration system (Outbound registry application)"},"application_name":{"type":"string","description":"Name of the GL Integration system (Outbound registry application)"},"details":{"type":"object","properties":{"user_name":{"type":"string","description":"User ID of the GL Integration system (Outbound registry application)"}},"required":["user_name"],"description":"Details of the test connection"},"test_connection_error":{"type":"null","description":"Captures error details if the connection test fails; null indicates no error occurred."},"test_connection_status":{"type":"string","description":"Indicates the result of the connection test (e.g., SUCCESS or FAILURE)."},"test_connection_timestamp_utc":{"type":"string","description":"Stores the date and time (in UTC) when the connection test was executed."}},"required":["active","application_desc","application_name","details","test_connection_error","test_connection_status","test_connection_timestamp_utc"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"total_records":{"type":"integer","description":"Total no of records."}},"required":["compliance_id","compliance_name","compliance_spec","total_records"]}}}}}},"tags":["Outbound Integration"],"summary":"Get Outbound Integration Application Registry","operationId":"get_outbound_integration_application_registry_apis_outbound_integration_v1_application_registry__object_unique_value__get"}}}}
```
## Update Outbound Integration Application Registry
> This API is to update the OutboundIntegration Application Registry details by ID
```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/outbound_integration/v1/application-registry/{object_unique_value}":{"post":{"parameters":[{"name":"object_unique_value","in":"path","required":true,"schema":{"type":"string","title":"Object Unique Value"},"description":"- Abbreviated names of Outbound App Registries \n- User can provide values provided below in brackets for respective GL systems\n- NetSuite, Microsoft Dynamics 365 (D365), SAGE Intact (SAGE), Rillets(Ri) and QuickBooks Online (QBO)\n"}],"responses":{"200":{"description":"Update OutboundIntegration Application Registry","content":{"application/json":{"schema":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID on creating or updating the policy."},"compliance_name":{"type":"string","description":"Name of the policy"},"compliance_spec":{"type":"object","properties":{"active":{"type":"boolean","description":"A boolean field indicating whether the the respective GL Integration System is Active or not. If set to True, the GL Integration System is Active; if false, it's Inactive."},"application_desc":{"type":"string","description":"Description of the GL Integration system (Outbound registry application)"},"application_name":{"type":"string","description":"Name of the GL Integration system (Outbound registry application)"},"details":{"type":"object","properties":{"user_name":{"type":"string","description":"User ID of the GL Integration system (Outbound registry application)"}},"required":["user_name"],"description":"Details of the test connection"},"test_connection_error":{"type":"null","description":"Captures error details if the connection test fails; null indicates no error occurred."},"test_connection_status":{"type":"string","description":"Indicates the result of the connection test (e.g., SUCCESS or FAILURE)."},"test_connection_timestamp_utc":{"type":"string","description":"Stores the date and time (in UTC) when the connection test was executed."}},"required":["active","application_desc","application_name","details","test_connection_error","test_connection_status","test_connection_timestamp_utc"],"description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"message":{"type":"string","description":"Success or failure message on updating the GL Integration system details."},"object_unique_value":{"type":"string","description":"Abbreviated name of the Outbound app regsitry."}},"required":["compliance_id","compliance_name","compliance_spec","message","object_unique_value"]}}}}},"description":"This API is to update the OutboundIntegration Application Registry details by ID\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_name":{"type":"string","description":"Id of the user updating the policy."},"compliance_name":{"type":"string","description":"Name of the policy por GL integration system."},"compliance_spec":{"type":"object","properties":{"application_name":{"type":"string","description":"Name of the GL Integration system (Outbound registry application)"},"user_name":{"type":"string","description":"User ID of the GL Integration system (Outbound registry application)"}},"required":["application_name","user_name"],"description":"Defines the specific rules and standards where a system must process adhering to the compliant."}},"required":["compliance_name","compliance_spec","user_name"]}}},"required":true},"tags":["Outbound Integration"],"summary":"Update Outbound Integration Application Registry","operationId":"update_outbound_integration_application_registry_apis_outbound_integration_v1_application_registry__object_unique_value__post"}}}}
```
## Delete Outbound Integration Application Registry
> This API is to delete the Outbound Integration Application Registry details by ID
```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/outbound_integration/v1/application-registry/{object_unique_value}":{"delete":{"description":"This API is to delete the Outbound Integration Application Registry details by ID\n","parameters":[{"name":"object_unique_value","in":"path","required":true,"schema":{"type":"string","title":"Object Unique Value"},"description":"- Abbreviated names of Outbound App Registries \n- User can provide values provided below in brackets for respective GL systems\n- NetSuite, Microsoft Dynamics 365 (D365), SAGE Intact (SAGE), Rillets(Ri) and QuickBooks Online (QBO)\n"}],"responses":{"200":{"description":"Delete OutboundIntegration Application Registry","content":{"application/json":{"schema":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID on deleting the app registry."},"compliance_name":{"type":"string","description":"Name of the policy."},"message":{"type":"string","description":"Success or failure message on deleting the app registry."}},"required":["compliance_id","compliance_name","message"]}}}}},"tags":["Outbound Integration"],"summary":"Delete Outbound Integration Application Registry","operationId":"delete_outbound_integration_application_registry_apis_outbound_integration_v1_application_registry__object_unique_value__delete"}}}}
```
---
# 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/platform/outbound-app-registry.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.