Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Outbound App Registry

Get Outbound Integration Application Names

get
/apis/outbound_integration/v1/application-name

  • 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.

Responses
200

Get OutboundIntegration Application Names

application/json
compliance_idstringRequired

A system-generated compliance ID on creating or updating the policy

compliance_namestringRequired

Name of the policy.

get/apis/outbound_integration/v1/application-name
GET /apis/outbound_integration/v1/application-name HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
200

Get OutboundIntegration Application Names

[
  {
    "compliance_id": "2f559143-47b2-4e5f-8f0b-d699d75ba1e5",
    "compliance_name": "outbound-integration-application-name",
    "compliance_spec": [
      {
        "app_registry_fields": [
          {
            "code": "client_id",
            "label": "Client Id",
            "sequence_no": 1,
            "type": "text"
          },
          {
            "code": "client_secret",
            "label": "Client Secret",
            "sequence_no": 2,
            "type": "text"
          },
          {
            "code": "account_id",
            "label": "Account Id",
            "sequence_no": 3,
            "type": "text"
          },
          {
            "code": "certificate_id",
            "label": "Certificate Id",
            "sequence_no": 4,
            "type": "text"
          },
          {
            "code": "certificate_private_key",
            "label": "Certificate Private Key",
            "sequence_no": 5,
            "type": "textarea"
          }
        ],
        "application_desc": "Oracle NetSuite",
        "application_name": "NETSUITE"
      },
      {
        "app_registry_fields": [
          {
            "code": "client_id",
            "label": "Client Id",
            "sequence_no": 1,
            "type": "text"
          },
          {
            "code": "client_secret",
            "label": "Client Secret",
            "sequence_no": 2,
            "type": "text"
          },
          {
            "code": "company_id",
            "label": "Company Id",
            "sequence_no": 3,
            "type": "text"
          },
          {
            "code": "minor_version",
            "label": "API Minor Version",
            "sequence_no": 4,
            "type": "text"
          }
        ],
        "application_desc": "QuickBooks Online",
        "application_name": "QBO"
      },
      {
        "app_registry_fields": [
          {
            "code": "client_id",
            "label": "Client Id",
            "sequence_no": 1,
            "type": "text"
          },
          {
            "code": "client_secret",
            "label": "Client Secret",
            "sequence_no": 2,
            "type": "text"
          },
          {
            "code": "user_name",
            "label": "User Name",
            "sequence_no": 3,
            "type": "text"
          }
        ],
        "application_desc": "Sage Intacct",
        "application_name": "SAGE"
      },
      {
        "app_registry_fields": [
          {
            "code": "client_id",
            "label": "Client Id",
            "sequence_no": 1,
            "type": "text"
          },
          {
            "code": "client_secret",
            "label": "Client Secret",
            "sequence_no": 2,
            "type": "text"
          },
          {
            "code": "environment_name",
            "label": "Environment Name",
            "sequence_no": 3,
            "type": "text"
          },
          {
            "code": "auth_tenant_id",
            "label": "Auth Tenant Id",
            "sequence_no": 4,
            "type": "text"
          },
          {
            "code": "company_name",
            "label": "Company Name",
            "sequence_no": 5,
            "type": "text"
          },
          {
            "code": "company_id",
            "label": "Company Id",
            "sequence_no": 6,
            "type": "text"
          },
          {
            "code": "journal_id",
            "label": "Journal Id",
            "sequence_no": 7,
            "type": "text"
          }
        ],
        "application_desc": "Microsoft Dynamics 365",
        "application_name": "D365"
      },
      {
        "app_registry_fields": [
          {
            "code": "client_id",
            "label": "Client Id",
            "sequence_no": 1,
            "type": "text"
          },
          {
            "code": "client_secret",
            "label": "Client Secret",
            "sequence_no": 2,
            "type": "text"
          }
        ],
        "application_desc": "Rillet",
        "application_name": "RI"
      },
      {
        "app_registry_fields": [
          {
            "code": "client_id",
            "label": "Client Id",
            "sequence_no": 1,
            "type": "text"
          },
          {
            "code": "client_secret",
            "label": "Client Secret",
            "sequence_no": 2,
            "type": "text"
          },
          {
            "code": "refresh_token",
            "label": "Refresh Token",
            "sequence_no": 3,
            "type": "text"
          },
          {
            "code": "auth_tenant_id",
            "label": "Auth Tenant Id",
            "sequence_no": 4,
            "type": "text"
          },
          {
            "code": "version",
            "label": "Version",
            "sequence_no": 5,
            "type": "text"
          }
        ],
        "application_desc": "Workday",
        "application_name": "WD"
      }
    ]
  }
]

Post Outbound Integration Application Registry

post
/apis/outbound_integration/v1/application-registry-list

This API is to retrieve the details of application level fields, the status of connection for all configured GL Integration systems.

Body
objectOptional
Responses
200

Get OutboundIntegration Application Registry

application/json
compliance_idstringRequired

A system-generated compliance ID on creating or updating the policy

compliance_namestringRequired

name of the policy.

total_recordsintegerRequired

Total no of records.

post/apis/outbound_integration/v1/application-registry-list
POST /apis/outbound_integration/v1/application-registry-list HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Get OutboundIntegration Application Registry

[
  {
    "compliance_id": "1121401d-4d88-470b-a67c-36462622a83c",
    "compliance_name": "outbound-integration-application-registry",
    "compliance_spec": [
      {
        "active": true,
        "application_desc": "Sage Intacct",
        "application_name": "SAGE",
        "details": {
          "user_name": "RightRev@rightrevMPP-DEV"
        },
        "test_connection_error": null,
        "test_connection_status": "SUCCESS",
        "test_connection_timestamp_utc": "2026-04-29 05:03:52.112 Z"
      }
    ],
    "total_records": 1
  }
]

Post Outbound Integration Application Registry

post
/apis/outbound_integration/v1/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.

Body
user_namestringRequired

User ID of the GL Integration system (Outbound registry application)

compliance_namestringRequired

Name of the policy.

Responses
200

Create OutboundIntegration Application Registry

application/json
compliance_idstringRequired

A system-generated compliance ID on configuring the Outbound app registry.

compliance_namestringRequired

Name of the Policy.

messagestringRequired

Success or failure message on configuration of the outbound app registry.

object_unique_valuestringRequired

Name of the Outbound App Registry.

post/apis/outbound_integration/v1/application-registry
POST /apis/outbound_integration/v1/application-registry HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 251

{
  "user_name": "thiyagu",
  "compliance_name": "outbound-integration-application-registry",
  "compliance_spec": {
    "application_name": "SAGE",
    "user_name": "RightRev@rightrevMPP-DEV",
    "client_id": "***",
    "client_secret": "***",
    "copy_map_fields_from_last_version": true
  }
}
200

Create OutboundIntegration Application Registry

{
  "compliance_id": "2c8bd0c5-786e-455c-90f8-35c4b669f798",
  "compliance_name": "outbound-integration-application-registry",
  "compliance_spec": {
    "active": false,
    "application_desc": "Sage Intacct",
    "application_name": "SAGE",
    "details": {
      "user_name": "RightRev@rightrevMPP-DEV"
    },
    "test_connection_error": null,
    "test_connection_status": "SUCCESS",
    "test_connection_timestamp_utc": "2026-05-08 05:32:01.661 Z"
  },
  "message": "Successfully Updated!",
  "object_unique_value": "SAGE"
}

Post Outbound Integration Test Connection

post
/apis/outbound_integration/v1/application-test-connection

This API is to check the status of connection of the configured GL Integration systems.

Body
object_unique_valuestringRequired

name of the GL Integration system (Outbound App Registry)

Responses
200

Get OutboundIntegration Application Registry

application/json
compliance_idstringRequired

A system-generated compliance ID on creating or updating the policy

compliance_namestringRequired

Name of the policy.

compliance_specobjectRequired

Defines the specific rules and standards where a system must process adhering to the compliant.

messagestringRequired

Success or failure message on checking test connection.

post/apis/outbound_integration/v1/application-test-connection
POST /apis/outbound_integration/v1/application-test-connection HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "object_unique_value": "SAGE"
}
200

Get OutboundIntegration Application Registry

{
  "compliance_id": "890bd8fb-b1f7-431d-a37a-622a1df4005f",
  "compliance_name": "outbound-integration-application-test-connection",
  "compliance_spec": {},
  "message": "SUCCESS"
}

Get Outbound Integration Entity Field Mapping

get
/apis/outbound_integration/v1/entity-field-mapping/{integration_app_name}/{entity_name}

This API is to retrieve the field mapping details between Source System (RightRev) & Traget system (GL Integration system)

Path parameters
integration_app_namestringRequired

Name of the GL Integration system.

entity_namestringRequired

entity name will be - JOURNAL_ENTRY

Responses
200

Get Outbound Integration Application Registry By ID

application/json
compliance_idstringRequired

A system-generated compliance ID to retrieve Outbound Integration Application Registryfiled mapping details

compliance_namestringRequired

Name of the policy

get/apis/outbound_integration/v1/entity-field-mapping/{integration_app_name}/{entity_name}
GET /apis/outbound_integration/v1/entity-field-mapping/{integration_app_name}/{entity_name} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
200

Get Outbound Integration Application Registry By ID

[
  {
    "compliance_id": "54085b88-8748-45d6-b719-9f77786991ee",
    "compliance_name": "outbound-integration-entity-field-mapping",
    "compliance_spec": {
      "entity_field_mapping": [
        {
          "is_user_defined": false,
          "node_type": "ROOT",
          "sequence_no": 1,
          "source_field": [
            "RRJ"
          ],
          "source_field_type": "Constant",
          "target_field_path": "glJournal.id",
          "target_field_type": "string"
        },
        {
          "is_user_defined": false,
          "node_type": "ROOT",
          "sequence_no": 2,
          "source_field": [
            "posting_date"
          ],
          "source_field_type": "Field",
          "target_field_path": "postingDate",
          "target_field_type": "date",
          "transformation_rule": "TO_CHAR(:1, 'YYYY-MM-DD')"
        },
        {
          "is_user_defined": false,
          "node_type": "ROOT",
          "sequence_no": 3,
          "source_field": [
            "Revenue entries"
          ],
          "source_field_type": "Constant",
          "target_field_path": "description",
          "target_field_type": "string"
        },
        {
          "is_user_defined": false,
          "node_type": "ROOT",
          "sequence_no": 4,
          "source_field": [
            "journal_run_id"
          ],
          "source_field_type": "Field",
          "target_field_path": "referenceNumber",
          "target_field_type": "string",
          "transformation_rule": "'<ENV>RR_JOURNAL_ID:' || TO_CHAR(:1)"
        },
        {
          "is_user_defined": false,
          "node_type": "ARRAY_ITEM",
          "sequence_no": 5,
          "source_field": [
            "revenue_contract_id"
          ],
          "source_field_type": "Field",
          "target_field_path": "lines.documentId",
          "target_field_type": "string"
        },
        {
          "is_user_defined": false,
          "node_type": "ARRAY_ITEM",
          "sequence_no": 6,
          "source_field": [
            "dr_cr_indicator"
          ],
          "source_field_type": "Field",
          "target_field_path": "lines.txnType",
          "target_field_type": "string"
        },
        {
          "is_user_defined": false,
          "node_type": "ARRAY_ITEM",
          "sequence_no": 7,
          "source_field": [
            "amount"
          ],
          "source_field_type": "Field",
          "target_field_path": "lines.txnAmount",
          "target_field_type": "number",
          "transformation_rule": "TO_VARCHAR(:1)"
        },
        {
          "is_user_defined": false,
          "node_type": "ARRAY_ITEM",
          "sequence_no": 8,
          "source_field": [
            "gl_account"
          ],
          "source_field_type": "Field",
          "target_field_path": "lines.glAccount.id",
          "target_field_type": "string"
        },
        {
          "is_user_defined": false,
          "node_type": "ARRAY_ITEM",
          "sequence_no": 9,
          "source_field": [
            "gl_int_department_id"
          ],
          "source_field_type": "Field",
          "target_field_path": "lines.dimensions.department.id",
          "target_field_type": "string"
        },
        {
          "is_user_defined": false,
          "node_type": "ARRAY_ITEM",
          "sequence_no": 10,
          "source_field": [
            "gl_int_location_id"
          ],
          "source_field_type": "Field",
          "target_field_path": "lines.dimensions.location.id",
          "target_field_type": "string"
        },
        {
          "is_user_defined": false,
          "node_type": "ARRAY_ITEM",
          "sequence_no": 11,
          "source_field": [
            "functional_currency"
          ],
          "source_field_type": "Field",
          "target_field_path": "lines.currency.baseCurrency",
          "target_field_type": "string"
        },
        {
          "is_user_defined": false,
          "node_type": "ARRAY_ITEM",
          "sequence_no": 12,
          "source_field": [
            "transaction_currency"
          ],
          "source_field_type": "Field",
          "target_field_path": "lines.currency.txnCurrency",
          "target_field_type": "string"
        }
      ],
      "entity_name": "JOURNAL_ENTRY",
      "integration_app_name": "SAGE",
      "updated_at": 1778168705,
      "updated_by": "thiyagu"
    },
    "source_fields": [
      {
        "code": "legal_entity",
        "label": "Legal Entity"
      },
      {
        "code": "gl_account",
        "label": "GL Account"
      },
      {
        "code": "currency_code",
        "label": "Currency Code"
      },
      {
        "code": "journal_run_id",
        "label": "Journal Run Id"
      },
      {
        "code": "planned_period",
        "label": "Planned Period"
      },
      {
        "code": "recognized_period",
        "label": "Recognized Period"
      },
      {
        "code": "accounting_period",
        "label": "Accounting Period"
      },
      {
        "code": "period_year",
        "label": "Period Year"
      },
      {
        "code": "period_number",
        "label": "Period Number"
      },
      {
        "code": "account_type",
        "label": "Account Type"
      },
      {
        "code": "transaction_currency",
        "label": "Transaction Currency"
      },
      {
        "code": "functional_currency",
        "label": "Functional Currency"
      },
      {
        "code": "order_financial_id",
        "label": "Order Financial ID"
      },
      {
        "code": "gl_int_department_id",
        "label": "Department ID"
      },
      {
        "code": "gl_int_location_id",
        "label": "Location ID"
      },
      {
        "code": "revenue_contract_id",
        "label": "Revenue Contract ID"
      },
      {
        "code": "amount",
        "label": "Amount"
      },
      {
        "code": "dr_cr_indicator",
        "label": "DR CR Indicator"
      },
      {
        "code": "posting_date",
        "label": "Posting Date"
      },
      {
        "code": "row_num",
        "label": "Row No"
      }
    ]
  }
]

Update Outbound Integration Entity Field Mapping

put
/apis/outbound_integration/v1/entity-field-mapping/{integration_app_name}/{entity_name}

This API is to update the field mapping details between Source System (RightRev) & Traget system (GL Integration system)

Path parameters
integration_app_namestringRequired

Name of the GL Integration system.

entity_namestringRequired

Entity name will be - JOURNAL_ENTRY

Body
Responses
200

Update OutboundIntegration Application Registry

application/json
compliance_idstringRequired

A system-generated compliance ID to update Outbound Integration Application Registryfiled mapping details

compliance_namestringRequired

Name of the policy

compliance_specobjectRequired

Defines the specific rules and standards where a system must process adhering to the compliant.

messagestringRequired

Success or failure message on updating the mapping details.

put/apis/outbound_integration/v1/entity-field-mapping/{integration_app_name}/{entity_name}
PUT /apis/outbound_integration/v1/entity-field-mapping/{integration_app_name}/{entity_name} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 2636

{
  "compliance_spec": {
    "integration_app_name": "SAGE",
    "entity_name": "JOURNAL_ENTRY",
    "entity_field_mapping": [
      {
        "is_user_defined": false,
        "node_type": "ROOT",
        "sequence_no": 1,
        "source_field": [
          "RRJ"
        ],
        "source_field_type": "Constant",
        "target_field_path": "glJournal.id",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ROOT",
        "sequence_no": 2,
        "source_field": [
          "posting_date"
        ],
        "source_field_type": "Field",
        "target_field_path": "postingDate",
        "target_field_type": "date",
        "transformation_rule": "TO_CHAR(:1, 'YYYY-MM-DD')"
      },
      {
        "is_user_defined": false,
        "node_type": "ROOT",
        "sequence_no": 3,
        "source_field": [
          "Revenue entries"
        ],
        "source_field_type": "Constant",
        "target_field_path": "description",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ROOT",
        "sequence_no": 4,
        "source_field": [
          "journal_run_id"
        ],
        "source_field_type": "Field",
        "target_field_path": "referenceNumber",
        "target_field_type": "string",
        "transformation_rule": "'<ENV>RR_JOURNAL_ID:' || TO_CHAR(:1)"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 5,
        "source_field": [
          "revenue_contract_id"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.documentId",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 6,
        "source_field": [
          "dr_cr_indicator"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.txnType",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 7,
        "source_field": [
          "amount"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.txnAmount",
        "target_field_type": "number",
        "transformation_rule": "TO_VARCHAR(:1)"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 8,
        "source_field": [
          "gl_account"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.glAccount.id",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 9,
        "source_field": [
          "gl_int_department_id"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.dimensions.department.id",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 10,
        "source_field": [
          "gl_int_location_id"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.dimensions.location.id",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 11,
        "source_field": [
          "functional_currency"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.currency.baseCurrency",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 12,
        "source_field": [
          "transaction_currency"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.currency.txnCurrency",
        "target_field_type": "string"
      }
    ]
  }
}
200

Update OutboundIntegration Application Registry

{
  "compliance_id": "3cd207d7-f3c4-4c9d-a7b0-65adee382101",
  "compliance_name": "outbound-integration-entity-field-mapping",
  "compliance_spec": {},
  "message": "Successfully Updated."
}

Update Outbound Integration Entity Field Mapping

post
/apis/outbound_integration/v1/entity-field-mapping/{integration_app_name}/{entity_name}

This API is used to configurte fist time the field mapping details between Source System (RightRev) & Traget system (GL Integration system)

Path parameters
integration_app_namestringRequired

Name of the GL Integration system.

entity_namestringRequired

Entity name will be - JOURNAL_ENTRY

Body
Responses
200

Configure first time OutboundIntegration Application Registry

application/json
compliance_idstringRequired

A system-generated compliance ID to configure Outbound Integration Application Registryfiled mapping details

compliance_namestringRequired

Name of the policy

compliance_specobjectRequired

Defines the specific rules and standards where a system must process adhering to the compliant.

messagestringRequired

Success or failure message on updating the mapping details.

post/apis/outbound_integration/v1/entity-field-mapping/{integration_app_name}/{entity_name}
POST /apis/outbound_integration/v1/entity-field-mapping/{integration_app_name}/{entity_name} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 2636

{
  "compliance_spec": {
    "integration_app_name": "SAGE",
    "entity_name": "JOURNAL_ENTRY",
    "entity_field_mapping": [
      {
        "is_user_defined": false,
        "node_type": "ROOT",
        "sequence_no": 1,
        "source_field": [
          "RRJ"
        ],
        "source_field_type": "Constant",
        "target_field_path": "glJournal.id",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ROOT",
        "sequence_no": 2,
        "source_field": [
          "posting_date"
        ],
        "source_field_type": "Field",
        "target_field_path": "postingDate",
        "target_field_type": "date",
        "transformation_rule": "TO_CHAR(:1, 'YYYY-MM-DD')"
      },
      {
        "is_user_defined": false,
        "node_type": "ROOT",
        "sequence_no": 3,
        "source_field": [
          "Revenue entries"
        ],
        "source_field_type": "Constant",
        "target_field_path": "description",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ROOT",
        "sequence_no": 4,
        "source_field": [
          "journal_run_id"
        ],
        "source_field_type": "Field",
        "target_field_path": "referenceNumber",
        "target_field_type": "string",
        "transformation_rule": "'<ENV>RR_JOURNAL_ID:' || TO_CHAR(:1)"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 5,
        "source_field": [
          "revenue_contract_id"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.documentId",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 6,
        "source_field": [
          "dr_cr_indicator"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.txnType",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 7,
        "source_field": [
          "amount"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.txnAmount",
        "target_field_type": "number",
        "transformation_rule": "TO_VARCHAR(:1)"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 8,
        "source_field": [
          "gl_account"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.glAccount.id",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 9,
        "source_field": [
          "gl_int_department_id"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.dimensions.department.id",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 10,
        "source_field": [
          "gl_int_location_id"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.dimensions.location.id",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 11,
        "source_field": [
          "functional_currency"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.currency.baseCurrency",
        "target_field_type": "string"
      },
      {
        "is_user_defined": false,
        "node_type": "ARRAY_ITEM",
        "sequence_no": 12,
        "source_field": [
          "transaction_currency"
        ],
        "source_field_type": "Field",
        "target_field_path": "lines.currency.txnCurrency",
        "target_field_type": "string"
      }
    ]
  }
}
200

Configure first time OutboundIntegration Application Registry

{
  "compliance_id": "3cd207d7-f3c4-4c9d-a7b0-65adee382101",
  "compliance_name": "outbound-integration-entity-field-mapping",
  "compliance_spec": {},
  "message": "Successfully Updated."
}

Get Outbound Integration Application Registry

get
/apis/outbound_integration/v1/application-registry/{object_unique_value}

This API is to retrieve the OutboundIntegration Application Registry details by ID

Path parameters
object_unique_valuestringRequired
  • Abbreviated names of Outbound App Registries
  • User can provide values provided below in brackets for respective GL systems
  • NetSuite, Microsoft Dynamics 365 (D365), SAGE Intact (SAGE), Rillets(Ri) and QuickBooks Online (QBO)
Responses
200

Get OutboundIntegration Application Registry By ID

application/json
compliance_idstringRequired

A system-generated compliance ID on creating or updating the policy.

compliance_namestringRequired

Name of the policy.

total_recordsintegerRequired

Total no of records.

get/apis/outbound_integration/v1/application-registry/{object_unique_value}
GET /apis/outbound_integration/v1/application-registry/{object_unique_value} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
200

Get OutboundIntegration Application Registry By ID

[
  {
    "compliance_id": "51c33993-378e-448d-8531-ec370a40fabc",
    "compliance_name": "outbound-integration-application-registry",
    "compliance_spec": [
      {
        "active": false,
        "application_desc": "Sage Intacct",
        "application_name": "SAGE",
        "details": {
          "user_name": "RightRev@rightrevMPP-DEV"
        },
        "test_connection_error": null,
        "test_connection_status": "SUCCESS",
        "test_connection_timestamp_utc": "2026-05-08 05:32:01.661 Z"
      }
    ],
    "total_records": 1
  }
]

Update Outbound Integration Application Registry

post
/apis/outbound_integration/v1/application-registry/{object_unique_value}

This API is to update the OutboundIntegration Application Registry details by ID

Path parameters
object_unique_valuestringRequired
  • Abbreviated names of Outbound App Registries
  • User can provide values provided below in brackets for respective GL systems
  • NetSuite, Microsoft Dynamics 365 (D365), SAGE Intact (SAGE), Rillets(Ri) and QuickBooks Online (QBO)
Body
user_namestringRequired

Id of the user updating the policy.

compliance_namestringRequired

Name of the policy por GL integration system.

Responses
200

Update OutboundIntegration Application Registry

application/json
compliance_idstringRequired

A system-generated compliance ID on creating or updating the policy.

compliance_namestringRequired

Name of the policy

messagestringRequired

Success or failure message on updating the GL Integration system details.

object_unique_valuestringRequired

Abbreviated name of the Outbound app regsitry.

post/apis/outbound_integration/v1/application-registry/{object_unique_value}
POST /apis/outbound_integration/v1/application-registry/{object_unique_value} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "user_name": "thiyagu",
  "compliance_name": "outbound-integration-application-registry",
  "compliance_spec": {
    "application_name": "SAGE",
    "user_name": "RightRev@rightrevMPP-DEV"
  }
}
200

Update OutboundIntegration Application Registry

{
  "compliance_id": "4de5c69a-2473-45e6-bd10-b745521c3435",
  "compliance_name": "outbound-integration-application-registry",
  "compliance_spec": {
    "active": false,
    "application_desc": "Sage Intacct",
    "application_name": "SAGE",
    "details": {
      "user_name": "RightRev@rightrevMPP-DEV"
    },
    "test_connection_error": null,
    "test_connection_status": "SUCCESS",
    "test_connection_timestamp_utc": "2026-05-08 05:38:34.298 Z"
  },
  "message": "Successfully Updated!",
  "object_unique_value": "SAGE"
}

Delete Outbound Integration Application Registry

delete
/apis/outbound_integration/v1/application-registry/{object_unique_value}

This API is to delete the Outbound Integration Application Registry details by ID

Path parameters
object_unique_valuestringRequired
  • Abbreviated names of Outbound App Registries
  • User can provide values provided below in brackets for respective GL systems
  • NetSuite, Microsoft Dynamics 365 (D365), SAGE Intact (SAGE), Rillets(Ri) and QuickBooks Online (QBO)
Responses
200

Delete OutboundIntegration Application Registry

application/json
compliance_idstringRequired

A system-generated compliance ID on deleting the app registry.

compliance_namestringRequired

Name of the policy.

messagestringRequired

Success or failure message on deleting the app registry.

delete/apis/outbound_integration/v1/application-registry/{object_unique_value}
DELETE /apis/outbound_integration/v1/application-registry/{object_unique_value} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
200

Delete OutboundIntegration Application Registry

{
  "compliance_id": "e86da39e-64be-4937-93e0-df65c96c2c85",
  "compliance_name": "outbound-integration-application-registry",
  "message": "Successfully Deleted!"
}
PreviousReprocess Error Transactions
NextPeriod Close

Last updated

Was this helpful?