{ "openapi": "3.0.1", "info": { "title": "MFG Integration Management API", "description": "Provides APIs for managing ECI MFG Integration Engine Configurations.\n\n***IMPORTANT!*** This API is undergoing breaking changes. Please contact the team with any questions.\n\nThis API enforces a rate limit of 500 requests per minute from the same Source IP. Other more specific rate limits may also apply.\n\n## Authentication\nThere are two authentication mechanisms for this API.\n\n### OpenID Connect\nFor Administrators, Product Managers, and Company Managers,\nthe ID token obtained from an OpenID Connect/OAuth 2.0 auth code or implicit flow w/PKCE.\n\n```Authorization: Bearer [id_token]```\n\nThe OpenID Connect discovery document is [located here](https://cognito-idp.us-east-1.amazonaws.com/us-east-1_9IYBf4TpD/.well-known/openid-configuration).\n\n### API Keys\nIf you have been provided an API key, it can be used with HTTP Basic authentication, or via the \nauthorization header as follows:\n\n```\nAuthorization: Basic Zm9vOmJhcg==\nAuthorization: ApiKey ClientId:ClientSecret\n```\n", "contact": { "name": "ECI Manufacturing Integration Team", "url": "https://www.ecisolutions.com/support/" }, "version": "2.22.273+b02c1dfd00" }, "servers": [ { "url": "https://api-user.integrations.ecimanufacturing.com:443", "description": "Production" } ], "paths": { "/api/activation-codes": { "get": { "tags": [ "ActivationCode" ], "summary": "Get the list of Activation-Codes.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get the list of Activation-Codes matching the specified filter criteria.", "operationId": "ListActivationCode", "parameters": [ { "name": "integration_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "product_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "is_active", "in": "query", "schema": { "type": "boolean" } }, { "name": "is_used", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActivationCodeResponseModelIListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivationCodeResponseModelIListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivationCodeResponseModelIListAPIResponse" } } } } } }, "post": { "tags": [ "ActivationCode" ], "summary": "Register the Activation code.", "description": "Accessible By: Global Admin and Product Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Register the Activation code by Global Admin only.", "operationId": "AddActivationCode", "requestBody": { "description": "This is an object which contains all optional fields to add the Activation codes.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ActivationCodeRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ActivationCodeRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ActivationCodeRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActivationCodeResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivationCodeResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivationCodeResponseModelAPIResponse" } } } } } } }, "/api/activation-codes/generate": { "post": { "tags": [ "ActivationCode" ], "summary": "Generate the Bulk Activation code.", "description": "Accessible By: Global Admin and Product Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Generate the bulk activation code by Global Admin only.", "operationId": "GenerateActivationCode", "requestBody": { "description": "This is an object which contains all fields to add the Activation codes.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GenerateActivationCodeRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GenerateActivationCodeRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GenerateActivationCodeRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActivationCodeResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivationCodeResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivationCodeResponseModelAPIResponse" } } } } } } }, "/api/analytics": { "get": { "tags": [ "Analytics" ], "summary": "Gets analytics data for the applications and products, including total API calls, active keys, and trends over time. \r\nThis endpoint is intended for use by product administrators and support users to monitor usage and identify potential issues or opportunities for optimization.", "description": "The response includes summary KPIs, daily API call counts for trend analysis, aggregated requests by application, and a product breakdown with usage metrics.\r\nThe data is sourced from logging views that aggregate information over a configurable period (defaulting to 90 days).\r\nThis allows stakeholders to understand overall usage patterns, identify high-usage applications or products, and make informed decisions about capacity planning, support prioritization, and potential optimizations. \r\nAccess to this endpoint is restricted to users that satisfy the \"CanViewAnalytics\" policy for the requested resource scope.", "operationId": "GetAnalyticsData", "parameters": [ { "name": "periodDays", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "companyId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "systemId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "productName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AnalyticsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnalyticsResponse" } } } } } } }, "/api/api-users": { "post": { "tags": [ "ApiUser" ], "summary": "Register the API Users by Global Admin, Product Admin, Company Manager.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI, Payment Integration.\\\r\nDescription: This API registers all API Users by Global Admin, Product Admin and Product Support User.\r\nUsing Company Manager, it registers only the ERP, NET1, Avalara and JobBOSS2 public API Users except the financial API Users.", "operationId": "RegisterApiUser", "requestBody": { "description": "This is an object which contains all required and optional fields to register the API Users", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErpApiUser" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErpApiUser" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErpApiUser" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } } } } } } }, "/api/api-users/{clientId}/external-connection": { "patch": { "tags": [ "ApiUser" ], "summary": "Update Connection Properties", "description": "Updates the master key values for the connection associated with the given API Credential\r\nClient ID and applies those settings to the API credential.\r\n
\r\nThis method can only be invoked by the original creator of the connection.\r\n", "operationId": "UpdateConnectionProperties", "parameters": [ { "name": "clientId", "in": "path", "description": "The API Credential Client ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateConnectionModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateConnectionModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateConnectionModel" } ] } } } }, "responses": { "204": { "description": "No Content" } } } }, "/api/api-users/{userId}": { "get": { "tags": [ "ApiUser" ], "summary": "This API is used to get the details of the API User and their associated properties.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Global Admin can get the details of all the API Users.\r\nProduct Admin can get only those API Users' details, whom they can access.", "operationId": "GetApiUserDetailsById", "parameters": [ { "name": "userId", "in": "path", "description": "UserId of API User and is required in Guid", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } } } } } }, "put": { "tags": [ "ApiUser" ], "summary": "Update first or last name of the API User and its property settings.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to update the first or last name of API Users in database and cognito too. \r\nAnd Erpsetting values of API Users in database.", "operationId": "UpdateApiUser", "parameters": [ { "name": "userId", "in": "path", "description": "The API User id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "This is an object which contains some required and optional field", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateApiUserRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateApiUserRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateApiUserRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } } } } } }, "patch": { "tags": [ "ApiUser" ], "summary": "To change the status of API User by Global Admin, Product Admin and Company Manager.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to change the status from active to inactive and vice-versa of any API User by Global Admin, Product Admin and Company Manager.", "operationId": "UserStatusApiUser", "parameters": [ { "name": "userId", "in": "path", "description": "User ID of API User and this field is required in GUID format", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The only property isActive with a value of true to activate the account or false to deactivate the account.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ToggleEntityModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ToggleEntityModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ToggleEntityModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } }, "delete": { "tags": [ "ApiUser" ], "summary": "This API is used to delete the API Users.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: It Hard delete the API Users details from database and cognito.", "operationId": "DeleteApiUser", "parameters": [ { "name": "userId", "in": "path", "description": "The userId of API Users which we want to delete and it is required in GUID format.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/api-users/{userId}/activity": { "post": { "tags": [ "ApiUser" ], "summary": "Updates the last activity date/time for the Company and API Credential and returns the API Credential's details.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Financial Admin, Company Manager.\\\r\nAccessed From: User Mgmt UI, Payment Integration, Financial Integration, ERP Integration, Avatax Integration.\\\r\nDescription: This method is typically used by integrations to obtain API Credential integration details.", "operationId": "UpdateApiUserLastActivity", "parameters": [ { "name": "userId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiUserResponseModelAPIResponse" } } } } } } }, "/api/api-users/{userId}/confirm": { "post": { "tags": [ "ApiUser" ], "summary": "Confirm pending API User manually, if API User has not received verification mail.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Confirm pending API User manually, if API User has not received verification mail.", "operationId": "ConfirmApiUser", "parameters": [ { "name": "userId", "in": "path", "description": "User ID of API User and this filed is required in GUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } } } } } } }, "/api/api-users/{userId}/resend_link": { "post": { "tags": [ "ApiUser" ], "summary": "This API is used to resend verification link for the API User who has Enablepasswordreset set to \"TRUE\".", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI, Payment Integration.\\\r\nDescription: Used to resend verification link for the API User who has Enablepasswordreset set to \"TRUE\".", "operationId": "ResendLinkApiUser", "parameters": [ { "name": "userId", "in": "path", "description": "The unique Guid user Id of the API User", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userName", "in": "query", "description": "The unique username of the API User (optional)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/api-users/login": { "post": { "tags": [ "ApiUser" ], "summary": "This API authenticates the user credentials.", "description": "Accessible By: Everyone can use this API because it's Anonymous.\\\r\nAccessed From: User Mgmt UI, Payment Integration.\\\r\nDescription: This API authenticates the user credentials. After successful authentication, it returns AWS cognito tokens.", "operationId": "LoginApiUser", "requestBody": { "description": "This is an object which contains username and password and both are required.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthenticateAPIUser" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthenticateAPIUser" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthenticateAPIUser" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseAPIResponse" } } } } } } }, "/api/api-users/test-connection": { "post": { "tags": [ "ApiUser" ], "summary": "Check connectivity with the integration's system using the provided settings.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Check connectivity with the integration's system using the provided settings.", "operationId": "TestConnectionApiUser", "parameters": [ { "name": "system_Id", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TestConnectionRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TestConnectionRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TestConnectionRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TestConnectionResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TestConnectionResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TestConnectionResponseModelAPIResponse" } } } } } } }, "/api/ApiUser": { "post": { "tags": [ "ApiUser" ], "summary": "Register the API Users by Global Admin, Product Admin, Company Manager.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI, Payment Integration.\\\r\nDescription: This API registers all API Users by Global Admin, Product Admin and Product Support User.\r\nUsing Company Manager, it registers only the ERP, NET1, Avalara and JobBOSS2 public API Users except the financial API Users.", "operationId": "RegisterApiUser", "requestBody": { "description": "This is an object which contains all required and optional fields to register the API Users", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErpApiUser" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErpApiUser" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErpApiUser" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } } } } } } }, "/api/ApiUser/{userId}": { "get": { "tags": [ "ApiUser" ], "summary": "This API is used to get the details of the API User and their associated properties.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Global Admin can get the details of all the API Users.\r\nProduct Admin can get only those API Users' details, whom they can access.", "operationId": "GetApiUserDetailsById", "parameters": [ { "name": "userId", "in": "path", "description": "UserId of API User and is required in Guid", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } } } } } }, "put": { "tags": [ "ApiUser" ], "summary": "Update first or last name of the API User and its property settings.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to update the first or last name of API Users in database and cognito too. \r\nAnd Erpsetting values of API Users in database.", "operationId": "UpdateApiUser", "parameters": [ { "name": "userId", "in": "path", "description": "The API User id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "This is an object which contains some required and optional field", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateApiUserRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateApiUserRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateApiUserRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } } } } } }, "patch": { "tags": [ "ApiUser" ], "summary": "To change the status of API User by Global Admin, Product Admin and Company Manager.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to change the status from active to inactive and vice-versa of any API User by Global Admin, Product Admin and Company Manager.", "operationId": "UserStatusApiUser", "parameters": [ { "name": "userId", "in": "path", "description": "User ID of API User and this field is required in GUID format", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The only property isActive with a value of true to activate the account or false to deactivate the account.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ToggleEntityModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ToggleEntityModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ToggleEntityModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } }, "delete": { "tags": [ "ApiUser" ], "summary": "This API is used to delete the API Users.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: It Hard delete the API Users details from database and cognito.", "operationId": "DeleteApiUser", "parameters": [ { "name": "userId", "in": "path", "description": "The userId of API Users which we want to delete and it is required in GUID format.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/ApiUser/{userId}/activity": { "post": { "tags": [ "ApiUser" ], "summary": "Updates the last activity date/time for the Company and API Credential and returns the API Credential's details.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Financial Admin, Company Manager.\\\r\nAccessed From: User Mgmt UI, Payment Integration, Financial Integration, ERP Integration, Avatax Integration.\\\r\nDescription: This method is typically used by integrations to obtain API Credential integration details.", "operationId": "UpdateApiUserLastActivity", "parameters": [ { "name": "userId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiUserResponseModelAPIResponse" } } } } } } }, "/api/ApiUser/{userId}/confirm": { "post": { "tags": [ "ApiUser" ], "summary": "Confirm pending API User manually, if API User has not received verification mail.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Confirm pending API User manually, if API User has not received verification mail.", "operationId": "ConfirmApiUser", "parameters": [ { "name": "userId", "in": "path", "description": "User ID of API User and this filed is required in GUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } } } } } } }, "/api/ApiUser/{userId}/resend_link": { "post": { "tags": [ "ApiUser" ], "summary": "This API is used to resend verification link for the API User who has Enablepasswordreset set to \"TRUE\".", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI, Payment Integration.\\\r\nDescription: Used to resend verification link for the API User who has Enablepasswordreset set to \"TRUE\".", "operationId": "ResendLinkApiUser", "parameters": [ { "name": "userId", "in": "path", "description": "The unique Guid user Id of the API User", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userName", "in": "query", "description": "The unique username of the API User (optional)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/ApiUser/login": { "post": { "tags": [ "ApiUser" ], "summary": "This API authenticates the user credentials.", "description": "Accessible By: Everyone can use this API because it's Anonymous.\\\r\nAccessed From: User Mgmt UI, Payment Integration.\\\r\nDescription: This API authenticates the user credentials. After successful authentication, it returns AWS cognito tokens.", "operationId": "LoginApiUser", "requestBody": { "description": "This is an object which contains username and password and both are required.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthenticateAPIUser" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthenticateAPIUser" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthenticateAPIUser" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseAPIResponse" } } } } } } }, "/api/ApiUser/test-connection": { "post": { "tags": [ "ApiUser" ], "summary": "Check connectivity with the integration's system using the provided settings.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Check connectivity with the integration's system using the provided settings.", "operationId": "TestConnectionApiUser", "parameters": [ { "name": "system_Id", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TestConnectionRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TestConnectionRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TestConnectionRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TestConnectionResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TestConnectionResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TestConnectionResponseModelAPIResponse" } } } } } } }, "/api/applications": { "get": { "tags": [ "Application" ], "summary": "This API is used to get the Application's list by optional filters.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: It is used to get the Application's list with optional filters.", "operationId": "GetApplications", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "product_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "is_active", "in": "query", "schema": { "type": "boolean" } }, { "name": "integration_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "role_id", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApplicationResponseIListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseIListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseIListAPIResponse" } } } } } }, "post": { "tags": [ "Application" ], "summary": "This API is used to create the Application record.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: It used to create the Application details of with the given request model with all validations.", "operationId": "CreateApplication", "requestBody": { "description": "Application request model for creating a application with all the validation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApplicationRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApplicationRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApplicationRequestModel" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreatedApplicationResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatedApplicationResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatedApplicationResponseAPIResponse" } } } } } } }, "/api/applications/{id}": { "get": { "tags": [ "Application" ], "summary": "This API is used to get the Application's detail by ID.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: It is used to get the Application's detail by given client id.", "operationId": "GetApplicationById", "parameters": [ { "name": "id", "in": "path", "description": "Application client id to get application detail.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApplicationResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseAPIResponse" } } } } } }, "patch": { "tags": [ "Application" ], "summary": "This API is used to update the Application record.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: It used to update the Application details of given id.", "operationId": "UpdateApplicationById", "parameters": [ { "name": "id", "in": "path", "description": "The applicationId of Application which we want to update and it is required in GUID format.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateApplicationRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateApplicationRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateApplicationRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApplicationResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseAPIResponse" } } } } } }, "delete": { "tags": [ "Application" ], "summary": "This API is used to delete the Application record.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: It used to delete the Application of given id.", "operationId": "DeleteApplicationById", "parameters": [ { "name": "id", "in": "path", "description": "The applicationId of Application which we want to delete and it is required in GUID format.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/applications/{id}/client-secret/$value": { "get": { "tags": [ "Application" ], "summary": "This API is used to get the Application's secret value.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: It is used to get the Application's secret value of given client id.", "operationId": "GetApplicationClientSecretValue", "parameters": [ { "name": "id", "in": "path", "description": "Application client id to get client secret value.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApplicationSecretValueResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationSecretValueResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplicationSecretValueResponseAPIResponse" } } } } } } }, "/api/companies": { "get": { "tags": [ "Company" ], "summary": "List the Companies.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: List the Companies by optional filters.", "operationId": "GetCompanies", "parameters": [ { "name": "q", "in": "query", "description": "Return only companies whose Company Name or Customer ID match this value (case insensitively)", "schema": { "type": "string" } }, { "name": "product_id", "in": "query", "description": "Return only companies assigned the specified Product ID, if provided", "schema": { "type": "integer", "format": "int32" } }, { "name": "is_active", "in": "query", "description": "Return only active companies (true), inactive companies (false), or both (no value)", "schema": { "type": "boolean" } }, { "name": "integration_id", "in": "query", "description": "Return only companies assigned the specified Integration ID, if provided", "schema": { "type": "integer", "format": "int32" } }, { "name": "customer_id", "in": "query", "description": "Return only company with the exact match of the specified CustomerId, if provided", "schema": { "type": "string" } }, { "name": "nexus_id", "in": "query", "description": "Return only companies assigned the specified NexusId, if provided", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyResponseIListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponseIListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyResponseIListAPIResponse" } } } } } }, "post": { "tags": [ "Company" ], "summary": "Create a Company.", "description": "Accessible By: Global Admin, Product Admin.\\\r\nAccessed From: User Mgmt UI, Payment Integration.\\\r\nDescription: Create a Company.\r\nGlobal Admin can add a Company assigned to any Product.\r\nProduct Admin may only add a Company assigned to one of the Products which they can administrate.\r\nCompany Id and Customer Id must be unique.", "operationId": "CreateCompany", "requestBody": { "description": "An object which contains all the required and optional fields to create a company. The companyName and customerId is optional if nexusId is provided", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCompany" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCompany" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCompany" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddUpdateCompanyResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddUpdateCompanyResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddUpdateCompanyResponseModelAPIResponse" } } } } } } }, "/api/companies/{id}": { "get": { "tags": [ "Company" ], "summary": "Get the details of a Company by Company Id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI, Payment Integration.\\\r\nDescription: Get the details of a Company by Company Id.", "operationId": "GetCompanyDetailById", "parameters": [ { "name": "id", "in": "path", "description": "The Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserCompanyAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserCompanyAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserCompanyAPIResponse" } } } } } }, "patch": { "tags": [ "Company" ], "summary": "Update a Company.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Update a Company.\r\nProduct Admin and Product Support User may only update a Company assigned to one of the Products which they can administrate.\r\nCompany Id and Customer Id must be unique.", "operationId": "UpdateCompany", "parameters": [ { "name": "id", "in": "path", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "An object which contains all the required and optional fields to update a company.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCompany" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCompany" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCompany" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddUpdateCompanyResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddUpdateCompanyResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddUpdateCompanyResponseModelAPIResponse" } } } } } }, "delete": { "tags": [ "Company" ], "summary": "Delete a company.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: API is used to delete a company and their associated properties.", "operationId": "DeleteCompany", "parameters": [ { "name": "id", "in": "path", "description": "The company id of the company to delete.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "force", "in": "query", "description": "Whether to force deletion even when the company has associated API keys or active auth sessions", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/companies/{id}/api-logs": { "get": { "tags": [ "Company" ], "summary": "Get a list of API Logs.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get a list of API Logs for a Company.", "operationId": "ApiLogsCompany", "parameters": [ { "name": "id", "in": "path", "description": "Company ID field is required", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "logType", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "duration", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "Set UTC startDate in format like {YYYY-MM-DDTHH:MM:SS}", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "Set UTC endDate in format like {YYYY-MM-DDTHH:MM:SS}", "schema": { "type": "string", "format": "date-time" } }, { "name": "is_error", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "methodType", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "productName", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "secDuration", "in": "query", "description": "", "schema": { "type": "string", "default": "" } }, { "name": "system", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "traceId", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "integrationId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationName", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TraceMessageResponseListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TraceMessageResponseListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TraceMessageResponseListAPIResponse" } } } } } } }, "/api/companies/{id}/api-users": { "get": { "tags": [ "Company" ], "summary": "List the API Credentials for a specific Company by Id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: List the API Credentials for a specific Company by Id and optionally also for a specific Integration Id.", "operationId": "ListCompanyApiUsers", "parameters": [ { "name": "id", "in": "path", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "query", "description": "Integration Id", "schema": { "type": "integer", "format": "int32" } }, { "name": "user_type", "in": "query", "description": "Filter by credential type: 1 = Person, 2 = System, 3 = GroupProfile, 4 = NexusUser. Omit to return all types.", "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiCredentialUserType" } ] } }, { "name": "is_active", "in": "query", "description": "Filter by active status. Omit to return both active and inactive.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiUserIntegrationDetailResponseApiUserListResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiUserIntegrationDetailResponseApiUserListResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiUserIntegrationDetailResponseApiUserListResponseAPIResponse" } } } } } } }, "/api/companies/{id}/applications": { "get": { "tags": [ "Company" ], "summary": "Get the list of Application based on Company Id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get the list of Application based on Company Id.", "operationId": "ListApplicationsCompany", "parameters": [ { "name": "id", "in": "path", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApplicationResultIListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationResultIListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplicationResultIListAPIResponse" } } } } } } }, "/api/companies/{id}/auth-sessions": { "get": { "tags": [ "Company" ], "summary": "Get the list of Auth Session based on Company Id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get the list of Auth Session based on Company Id.", "operationId": "ListAuthSessionsCompany", "parameters": [ { "name": "id", "in": "path", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthSessionResultIListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthSessionResultIListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthSessionResultIListAPIResponse" } } } } } } }, "/api/companies/{id}/company-managers": { "get": { "tags": [ "Company" ], "summary": "Get the list of Company Manager based on Company Id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get the list of Company Manager based on Company Id.", "operationId": "ListCompanyManagers", "parameters": [ { "name": "id", "in": "path", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ERPUserListResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPUserListResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ERPUserListResponseAPIResponse" } } } } } } }, "/api/companies/{id}/external-connections": { "get": { "tags": [ "Company" ], "summary": "List external connections.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Returns a list of external connections associated with the specified company.", "operationId": "ExternalConnectionsCompany", "parameters": [ { "name": "id", "in": "path", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FinancialCompanyResponseModelListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FinancialCompanyResponseModelListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FinancialCompanyResponseModelListAPIResponse" } } } } } } }, "/api/companies/{id}/integrations": { "post": { "tags": [ "Company" ], "summary": "Create or enable a company integration.", "description": "Accessible By: Global Admin and Product Admin.\\\r\nAccessed From: User Mgmt UI, Payment Integration.\\\r\nDescription: Create or enable a company integration.", "operationId": "AddCompanyIntegration", "parameters": [ { "name": "id", "in": "path", "description": "The Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "A model containing the Integration details needed to create the Company Integration.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCompanyIntegrationModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCompanyIntegrationModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCompanyIntegrationModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyIntegrationDetailResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyIntegrationDetailResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyIntegrationDetailResponseAPIResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/companies/{id}/integrations/{integrationId}": { "get": { "tags": [ "Company" ], "summary": "Get the details and settings for a company's integration by integration ID.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nDescription: Returns detailed information about a specific integration for a company, \r\nincluding systems, properties, and external connections.", "operationId": "GetIntegrationDetailCompany", "parameters": [ { "name": "id", "in": "path", "description": "Company ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "description": "Integration ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyIntegrationDetailResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyIntegrationDetailResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyIntegrationDetailResponseAPIResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } }, "patch": { "tags": [ "Company" ], "summary": "Enable or disable a company integration.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Enable or disable a company integration.", "operationId": "UpdateCompanyIntegration", "parameters": [ { "name": "id", "in": "path", "description": "Company Id and is required", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "description": "Integration Id and is required", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The only property isActive with a value of true to enable the integration or false to disable the integration.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCompanyIntegrationModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCompanyIntegrationModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCompanyIntegrationModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } }, "delete": { "tags": [ "Company" ], "summary": "Removes an integration from a company.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Removes an integration from a company.", "operationId": "DeleteCompanyIntegration", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/companies/{id}/integrations/{integrationId}/external-connections": { "get": { "tags": [ "Company" ], "summary": "List external connections.", "description": "Accessible By: Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Returns external connections for a specific company integration.", "operationId": "ListCompanies", "parameters": [ { "name": "id", "in": "path", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "description": "Integration Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ExternalCompanyResponseIListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalCompanyResponseIListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalCompanyResponseIListAPIResponse" } } } } } }, "post": { "tags": [ "Company" ], "summary": "Create external connection.", "description": "Accessible By: Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Validates and creates an external connection with API credentials.", "operationId": "ValidateIntegrationCompany", "parameters": [ { "name": "id", "in": "path", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "description": "Integration Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "An object which contains all the required and optional fields to create the external connection.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateIntegrationRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateIntegrationRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateIntegrationRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" } } } } } } }, "/api/companies/{id}/integrations/{integrationId}/external-connections/{externalConnectionId}": { "delete": { "tags": [ "Company" ], "summary": "Delete external connection.", "description": "Accessible By: Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Deletes an external connection and its associated API credentials.", "operationId": "RemoveCompany", "parameters": [ { "name": "id", "in": "path", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "path", "description": "Integration Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "externalConnectionId", "in": "path", "description": "External Connection Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/companies/{id}/managers": { "get": { "tags": [ "Company" ], "summary": "Get the details of Company Managers by Company Id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get the details of Company Managers by Company Id.", "operationId": "GetCompanyManagersDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserCompanyAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserCompanyAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserCompanyAPIResponse" } } } } } } }, "/api/companies/{id}/properties": { "get": { "tags": [ "Company" ], "summary": "Get Integration Properties Values", "description": "Gets a list of Integration Properties for a Company, including the values saved for those settings.\r\n\r\nAccessible By: Global Admin, Product Admin, Product Support User and Company Manager.\\\r\nAccessed From: User Mgmt UI.", "operationId": "GetApiSettingsCompany", "parameters": [ { "name": "id", "in": "path", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyErpSettingsListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyErpSettingsListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyErpSettingsListAPIResponse" } } } } } } }, "/api/companies/{id}/properties/{settingId}": { "get": { "tags": [ "Company" ], "summary": "This API is used to get the decrypted value of property.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: API is used to get the decrypted vaue of property.", "operationId": "GetErpSettingDecryptedValueCompany", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "settingId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "encryptedValue", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/companies/{id}/properties/{settingId}/$value": { "get": { "tags": [ "Company" ], "summary": "Get the decrypted value of master key property.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: API is used to get the decrypted vaue of property.", "operationId": "GetErpSettingDecryptedValueByIdCompany", "parameters": [ { "name": "id", "in": "path", "description": "The Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "settingId", "in": "path", "description": "The master key setting id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "encryptedValue", "in": "query", "description": "The master key setting value", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/companies/{id}/summary": { "get": { "tags": [ "Company" ], "summary": "Get company summary information including integrations.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager, API Keys.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get summary information about a company including its integrations. Replaces the obsolete /api/Dashboard/users endpoint.", "operationId": "GetCompanySummary", "parameters": [ { "name": "id", "in": "path", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanySummaryResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanySummaryResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanySummaryResponseAPIResponse" } } } } } } }, "/api/companies/{id}/systems": { "get": { "tags": [ "Company" ], "summary": "Get the list of systems and integrations for a specific Company by Company Id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get the list of systems and integrations for a specific Company by Company Id.\r\nIf we pass the integration id then it return the system list of that integration only.", "operationId": "ListCompanySystems", "parameters": [ { "name": "id", "in": "path", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "query", "description": "Integration Id to optionally filter the systems list", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ListCompanySystemResultIListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ListCompanySystemResultIListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListCompanySystemResultIListAPIResponse" } } } } } } }, "/api/companies/activate": { "post": { "tags": [ "Company" ], "summary": "Creates a new company using the given activation code and returns a company manager API key to use for further requests.", "description": "Accessible By: Everyone can use this api because it's Anonymous.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Creates a new company using the given activation code and returns a company manager API key to use for further requests.", "operationId": "ActivateCompany", "requestBody": { "description": "The companyName is optional if nexusId is provided", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CompanyActivateRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CompanyActivateRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CompanyActivateRequest" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyActivateResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyActivateResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyActivateResponseAPIResponse" } } } } } } }, "/api/connections": { "get": { "tags": [ "Connection" ], "summary": "Get a connection for the given credentials.", "description": "Accessible By: API Key.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get a connection for the given credential clientId, including its financial company details if applicable.", "operationId": "GetConnection", "parameters": [ { "name": "client_id", "in": "query", "description": "API credential clientId for the connection to get.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConnectionResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConnectionResponseModelAPIResponse" } } } } } }, "delete": { "tags": [ "Connection" ], "summary": "This API is used to remove a connection for the given credentials.", "description": "Accessible By: API Key.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Removes a connection for the given credential clientId, including its financial company details if applicable.", "operationId": "DeleteConnection", "parameters": [ { "name": "client_id", "in": "query", "description": "API credential clientId for the connection to remove.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/connections/{externalConnectionId}": { "put": { "tags": [ "Connection" ], "summary": "Update an existing connection configuration.", "description": "Used by MYOB, Nuvei, and AFAS SB connection flows because they require multi-step configuration. Updates additional properties for the connection after user input.", "operationId": "UpdateExternalCompanyDetailConnection", "parameters": [ { "name": "externalConnectionId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", "additionalProperties": { } } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" } } } } } }, "delete": { "tags": [ "Connection" ], "summary": "Remove External Connection", "description": "This API is used to remove an external connection. This will also remove any associated API credentials.\r\nUsed when a connection flow is cancelled to clean up partially configured connections.\r\nAccessible By: Any authorized user/system or during an unexpired auth session.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to remove Financial company.", "operationId": "FinancialCompanyConnection", "parameters": [ { "name": "externalConnectionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/connections/{externalConnectionId}/external-data": { "get": { "tags": [ "Connection" ], "summary": "Get data from the externally connected system for the purposes of displaying to the user for validation.", "operationId": "GetPostValidateDetailConnection", "parameters": [ { "name": "externalConnectionId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "clientSecret", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" } } } } } } }, "/api/connections/auth": { "post": { "tags": [ "Connection" ], "summary": "Generates access and refresh tokens and saves them along with selected financial company.", "description": "Accessible By: Everyone can use this API because it's Anonymous.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Generates access and refresh tokens and saves them along with selected financial company.", "operationId": "SaveAuth", "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuthRequest" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidateFinancialKeysResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidateFinancialKeysResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateFinancialKeysResponseAPIResponse" } } } } } } }, "/api/connections/complete": { "post": { "tags": [ "Connection" ], "summary": "Validates incoming code and creates API Credential.", "description": "Accessible By: API Key.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Validates incoming code and creates API Credential.", "operationId": "CompleteConnection", "requestBody": { "description": "code", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CompleteConnectionRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CompleteConnectionRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CompleteConnectionRequest" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompleteConnectionResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompleteConnectionResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompleteConnectionResponseAPIResponse" } } } } } } }, "/api/connections/initiate": { "post": { "tags": [ "Connection" ], "summary": "Initiate Connection", "description": "
\r\n Initiate connection with systems like QBO/XERO/MYOB without having to login as company manager.\r\n \r\n
\r\n Accessible By: API Key.\\\r\n Accessed From: User Mgmt UI.\\\r\n Description: Initiate connection with systems like QBO/XERO/MYOB without having to login as company manager.\r\n \r\n
\r\n The company can be identified by one of the following (mutually exclusive):\r\n
  • CompanyId: The local UserManagement Company ID (existing behavior).
  • NexusOrganizationId: A Nexus Organization ID. The system will find or create\r\n a Company mapped to this organization.
  • NexusApplicationDeploymentId: A Nexus Application Deployment ID. The system will\r\n resolve the Organization from the deployment's subscription, then find or create a Company.
    • ", "operationId": "InitiateConnection", "requestBody": { "description": "Contains necessary parameters to connect with one of the systems from QBO/XERO/MYOB.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InitiateConnectionRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InitiateConnectionRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InitiateConnectionRequest" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InitiateConnectionResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InitiateConnectionResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InitiateConnectionResponseAPIResponse" } } } } } } }, "/api/connections/initiate-update": { "post": { "tags": [ "Connection" ], "summary": "Initiate Connection Update", "description": "Initiate connection update flow so that existing configuration can be changed. This method returns a URL\r\nthat the user should be redirected to in order to complete the update operation.", "operationId": "InitiateUpdateConnection", "requestBody": { "description": "Contains necessary parameters to connect with one of the systems from QBO/XERO/MYOB.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InitiateUpdateConnectionRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InitiateUpdateConnectionRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InitiateUpdateConnectionRequest" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InitiateConnectionResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InitiateConnectionResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InitiateConnectionResponseAPIResponse" } } } } } } }, "/api/connections/sessions/{sessionId}": { "get": { "tags": [ "Connection" ], "summary": "Gets the connection session parameters.", "operationId": "GetSessionParameters", "parameters": [ { "name": "sessionId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConnectionSessionModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionSessionModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConnectionSessionModelAPIResponse" } } } } } }, "patch": { "tags": [ "Connection" ], "summary": "Update Session", "description": "Updates the session with new information. The response may include additional validations\r\nindicating fields that need to be met.", "operationId": "UpdateSession", "parameters": [ { "name": "sessionId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateSessionModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateSessionModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateSessionModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConnectionSessionModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionSessionModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConnectionSessionModelAPIResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/connections/sessions/{sessionId}/challenges/{challengeId}": { "put": { "tags": [ "Connection" ], "summary": "Update challenge", "description": "Updates a challenge with information from the external system or user. This may complete the challenge.", "operationId": "UpdateChallenge", "parameters": [ { "name": "sessionId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "challengeId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "code", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateChallengeRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateChallengeRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateChallengeRequest" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConnectionSessionModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionSessionModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConnectionSessionModelAPIResponse" } } } } } } }, "/api/connections/sessions/{sessionId}/js-module": { "get": { "tags": [ "Connection" ], "summary": "Get Connection Module", "description": "This API returns a javascript module that is used to enhance the connection\r\nuser interface. This module is loaded by the user interface and is used to\r\nprovide validation and custom behaviors.", "operationId": "GetSessionModule", "parameters": [ { "name": "sessionId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/javascript": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/connections/update": { "patch": { "tags": [ "Connection" ], "summary": "Validates incoming session ID and updates the auth session system ID for the requested system.", "description": "Accessible By: Everyone can use this api because it's Anonymous.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Validates incoming session ID and updates the auth session system ID for the requested system.", "operationId": "UpdateConnectionSystem", "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateConnectionSystemRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateConnectionSystemRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateConnectionSystemRequest" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/connections/validate/{sessionId}": { "post": { "tags": [ "Connection" ], "summary": "Validates incoming session id and generates redirect url for requested system.", "description": "Accessible By: Everyone can use this API because it's Anonymous.\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Validates incoming session id and generates redirect url for requested system.", "operationId": "ValidateConnection", "parameters": [ { "name": "sessionId", "in": "path", "description": "session id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateConnectionRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateConnectionRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateConnectionRequest" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidateFinancialKeysResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidateFinancialKeysResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateFinancialKeysResponseAPIResponse" } } } } } } }, "/api/devices": { "get": { "tags": [ "Device" ], "summary": "List Devices", "description": "Gets a list of activated or pending devices for the given Product or Company.", "operationId": "ListDevices", "parameters": [ { "name": "company_id", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "product_id", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeviceModelCountResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceModelCountResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceModelCountResponse" } } } } } } }, "/api/devices/{id}": { "delete": { "tags": [ "Device" ], "summary": "Delete Device (NOT IMPLEMENTED)", "description": "Deletes a device with the given id. Not yet implemented.\r\n
    \r\nThis can only be invoked by the Application credential that owns the device, a Product Admin, or Global Admin.\r\n", "operationId": "DeleteDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/devices/{id}/authorization": { "put": { "tags": [ "Device" ], "summary": "Authorize Device Activation", "description": "Authorizes a device activation specified by the given activation code\r\nand provides additional information.", "operationId": "AuthorizeDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeviceAuthorizationModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeviceAuthorizationModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeviceAuthorizationModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeviceModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/devices/by-code/{code}": { "get": { "tags": [ "Device" ], "summary": "Get Device by Authorization Code", "description": "Retreives device information for the given authorization code. This allows\r\na device administrator to see the basic information about the device\r\nrequesting authorization before confirming it.", "operationId": "GetPendingDevice", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DeviceModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceModel" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/FinancialIntegration": { "post": { "tags": [ "FinancialIntegration" ], "summary": "Register a new API Credential for the Financial Company.", "description": "Accessible By: Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Register a new API Credential for the Financial Company.", "operationId": "RegisterFinancialIntegration", "requestBody": { "description": "This is an object which contains all required and optional fields to register the Financial API Users.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FinancialAPIUser" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FinancialAPIUser" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FinancialAPIUser" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetApiUserResponseModelAPIResponse" } } } } } } }, "/api/FinancialIntegration/{userId}": { "put": { "tags": [ "FinancialIntegration" ], "summary": "This API is used to change the status of API User by the Company Manager.", "description": "Accessible By: Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to change the status of the API User by the Company Manager. It helps to change the User status from active to inactive and vice versa.", "operationId": "UserStatusFinancialIntegration", "parameters": [ { "name": "userId", "in": "path", "description": "UserId of API User in GUID format.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } }, "application/*+json": { "schema": { "type": "boolean" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/FinancialIntegration/auth": { "post": { "tags": [ "FinancialIntegration" ], "summary": "Generate the Tokens to validate the financial product.", "description": "Accessible By: Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Generate the Tokens to validate the financial product.", "operationId": "AuthFinancialIntegration", "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FinancialAuthRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FinancialAuthRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FinancialAuthRequest" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthResponseAPIResponse" } } } } } } }, "/api/FinancialIntegration/GetECIFinancialsSystemBaseUrl": { "get": { "tags": [ "FinancialIntegration" ], "summary": "Fetched all baseUrls for ECIFinancials", "operationId": "GetECIFinancialsSystemBaseUrlFinancialIntegration", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringIListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringIListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringIListAPIResponse" } } } } } } }, "/api/FinancialIntegration/myob_companies": { "post": { "tags": [ "FinancialIntegration" ], "summary": "Get the list of MYOB Companies.", "description": "Accessible By: Everyone can use this API because it's Anonymous.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get the list of MYOB Companies.", "operationId": "MyobCompanyListFinancialIntegration", "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetMyobCompanyRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetMyobCompanyRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetMyobCompanyRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompanyMyobFileIListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMyobFileIListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyMyobFileIListAPIResponse" } } } } } } }, "/api/FinancialIntegration/update_financialcompany": { "put": { "tags": [ "FinancialIntegration" ], "summary": "This API is used to update financial company detail for MYOB.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to update financial company detail for MYOB.", "operationId": "UpdateFinancialCompanyDetailFinancialIntegration", "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateFinancialDetailRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateFinancialDetailRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateFinancialDetailRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/FinancialIntegration/users": { "get": { "tags": [ "FinancialIntegration" ], "summary": "Get a List of API Credentials.", "description": "Accessible By: Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: List API Credentials for the given Company Id and Integration Id.", "operationId": "UsersFinancialIntegration", "parameters": [ { "name": "companyId", "in": "query", "description": "Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integrationId", "in": "query", "description": "Integration Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiUserIntegrationDetailResponseApiUserListResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiUserIntegrationDetailResponseApiUserListResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiUserIntegrationDetailResponseApiUserListResponseAPIResponse" } } } } } } }, "/api/FinancialIntegration/validate": { "post": { "tags": [ "FinancialIntegration" ], "summary": "Get the Authorization URL for validating a financial product.", "description": "Accessible By: Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get the Authorization URL for validating a financial product. Used when a company manager logs in and connects to and validates the financial product.", "operationId": "ValidateFinancialIntegration", "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateFinancialKeys" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateFinancialKeys" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateFinancialKeys" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidateFinancialKeysResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidateFinancialKeysResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateFinancialKeysResponseAPIResponse" } } } } } } }, "/api/integrations": { "get": { "tags": [ "Integration" ], "summary": "List Integrations", "description": "This API is used to get integration list by productList and name filter. Results are ordered by IntegrationName\r\n
    \r\nAccessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\n\r\nDescription: This API is used to get integration list by productList and name filter.", "operationId": "IntegrationList", "parameters": [ { "name": "q", "in": "query", "description": "Filter on integration name (contains)", "schema": { "type": "string" } }, { "name": "product_ids", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "expand_systems", "in": "query", "description": "Return a list of systems for this integration", "schema": { "type": "boolean", "default": false } }, { "name": "expand_products", "in": "query", "description": "Return a list of products that are valid on each integration. This value is true if unspecified", "schema": { "type": "boolean", "default": true } }, { "name": "top", "in": "query", "description": "Use with skip to peform paging.", "schema": { "type": "integer", "format": "int32", "default": 250 } }, { "name": "skip", "in": "query", "description": "Skip rows", "schema": { "type": "integer", "format": "int32" } }, { "name": "is_published", "in": "query", "description": "Filter on the published status", "schema": { "type": "boolean" } }, { "name": "ids", "in": "query", "description": "One or more IDs to return results", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationResponseModelListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationResponseModelListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationResponseModelListAPIResponse" } } } } } }, "post": { "tags": [ "Integration" ], "summary": "This API is used to create new integration.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to create new integration.", "operationId": "Integration", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddIntegration" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddIntegration" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddIntegration" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EciIntegrationResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EciIntegrationResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EciIntegrationResponseAPIResponse" } } } } } } }, "/api/integrations/{id}": { "get": { "tags": [ "Integration" ], "summary": "Get integration details.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI, Payment Integration.\\\r\nDescription: This API is used to get integration detail by integration id.", "operationId": "IntegrationById", "parameters": [ { "name": "id", "in": "path", "description": "Integration id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationsDetailsResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsDetailsResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationsDetailsResponseModelAPIResponse" } } } } } }, "patch": { "tags": [ "Integration" ], "summary": "Update the details of integration.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to update the details of integration detail by integration id.", "operationId": "EditIntegration", "parameters": [ { "name": "id", "in": "path", "description": "Integration id to update details.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Model containing the active status property to set.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateIntegration" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateIntegration" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateIntegration" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EciIntegrationResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EciIntegrationResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EciIntegrationResponseAPIResponse" } } } } } }, "delete": { "tags": [ "Integration" ], "summary": "This API is used to delete the integration by integration id.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI. \\\r\nDescription: This API is used to delete the integration by integration id.", "operationId": "DeleteIntegration", "parameters": [ { "name": "id", "in": "path", "description": "delete only if integration id is given and exist.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/integrations/{id}/companies/count": { "get": { "tags": [ "Integration" ], "summary": "Get counts of integrations.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to get counts of integration which we are using in created companies.", "operationId": "CompanyIntegrationCount", "parameters": [ { "name": "id", "in": "path", "description": "Integration id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/integrations/{id}/systems": { "get": { "tags": [ "Integration" ], "summary": "This API is used to get the systems by integration id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to get the systems by integration id.", "operationId": "SystemByIntegrationId", "parameters": [ { "name": "id", "in": "path", "description": "Integration id to get list of system", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SystemDetailResponseModelIListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemDetailResponseModelIListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SystemDetailResponseModelIListAPIResponse" } } } } } }, "post": { "tags": [ "Integration" ], "summary": "This API is used to create the system detail.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to create the system detail.", "operationId": "AddSystemIntegration", "parameters": [ { "name": "id", "in": "path", "description": "integration id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "model to save system", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SystemRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SystemRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SystemRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SystemDetailResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemDetailResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SystemDetailResponseModelAPIResponse" } } } } } } }, "/api/integrations/{id}/systems/{systemId}": { "patch": { "tags": [ "Integration" ], "summary": "This API is used to edit the system detail.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to edit the system detail.", "operationId": "EditSystemIntegration", "parameters": [ { "name": "id", "in": "path", "description": "integration id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "systemId", "in": "path", "description": "system Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "model to save or update system", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SystemRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SystemRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SystemRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SystemDetailResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemDetailResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SystemDetailResponseModelAPIResponse" } } } } } }, "delete": { "tags": [ "Integration" ], "summary": "This API is used to delete system by system id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Check the system if it is used in any API Credential detail then we can't delete the system.", "operationId": "DeleteSystemByIdIntegration", "parameters": [ { "name": "id", "in": "path", "description": "integration id to delete", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "systemId", "in": "path", "description": "system id to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/integrations/{integrationId}/products": { "post": { "tags": [ "Integration" ], "operationId": "AddProductsIntegration", "parameters": [ { "name": "integrationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationProductRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationProductRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationProductRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EciIntegrationProductResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EciIntegrationProductResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EciIntegrationProductResponseModelAPIResponse" } } } } } } }, "/api/integrations/{integrationId}/products/{productId}": { "patch": { "tags": [ "Integration" ], "operationId": "UpdateIntgrationProductDetailIntegration", "parameters": [ { "name": "integrationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateIntegrationProductsDetail" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateIntegrationProductsDetail" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateIntegrationProductsDetail" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EciIntegrationProductResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EciIntegrationProductResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EciIntegrationProductResponseModelAPIResponse" } } } } } }, "delete": { "tags": [ "Integration" ], "operationId": "DeleteIntgrationProductsIntegration", "parameters": [ { "name": "integrationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/integrations/imported-file": { "post": { "tags": [ "Integration" ], "summary": "This API is used to import integration.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to import integration.", "operationId": "IntegrationImport", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddIntegrationRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddIntegrationRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddIntegrationRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationsDetailsResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsDetailsResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationsDetailsResponseModelAPIResponse" } } } } } } }, "/api/integrations/systems": { "get": { "tags": [ "Integration" ], "summary": "This API returns the System listing.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API returns the System listing. \r\nIt returns all the active system list.", "operationId": "SystemsIntegration", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ListCompanySystemResultIEnumerableAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ListCompanySystemResultIEnumerableAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListCompanySystemResultIEnumerableAPIResponse" } } } } } } }, "/api/integration-settings": { "post": { "tags": [ "IntegrationSetting" ], "summary": "Create new integration setting.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: API is used to create new integration setting.", "operationId": "AddIntegrationSetting", "requestBody": { "description": "Model to save integration setting detail.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationSettingsRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationSettingsRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationSettingsRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationSettingsRequestModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationSettingsRequestModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationSettingsRequestModelAPIResponse" } } } } } } }, "/api/integration-settings/{id}": { "get": { "tags": [ "IntegrationSetting" ], "summary": "This API is used to get detail of integration setting.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to get detail of integration setting.", "operationId": "GetIntegrationSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "integration setting id to get detail", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationSettingsResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationSettingsResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationSettingsResponseModelAPIResponse" } } } } } }, "put": { "tags": [ "IntegrationSetting" ], "summary": "Update integration setting details.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to update integration setting details.", "operationId": "EditIntegrationSetting", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Model to update integration setting detail.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationSettingsRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationSettingsRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationSettingsRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegrationSettingsRequestModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationSettingsRequestModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationSettingsRequestModelAPIResponse" } } } } } }, "delete": { "tags": [ "IntegrationSetting" ], "summary": "Remove integration setting using id.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to remove integration setting using id.", "operationId": "RemoveIntegrationSettingById", "parameters": [ { "name": "id", "in": "path", "description": "integration setting id to remove integration setting from database.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/integration-settings/{id}/companies/count": { "get": { "tags": [ "IntegrationSetting" ], "summary": "Get counts of integration settings.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to get counts of integration setting which we are using in created companies.", "operationId": "IntegrationSettingCompaniesCount", "parameters": [ { "name": "id", "in": "path", "description": "integration setting id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/integration-settings/{id}/products/{productId}/count": { "get": { "tags": [ "IntegrationSetting" ], "summary": "Get counts of integration settings.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to get counts of integration setting based on product id.", "operationId": "IntegrationSettingProductsCount", "parameters": [ { "name": "id", "in": "path", "description": "integration setting id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "productId", "in": "path", "description": "product id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/Nexus/companies": { "get": { "tags": [ "Nexus" ], "summary": "Get the list of Nexus Companies.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get the list of Nexus Companies.", "operationId": "ListNexusCompany", "parameters": [ { "name": "q", "in": "query", "description": "q", "schema": { "type": "string" } }, { "name": "field", "in": "query", "description": "field", "schema": { "type": "string", "default": "company-name" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NexusCompaniesResponseModelListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NexusCompaniesResponseModelListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NexusCompaniesResponseModelListAPIResponse" } } } } } }, "post": { "tags": [ "Nexus" ], "summary": "Create a Nexus Company.", "description": "Accessible By: Global Admin, Product Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Create a Nexus Company.\r\nGlobal Admin can add a Company assigned to any Product.\r\nProduct Admin may only add a Company assigned to one of the Products which they can administrate. \r\nCompany Id and Customer Id must be unique.", "operationId": "AddNexusCompany", "requestBody": { "description": "An object which contains all the required and optional fields to create a company.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NexusCompanyRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NexusCompanyRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NexusCompanyRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddNexusCompanyResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddNexusCompanyResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddNexusCompanyResponseModelAPIResponse" } } } } } } }, "/api/Nexus/companies/{id}": { "get": { "tags": [ "Nexus" ], "summary": "Get the details of a Nexus Company by Nexus Id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get the details of a Nexus Company by Nexus Id.", "operationId": "FindNexusCompany", "parameters": [ { "name": "id", "in": "path", "description": "The Company Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NexusCompanyResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NexusCompanyResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NexusCompanyResponseModelAPIResponse" } } } } } } }, "/api/Nexus/company-alias-match": { "get": { "tags": [ "Nexus" ], "summary": "Get the list of Nexus Companies matching a given alias value.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get the list of Nexus Companies matching a given alias value.", "operationId": "ListNexusAliasCompany", "parameters": [ { "name": "alias", "in": "query", "description": "alias", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NexusAliasCompaniesResponseModelIReadOnlyListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NexusAliasCompaniesResponseModelIReadOnlyListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NexusAliasCompaniesResponseModelIReadOnlyListAPIResponse" } } } } } } }, "/api/otel/logs": { "post": { "tags": [ "OtelLogs" ], "summary": "Ingests logs in OTLP HTTP/JSON format", "description": "Accessible By: Internal services with API Key authentication.\r\nAccessed From: Lambda functions, internal services.\r\nDescription: Accepts logs in OTLP format (OpenTelemetry Protocol) and stores them in the logging database.\r\n\r\nFollows the OTLP specification: https://opentelemetry.io/docs/specs/otlp/", "operationId": "IngestLogsOtelLogs", "requestBody": { "description": "OTLP log export request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OtelLogRequest" } ], "description": "OTLP Log Export Request (HTTP JSON format)\r\nSpec: https://opentelemetry.io/docs/specs/otlp/#otlphttp-request" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InsertOtelLogsResultAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InsertOtelLogsResultAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InsertOtelLogsResultAPIResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } }, "500": { "description": "Server Error" } } } }, "/api/products": { "get": { "tags": [ "Product" ], "summary": "This API is used to get Eci Products listings.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to get Eci product listings. \r\nGlobal admin will get all the Eci Product list. \r\n Product admin only gets the list of Eci products that they have.", "operationId": "Products", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EciProductListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EciProductListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EciProductListAPIResponse" } } } } } } }, "/api/products/{productId}": { "get": { "tags": [ "Product" ], "summary": "This API is used to get the integrations, systems and master keys.", "description": "Accessible By: Global Admin, Product Admin, Product Support Users, Company Managers.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to get the integrations, systems and master keys.\r\nFor Creating a company we need integrations and their master keys by selection of product.", "operationId": "Product", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EciProductsResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EciProductsResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EciProductsResponseModelAPIResponse" } } } } } } }, "/api/products/sync": { "post": { "tags": [ "Product" ], "summary": "Triggers an on-demand sync of products from Nexus into the EciProducts table.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: Admin tooling.\\\r\nDescription: Syncs active products from Nexus into the local EciProducts table.\r\nNew products are inserted and existing ones updated if the display name changed.", "operationId": "SyncProducts", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SyncProductsResultAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SyncProductsResultAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncProductsResultAPIResponse" } } } } } } }, "/api/reports": { "get": { "tags": [ "Report" ], "summary": "Used to get Report list.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Used to get Report list. \r\nUsed to get report list with optional filter: Name, IntegrationId, and IsActive. Product Admin, \r\nProduct Support User and Company Manager get those report lists that have their associated roles in the report.", "operationId": "GetReportByOptionalFilters", "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "integration_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "is_active", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReportListResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportListResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportListResponseModelAPIResponse" } } } } } }, "post": { "tags": [ "Report" ], "summary": "Used to add report and their associated role to Report and ReportRole table.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Used to add report and their associated role to Report and ReportRole table.", "operationId": "SaveReport", "requestBody": { "description": "This is an object which contains some required and optional field to add report.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReportRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReportRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReportRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddUpdateReportResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddUpdateReportResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddUpdateReportResponseModelAPIResponse" } } } } } } }, "/api/reports/{id}": { "get": { "tags": [ "Report" ], "summary": "Used to get report detail by report id.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Used to get report detail by report id.", "operationId": "GetReportById", "parameters": [ { "name": "id", "in": "path", "description": "report id to get detail data of that particular report.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReportResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportResponseModelAPIResponse" } } } } } }, "patch": { "tags": [ "Report" ], "summary": "Used to update the status of the report.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Used to update the status of the report.", "operationId": "UpdateReportActiveStatus", "parameters": [ { "name": "id", "in": "path", "description": "Report id for update the status and it is required field.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "isActive", "in": "query", "description": "boolean value for Isactive field, bydefault is set to true.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } }, "delete": { "tags": [ "Report" ], "summary": "Used to delete the report by report id.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Used to delete the report by report id.", "operationId": "DeleteReportById", "parameters": [ { "name": "id", "in": "path", "description": "Report id for delete and it is required field.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/reports/{id}/parameters": { "get": { "tags": [ "Report" ], "summary": "Used to get report parameter list by report id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Used to get report parameter list by report id.", "operationId": "GetParameterListByReportId", "parameters": [ { "name": "id", "in": "path", "description": "Report id to get list of ReportParameter of that particular report.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReportParameterListResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportParameterListResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportParameterListResponseModelAPIResponse" } } } } } }, "post": { "tags": [ "Report" ], "summary": "Used to save the report parameter.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Used to save the report parameter.", "operationId": "SaveReportParameter", "parameters": [ { "name": "id", "in": "path", "description": "Report id to add report parameter for that particular report.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "This is an object which contains some required and optional field to add report parameter.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReportParameterRequestModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReportParameterRequestModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReportParameterRequestModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddReportParametersResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddReportParametersResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddReportParametersResponseModelAPIResponse" } } } } } } }, "/api/reports/{id}/parameters/{parameterId}": { "get": { "tags": [ "Report" ], "summary": "Used to get report parameter detail.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Used to get report parameter detail.", "operationId": "GetReportParameterById", "parameters": [ { "name": "id", "in": "path", "description": "Report id to get detail data of that particular report parameter.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parameterId", "in": "path", "description": "Report parameter id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReportParameterResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportParameterResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportParameterResponseModelAPIResponse" } } } } } }, "delete": { "tags": [ "Report" ], "summary": "Used to delete the report parameter.", "description": "Accessible By: Global Admin.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Used to delete the report parameter.", "operationId": "DeleteReportParameterById", "parameters": [ { "name": "id", "in": "path", "description": "Report id of that report parameter for delete and it is required field.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parameterId", "in": "path", "description": "Reportparameter id for delete and it is required field.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/Roles": { "get": { "tags": [ "Roles" ], "summary": "This API is used to get the user role list.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to get the user role list.", "operationId": "Roles", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RoleIEnumerableAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RoleIEnumerableAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RoleIEnumerableAPIResponse" } } } } } } }, "/api/exceptions": { "get": { "tags": [ "System" ], "summary": "This API is used to show 500 exception to show error banner on Dev Environment.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to show 500 exception to show error banner on Dev Environment.", "operationId": "GetExceptionSystem", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/System/me": { "get": { "tags": [ "System" ], "summary": "Get current user or application profile information.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager, API Keys.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Returns profile information for the currently authenticated user or application (API key).\r\nFor users, returns user details from Users table. For API keys, returns application details from Applications table.\r\nCompany object is null for global admins, product admins, and product support users.\r\nProducts array contains all active products for global admins, assigned products for product admins/support,\r\nand the company's product for company managers.", "operationId": "MeSystem", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SystemMeResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemMeResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SystemMeResponseAPIResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/System/SystemInfo": { "get": { "tags": [ "System" ], "summary": "This API is used to get the information of system.", "description": "Description: It doesn't used bearer token for authentication.", "operationId": "SystemInfo", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/api/System/UserInfo": { "get": { "tags": [ "System" ], "summary": "This API is used to get the details of user which is logged in.", "description": "Accessed From: Payment Integration.\\\r\nDescription: Using Bearer token it return the details like Name, UserId, Role, Email of the Authenticate user.", "operationId": "UserInfoSystem", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/api/audit-logs": { "get": { "tags": [ "Telemetry" ], "summary": "This API is used to fetch history of all changes made to a company, so that I can determine who and when a change was made.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to fetch history of all changes made to a company, so that I can determine who and when a change was made.", "operationId": "GetAuditLogTelemetry", "parameters": [ { "name": "product_id", "in": "query", "description": "Set the product id to define the particular product", "schema": { "type": "integer", "format": "int32" } }, { "name": "company_id", "in": "query", "description": "Set the company id to define the particular company", "schema": { "type": "integer", "format": "int32" } }, { "name": "duration", "in": "query", "description": "Set duration in minutes to perform search", "schema": { "type": "integer", "format": "int32" } }, { "name": "start_date", "in": "query", "description": "Set UTC start_date in format like {YYYY-MM-DDTHH:MM:SS}", "schema": { "type": "string", "format": "date-time" } }, { "name": "end_date", "in": "query", "description": "Set UTC end_date in format like {YYYY-MM-DDTHH:MM:SS}", "schema": { "type": "string", "format": "date-time" } }, { "name": "take", "in": "query", "description": "Set number of records to fetch from database at a time. Default value is 100", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 100 } }, { "name": "skip", "in": "query", "description": "Set number of records to skip which should not come from database", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuditLogResponseIListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuditLogResponseIListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuditLogResponseIListAPIResponse" } } } } } } }, "/api/telemetry/api-requests": { "get": { "tags": [ "Telemetry" ], "summary": "Gets a list of API requests that have been indexed from various integrations.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Gets a list of API requests that have been indexed from various integrations.", "operationId": "GetApiRequestsTelemetry", "parameters": [ { "name": "from", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "take", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "skip", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "trace_id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "max_duration", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "min_duration", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "min_status_code", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "max_status_code", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "company_id", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "principal_id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "user_name", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "success", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "product_name", "in": "query", "description": "", "schema": { "allOf": [ { "$ref": "#/components/schemas/ProductEnum" } ] } }, { "name": "request_path", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "method", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "request_id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "apigw_requestid", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "system_id", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "client_id", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "source_address", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "integration_id", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_name", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiRequestLogCountResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiRequestLogCountResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiRequestLogCountResponse" } } } } } } }, "/api/telemetry/report/{id}": { "get": { "tags": [ "Telemetry" ], "summary": "Gets a list of logs or UM DB data based on selected query type like DSL, SQL.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Gets a list of logs or UM DB data based on selected query type like DSL, SQL.", "operationId": "GetCustomLogReportTelemetry", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "take", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "skip", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "startDate", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "", "schema": { "type": "string", "format": "date-time" } }, { "name": "parameters", "in": "query", "description": "", "schema": { "type": "object", "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomReportLogViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportLogViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomReportLogViewModel" } } } } } } }, "/api/telemetry/traces": { "get": { "tags": [ "Telemetry" ], "summary": "This API is used to get API Logs for admin level.", "description": "Accessible by: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: This API is used to get API Logs for admin level.", "operationId": "ApiLogsTelemetry", "parameters": [ { "name": "logType", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "integrationId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "duration", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "Set UTC startDate in format like {YYYY-MM-DDTHH:MM:SS}", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "Set UTC endDate in format like {YYYY-MM-DDTHH:MM:SS}", "schema": { "type": "string", "format": "date-time" } }, { "name": "is_error", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "methodType", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "productName", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "secDuration", "in": "query", "description": "", "schema": { "type": "string", "default": "" } }, { "name": "system", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "traceId", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "integrationName", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TraceMessageResponseListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TraceMessageResponseListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TraceMessageResponseListAPIResponse" } } } } } } }, "/api/User": { "post": { "tags": [ "User" ], "summary": "Create a new User.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Create a new User.\r\nCan be used to create Admin or Company Managers.\r\nAfter successful registration, the user will receive a verification mail to confirm their email only when we create user for local provider.\\\r\nGlobal Admin may create any kind of User.\r\nProduct Admin may create Product Admin or Product Support Users for their assigned products\r\nor Company Managers for companies associated with one of their assigned products.\\\r\nProduct Support Users may create Company Managers for companies associated with one of their assigned products.\r\nCompany Id is required if creating a Company Manager.\r\nProduct Ids are required if creating a Product Admin or Product Support User.", "operationId": "RegisterUser", "requestBody": { "description": "An object containing all properties with which to create the new User.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RegisterUser" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RegisterUser" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RegisterUser" } ] } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/User/{email}/login-provider": { "get": { "tags": [ "User" ], "operationId": "GetLoginProviderUser", "parameters": [ { "name": "email", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoginProviderResponseAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoginProviderResponseAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginProviderResponseAPIResponse" } } } } } } }, "/api/User/{id}": { "get": { "tags": [ "User" ], "summary": "Get User details by Id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get User details by Id.", "operationId": "GetUserById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ERPUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ERPUserResponseModelAPIResponse" } } } } } }, "patch": { "tags": [ "User" ], "summary": "Updates the Active status, First name, Last name and Product list of the specified User.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Updates the Active status, First name, Last name and Product list of the specified User.", "operationId": "AdminUpdateUser", "parameters": [ { "name": "id", "in": "path", "description": "Username/email of the user whose detail needs to be updated.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "This is an object which contains details of actioned user's firstname ,lastname , status and thier role and their products.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateAdmins" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateAdmins" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateAdmins" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ERPUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ERPUserResponseModelAPIResponse" } } } } } }, "delete": { "tags": [ "User" ], "summary": "Delete a User by Id.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Delete a User by Id.\r\nDelete the User from the database and identity store.", "operationId": "DeleteUser", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the user to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" } } } } } } }, "/api/User/me": { "get": { "tags": [ "User" ], "summary": "Gets id, name, and role of logged in user.", "description": "Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Gets id, name, and role of logged in user.", "operationId": "MeUser", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserMeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserMeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMeResponse" } } } } } }, "patch": { "tags": [ "User" ], "summary": "Updates First name and/or Last name of the logged in user in both database and cognito.", "description": "Accessible By: Global Admin, Product Admin, Product Support Users, Company Managers.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Updates First name and/or Last name of the logged in user in both database and cognito.", "operationId": "MeUser", "requestBody": { "description": "This is an object which contains details of logged in user to update the first or last name.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateUserProfile" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateUserProfile" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateUserProfile" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileAPIResponse" } } } } } } }, "/api/User/providers": { "get": { "tags": [ "User" ], "summary": "Gets the list of authentication providers available for admin users.", "description": "Accessible By: Everyone can use this API because it's Anonymous.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Gets the list of authentication providers available for admin users.", "operationId": "GetSsoProvidersUser", "parameters": [ { "name": "client_id", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProvider" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProvider" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProvider" } } } } } } } }, "/api/User/providers/{name}": { "get": { "tags": [ "User" ], "summary": "Gets an authentication provider by name.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Gets an authentication provider by name.", "operationId": "GetSsoProviderUser", "parameters": [ { "name": "name", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SsoProvider" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SsoProvider" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SsoProvider" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/User/RegisterUserFromCognito": { "post": { "tags": [ "User" ], "summary": "Create a new User.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Create a new User.\r\nCan be used to create Admin or Company Managers.\r\nAfter successful registration, the user will receive a verification mail to confirm their email.\\\r\nGlobal Admin may create any kind of User.\r\nProduct Admin may create Product Admin or Product Support Users for their assigned products\r\nor Company Managers for companies associated with one of their assigned products.\r\nProduct Support Users may create Company Managers for companies associated with one of their assigned products.\\\r\nCompany Id is required if creating a Company Manager.\r\nProduct Ids are required if creating a Product Admin or Product Support User.", "operationId": "RegisterUserFromCognito", "requestBody": { "description": "An object containing all properties with which to create the new User.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RegisterUser" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RegisterUser" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RegisterUser" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ERPUserResponseModelAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPUserResponseModelAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ERPUserResponseModelAPIResponse" } } } } } } }, "/api/users": { "get": { "tags": [ "User" ], "summary": "Get the list of Users matching the specified filter criteria.", "description": "Accessible By: Global Admin, Product Admin, Product Support User.\\\r\nAccessed From: User Mgmt UI.\\\r\nDescription: Get the list of Users matching the specified filter criteria.", "operationId": "ListUsers", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "provider_name", "in": "query", "schema": { "type": "string" } }, { "name": "role_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "company_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "is_active", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ERPUserResponseModelIListAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ERPUserResponseModelIListAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ERPUserResponseModelIListAPIResponse" } } } } } } } }, "components": { "schemas": { "ActivationCodeRequestModel": { "required": [ "activationCode" ], "type": "object", "properties": { "integrationId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "activationCode": { "maxLength": 64, "minLength": 24, "type": "string" } }, "additionalProperties": false }, "ActivationCodeResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "string", "nullable": true }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string", "nullable": true }, "integrationId": { "type": "integer", "format": "int32" }, "integrationName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "isUsed": { "type": "boolean" }, "usedDateTime": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ActivationCodeResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ActivationCodeResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "ActivationCodeResponseModelIListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/ActivationCodeResponseModel" }, "nullable": true } }, "additionalProperties": false }, "AddCompany": { "required": [ "productId" ], "type": "object", "properties": { "companyId": { "type": "integer", "format": "int32" }, "companyName": { "maxLength": 150, "minLength": 0, "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "productId": { "type": "integer", "format": "int32" }, "nexusOrganizationId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AddCompanyIntegrationModel": { "required": [ "integrationId" ], "type": "object", "properties": { "integrationId": { "type": "integer", "format": "int32" }, "isHosted": { "type": "boolean" }, "erpProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ErpProperties" }, "nullable": true } }, "additionalProperties": false }, "AddIntegration": { "required": [ "allowHostedConfigurations", "integrationName" ], "type": "object", "properties": { "integrationName": { "maxLength": 50, "minLength": 1, "type": "string" }, "allowHostedConfigurations": { "type": "boolean" }, "allowOnPremisesConfigurations": { "type": "boolean" }, "enableCompanyManagerDashboard": { "type": "boolean" }, "introductionText": { "type": "string", "nullable": true }, "testConnectionUrl": { "type": "string", "nullable": true }, "isPublished": { "type": "boolean" }, "ipRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "ipRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true }, "companyRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "companyRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true }, "userRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "userRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AddIntegrationRequestModel": { "required": [ "allowHostedConfigurations", "integrationName", "integrationProductRequestModel" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "integrationName": { "maxLength": 50, "minLength": 1, "type": "string" }, "allowHostedConfigurations": { "type": "boolean" }, "allowOnPremisesConfigurations": { "type": "boolean" }, "enableCompanyManagerDashboard": { "type": "boolean" }, "introductionText": { "type": "string", "nullable": true }, "testConnectionUrl": { "type": "string", "nullable": true }, "integrationProductRequestModel": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationProductRequestModel" } }, "isPublished": { "type": "boolean" }, "ipRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "ipRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true }, "companyRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "companyRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true }, "userRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "userRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true }, "masterKeys": { "type": "array", "items": { "$ref": "#/components/schemas/MasterKeysImportRequestModel" }, "nullable": true }, "systems": { "type": "array", "items": { "$ref": "#/components/schemas/SystemImportRequestModel" }, "nullable": true } }, "additionalProperties": false }, "AddNexusCompanyResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "companyName": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "nexusId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AddNexusCompanyResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/AddNexusCompanyResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "AddReportParametersResponseModel": { "type": "object", "properties": { "reportParameterId": { "type": "integer", "format": "int32" }, "reportId": { "type": "integer", "format": "int32" }, "parameterName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true }, "dropdownType": { "type": "integer", "format": "int32", "nullable": true }, "validationPattern": { "type": "string", "nullable": true }, "validationPatternMessage": { "type": "string", "nullable": true }, "dropdownValues": { "type": "string", "nullable": true }, "isRequired": { "type": "boolean" } }, "additionalProperties": false }, "AddReportParametersResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/AddReportParametersResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "AddUpdateCompanyResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "companyName": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "productId": { "type": "integer", "format": "int32" }, "maxCompanyManagers": { "type": "integer", "format": "int32" }, "nexusOrganizationId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AddUpdateCompanyResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/AddUpdateCompanyResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "AddUpdateReportResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string", "nullable": true }, "sourceName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "useDateRange": { "type": "boolean" } }, "additionalProperties": false }, "AddUpdateReportResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/AddUpdateReportResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "AnalyticsCredentialBreakdownResponse": { "type": "object", "properties": { "clientId": { "type": "string", "description": "Gets or sets the credential client ID.", "nullable": true }, "userName": { "type": "string", "description": "Gets or sets the display name of the credential owner. Empty when the user is not found.", "nullable": true }, "totalApiCalls": { "type": "integer", "description": "Gets or sets the total API calls for this credential.", "format": "int64" }, "averageCallsPerDay": { "type": "number", "description": "Gets or sets the average number of API calls per day for this credential.", "format": "double" } }, "additionalProperties": false, "description": "Represents one row in the credential breakdown table.\r\nOnly used when an integrationId filter is applied and the company has more than one credential." }, "AnalyticsCredentialUsageResponse": { "type": "object", "properties": { "clientId": { "type": "string", "description": "Gets or sets the credential client ID.", "nullable": true }, "userName": { "type": "string", "description": "Gets or sets the display name of the credential owner. Empty when the user is not found.", "nullable": true }, "apiCallsCount": { "type": "integer", "description": "Gets or sets the total API calls for this credential in the selected period.", "format": "int64" } }, "additionalProperties": false, "description": "Represents a single bar in the credential usage chart.\r\nOnly used when an integrationId filter is applied and the company has more than one credential." }, "AnalyticsDailyUsageResponse": { "type": "object", "properties": { "date": { "type": "string", "description": "Gets or sets the date for this chart point.", "format": "date-time" }, "apiCallsCount": { "type": "integer", "description": "Gets or sets the number of API calls on this date.", "format": "int64" } }, "additionalProperties": false, "description": "Represents a single daily point in the API calls time series." }, "AnalyticsIntegrationBreakdownResponse": { "type": "object", "properties": { "integrationName": { "type": "string", "description": "Gets or sets the integration name.", "nullable": true }, "totalApiCalls": { "type": "integer", "description": "Gets or sets the total API calls for this integration.", "format": "int64" }, "activeApiKeys": { "type": "integer", "description": "Gets or sets the number of active API keys associated with this integration.", "format": "int32" }, "averageApiCallsPerKey": { "type": "number", "description": "Gets or sets the average number of API calls per key for this integration.", "format": "double" } }, "additionalProperties": false, "description": "Represents one row in the integration breakdown table." }, "AnalyticsIntegrationUsageResponse": { "type": "object", "properties": { "integrationName": { "type": "string", "description": "Gets or sets the integration name.", "nullable": true }, "apiCallsCount": { "type": "integer", "description": "Gets or sets the total API calls for this integration in the selected period.", "format": "int64" } }, "additionalProperties": false, "description": "Represents a single bar in the integrationq usage chart." }, "AnalyticsProductBreakdownResponse": { "type": "object", "properties": { "productName": { "type": "string", "description": "Gets or sets the product name.", "nullable": true }, "totalApiCalls": { "type": "integer", "description": "Gets or sets the total API calls for this product.", "format": "int64" }, "averageCallsPerDay": { "type": "number", "description": "Gets or sets the average number of API calls per day for this product.", "format": "double" } }, "additionalProperties": false, "description": "Represents one row in the product breakdown table.\r\nOnly used when an integrationId filter is applied." }, "AnalyticsProductUsageResponse": { "type": "object", "properties": { "productName": { "type": "string", "description": "Gets or sets the product name.", "nullable": true }, "apiCallsCount": { "type": "integer", "description": "Gets or sets the total API calls for this product in the selected period.", "format": "int64" } }, "additionalProperties": false, "description": "Represents a single bar in the product usage chart.\r\nOnly used when an integrationId filter is applied." }, "AnalyticsResponse": { "type": "object", "properties": { "companyId": { "type": "integer", "description": "Gets or sets the company filter used to generate this analytics response.", "format": "int32", "nullable": true }, "integrationId": { "type": "integer", "description": "Gets or sets the integration filter used to generate this analytics response.", "format": "int32", "nullable": true }, "systemId": { "type": "integer", "description": "Gets or sets the system filter used to generate this analytics response.", "format": "int32", "nullable": true }, "productName": { "type": "string", "description": "Gets or sets the product filter used to generate this analytics response.", "nullable": true }, "periodDays": { "type": "integer", "description": "Gets or sets the period represented by this response in days.", "format": "int32" }, "summary": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsSummaryResponse" } ], "description": "Gets or sets the summary cards data shown at the top of the dashboard.", "nullable": true }, "dailyUsage": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsDailyUsageResponse" }, "description": "Gets or sets the daily API calls used by the \"Overall API Calls\" chart.", "nullable": true }, "integrationUsage": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsIntegrationUsageResponse" }, "description": "Gets or sets the aggregated requests by integration for the integration usage chart.", "nullable": true }, "integrationBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsIntegrationBreakdownResponse" }, "description": "Gets or sets the integration breakdown table data.", "nullable": true }, "systemUsage": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsSystemUsageResponse" }, "description": "Only populated when an integrationId filter is applied.", "nullable": true }, "systemBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsSystemBreakdownResponse" }, "description": "Only populated when an integrationId filter is applied.", "nullable": true }, "productUsage": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsProductUsageResponse" }, "description": "Only populated when an integrationId filter is applied.", "nullable": true }, "productBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsProductBreakdownResponse" }, "description": "Only populated when an integrationId filter is applied.", "nullable": true }, "credentialUsage": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsCredentialUsageResponse" }, "description": "Only populated when an integrationId filter is applied and the company has more than one credential for the integration.", "nullable": true }, "credentialBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsCredentialBreakdownResponse" }, "description": "Only populated when an integrationId filter is applied and the company has more than one credential for the integration.", "nullable": true } }, "additionalProperties": false, "description": "Represents analytics data required by the usage dashboard." }, "AnalyticsSummaryResponse": { "type": "object", "properties": { "totalApiCalls": { "type": "integer", "description": "Gets or sets the total number of API calls for the selected period.", "format": "int64" }, "averageCallsPerDay": { "type": "number", "description": "Gets or sets the average number of API calls per day.", "format": "double" }, "activeKeys": { "type": "integer", "description": "Gets or sets the number of currently active API keys.", "format": "int32" }, "totalKeys": { "type": "integer", "description": "Gets or sets the total number of API keys.", "format": "int32" }, "productsCount": { "type": "integer", "description": "Gets or sets the number of products represented in analytics.", "format": "int32" }, "integrationsCount": { "type": "integer", "description": "Gets or sets the number of integrations represented in analytics.", "format": "int32" } }, "additionalProperties": false, "description": "Represents KPI values for the analytics summary cards." }, "AnalyticsSystemBreakdownResponse": { "type": "object", "properties": { "systemId": { "type": "integer", "description": "Gets or sets the system ID.", "format": "int32", "nullable": true }, "systemName": { "type": "string", "description": "Gets or sets the system name.", "nullable": true }, "totalApiCalls": { "type": "integer", "description": "Gets or sets the total API calls for this system.", "format": "int64" }, "averageCallsPerDay": { "type": "number", "description": "Gets or sets the average number of API calls per day for this system.", "format": "double" } }, "additionalProperties": false, "description": "Represents one row in the system breakdown table." }, "AnalyticsSystemUsageResponse": { "type": "object", "properties": { "systemId": { "type": "integer", "description": "Gets or sets the system ID.", "format": "int32", "nullable": true }, "systemName": { "type": "string", "description": "Gets or sets the system name.", "nullable": true }, "apiCallsCount": { "type": "integer", "description": "Gets or sets the total API calls for this system in the selected period.", "format": "int64" } }, "additionalProperties": false, "description": "Represents a single bar in the system usage chart." }, "AnyValue": { "type": "object", "properties": { "stringValue": { "type": "string", "nullable": true }, "boolValue": { "type": "boolean", "nullable": true }, "intValue": { "type": "integer", "format": "int64", "nullable": true }, "doubleValue": { "type": "number", "format": "double", "nullable": true }, "arrayValue": { "allOf": [ { "$ref": "#/components/schemas/ArrayValue" } ], "description": "Array of AnyValue", "nullable": true }, "kvlistValue": { "allOf": [ { "$ref": "#/components/schemas/KeyValueList" } ], "description": "List of key-value pairs", "nullable": true }, "bytesValue": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "AnyValue - can hold different types\r\nSpec: https://opentelemetry.io/docs/specs/otel/logs/data-model/#type-any" }, "ApiCredentialUserType": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "ApiError": { "type": "object", "properties": { "isError": { "type": "boolean" }, "exceptionMessage": { "type": "string", "nullable": true }, "details": { "type": "string", "nullable": true }, "referenceErrorCode": { "type": "string", "nullable": true }, "referenceDocumentLink": { "type": "string", "nullable": true }, "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" }, "nullable": true } }, "additionalProperties": false }, "ApiIntegrationApiUserProperty": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "keyValue": { "type": "string", "nullable": true }, "keyId": { "type": "integer", "format": "int32" }, "isRequired": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "isSecret": { "type": "boolean" }, "displayOrdinal": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ApiRequestLog": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "application": { "type": "string", "nullable": true }, "applicationVersion": { "type": "string", "nullable": true }, "messageText": { "type": "string", "nullable": true }, "principalId": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "clientId": { "type": "string", "nullable": true }, "sourceAddress": { "type": "string", "nullable": true }, "requestMethod": { "type": "string", "nullable": true }, "requestScheme": { "type": "string", "nullable": true }, "requestHost": { "type": "string", "nullable": true }, "requestPath": { "type": "string", "nullable": true }, "requestQuery": { "type": "string", "nullable": true }, "requestHeaders": { "type": "string", "nullable": true }, "requestContentType": { "type": "string", "nullable": true }, "duration": { "type": "number", "description": "Time elapsed for this API call, in milliseconds", "format": "double", "nullable": true }, "responseStatus": { "type": "integer", "format": "int32" }, "responseRequestId": { "type": "string", "nullable": true }, "responseHeaders": { "type": "string", "nullable": true }, "responseContentType": { "type": "string", "nullable": true }, "exceptionType": { "type": "string", "nullable": true }, "requestId": { "type": "string", "nullable": true }, "traceId": { "type": "string", "nullable": true }, "spanId": { "type": "string", "nullable": true }, "xrayTraceId": { "type": "string", "nullable": true }, "apiGwRequestId": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "system": { "type": "string", "nullable": true }, "systemId": { "type": "integer", "format": "int32" }, "companyId": { "type": "integer", "format": "int32" }, "companyName": { "type": "string", "nullable": true }, "integrationId": { "type": "integer", "format": "int32" }, "integrationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApiRequestLogCountResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/ApiRequestLog" }, "nullable": true } }, "additionalProperties": false }, "ApiUserIntegrationDetailResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "isEmailConfirmed": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "lastActivityDateTime": { "type": "string", "format": "date-time", "nullable": true }, "enablePasswordReset": { "type": "boolean" }, "accountStatus": { "type": "string", "nullable": true }, "accountVerifiedStatus": { "type": "string", "nullable": true }, "enableResendVerification": { "type": "boolean" }, "enableConfirmUser": { "type": "boolean" }, "userType": { "type": "integer", "description": "Credential type: 1 = Person, 2 = System, 3 = GroupProfile, 4 = NexusUser.", "format": "int32" }, "expireType": { "type": "integer", "format": "int32" }, "expireDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "environment": { "type": "string", "nullable": true }, "integrationIsActive": { "type": "boolean" }, "companyIsActive": { "type": "boolean" }, "financialCompany": { "type": "string", "nullable": true }, "financialCompanyId": { "type": "integer", "format": "int32", "nullable": true }, "systemName": { "type": "string", "nullable": true }, "integrationId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "integrationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApiUserIntegrationDetailResponseApiUserListResponse": { "type": "object", "properties": { "apiUserList": { "type": "array", "items": { "$ref": "#/components/schemas/ApiUserIntegrationDetailResponse" }, "nullable": true } }, "additionalProperties": false }, "ApiUserIntegrationDetailResponseApiUserListResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ApiUserIntegrationDetailResponseApiUserListResponse" } ], "nullable": true } }, "additionalProperties": false }, "ApiUserResponseModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "companyId": { "type": "integer", "format": "int32" }, "companyNexusId": { "type": "string", "nullable": true }, "financialCompanyId": { "type": "integer", "format": "int32", "nullable": true }, "financialCompanyName": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "companyCustomerId": { "type": "string", "nullable": true }, "eciProductName": { "type": "string", "nullable": true }, "productId": { "type": "integer", "format": "int32" }, "eciIntegrationId": { "type": "integer", "format": "int32" }, "eciIntegrationName": { "type": "string", "nullable": true }, "isEmailVerified": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "systemId": { "type": "integer", "format": "int32" }, "systemName": { "type": "string", "nullable": true }, "accountVerifiedStatus": { "type": "string", "nullable": true }, "enablePasswordReset": { "type": "boolean" }, "accountStatus": { "type": "string", "nullable": true }, "enableResendVerification": { "type": "boolean" }, "enableConfirmUser": { "type": "boolean" }, "userType": { "type": "integer", "format": "int32" }, "expireType": { "type": "integer", "format": "int32", "nullable": true }, "expireDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "integrationIsActive": { "type": "boolean" }, "integrationIsHosted": { "type": "boolean" }, "companyIsActive": { "type": "boolean" }, "rateLimits": { "allOf": [ { "$ref": "#/components/schemas/RateLimits" } ], "nullable": true }, "apiIntegrationApiUserProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ApiIntegrationApiUserProperty" }, "nullable": true }, "integrationProperties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "financialIntegrationApiUserProperties": { "allOf": [ { "$ref": "#/components/schemas/FinancialIntegrationApiUserProperties" } ], "nullable": true }, "accessToken": { "type": "string", "nullable": true }, "accessTokenExpiresAtUtc": { "type": "integer", "format": "int64", "nullable": true }, "refreshToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApiUserResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ApiUserResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "ApplicationDataModel": { "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "roleName": { "type": "string", "nullable": true }, "integrationId": { "type": "integer", "format": "int32" }, "integrationName": { "type": "string", "nullable": true }, "redirectUris": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "lastUsedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ApplicationRequestModel": { "required": [ "description", "roleId" ], "type": "object", "properties": { "description": { "minLength": 1, "type": "string" }, "roleId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32", "nullable": true }, "companyId": { "type": "integer", "format": "int32", "nullable": true }, "integrationId": { "type": "integer", "format": "int32", "nullable": true }, "redirectUris": { "type": "string", "description": "A list of possible redirect URIs for authentication flows. \r\nMultiple values should be separated with line feeds (\\n).", "nullable": true }, "isActive": { "type": "boolean" }, "displayName": { "type": "string", "description": "Display name for the partner shown during connection flow.\r\nOnly applicable when RoleId = Partner (6).", "nullable": true }, "logoUrl": { "type": "string", "description": "URL to the partner's logo for branding purposes.\r\nOnly applicable when RoleId = Partner (6).", "nullable": true }, "terms": { "type": "string", "description": "Terms and conditions text (supports HTML) shown during authorization.\r\nOnly applicable when RoleId = Partner (6).", "nullable": true } }, "additionalProperties": false }, "ApplicationResponse": { "type": "object", "properties": { "clientId": { "type": "string", "format": "uuid" }, "description": { "type": "string", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32", "nullable": true }, "companyId": { "type": "integer", "format": "int32", "nullable": true }, "integrationId": { "type": "integer", "format": "int32", "nullable": true }, "redirectUris": { "type": "string", "description": "A list of possible redirect URIs for authentication flows. \r\nMultiple values should be separated with line feeds (\\n).", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "modifiedDate": { "type": "string", "format": "date-time", "nullable": true }, "lastUsedDate": { "type": "string", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "modifiedBy": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "roleName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "description": "Display name for the partner shown during connection flow.\r\nOnly applicable when RoleId = Partner (6).", "nullable": true }, "logoUrl": { "type": "string", "description": "URL to the partner's logo for branding purposes.\r\nOnly applicable when RoleId = Partner (6).", "nullable": true }, "terms": { "type": "string", "description": "Terms and conditions text (supports HTML) shown during authorization.\r\nOnly applicable when RoleId = Partner (6).", "nullable": true } }, "additionalProperties": false }, "ApplicationResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ApplicationResponse" } ], "nullable": true } }, "additionalProperties": false }, "ApplicationResponseIListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationResponse" }, "nullable": true } }, "additionalProperties": false }, "ApplicationResult": { "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "roleName": { "type": "string", "nullable": true }, "integrationId": { "type": "integer", "format": "int32" }, "integrationName": { "type": "string", "nullable": true }, "redirectUris": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "lastUsedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ApplicationResultIListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationResult" }, "nullable": true } }, "additionalProperties": false }, "ApplicationSecretValueResponse": { "type": "object", "properties": { "clientSecret": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApplicationSecretValueResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ApplicationSecretValueResponse" } ], "nullable": true } }, "additionalProperties": false }, "ArrayValue": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/AnyValue" }, "nullable": true } }, "additionalProperties": false, "description": "Array of AnyValue" }, "AuditLogResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userType": { "type": "string", "nullable": true }, "userId": { "type": "string", "format": "uuid", "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "traceId": { "type": "string", "nullable": true }, "sourceAddress": { "type": "string", "nullable": true }, "recordId": { "type": "string", "nullable": true }, "recordDescription": { "type": "string", "nullable": true }, "companyId": { "type": "integer", "format": "int32", "nullable": true }, "action": { "type": "string", "nullable": true }, "dateStamp": { "type": "string", "format": "date-time" }, "companyName": { "type": "string", "nullable": true }, "productId": { "type": "integer", "format": "int32", "nullable": true }, "productName": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "jsonData": { "type": "string", "nullable": true }, "userRole": { "type": "string", "nullable": true }, "changedValuesList": { "type": "array", "items": { "$ref": "#/components/schemas/ChangedValue" }, "nullable": true } }, "additionalProperties": false }, "AuditLogResponseIListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogResponse" }, "nullable": true } }, "additionalProperties": false }, "AuthRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string" }, "realmId": { "type": "string", "nullable": true }, "redirectUrl": { "type": "string", "nullable": true }, "apMerchantId": { "type": "string", "nullable": true }, "arMerchantId": { "type": "string", "nullable": true }, "codeVerifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AuthResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "systemName": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AuthResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/AuthResponse" } ], "nullable": true } }, "additionalProperties": false }, "AuthSessionDataModel": { "type": "object", "properties": { "systemId": { "type": "integer", "format": "int32", "nullable": true }, "systemName": { "type": "string", "nullable": true }, "financialCompanyId": { "type": "integer", "format": "int32", "nullable": true }, "financialCompanyName": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "expiresDate": { "type": "string", "format": "date-time" }, "createdById": { "type": "string", "nullable": true }, "createdByName": { "type": "string", "nullable": true }, "redirectUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AuthSessionResult": { "type": "object", "properties": { "systemId": { "type": "integer", "format": "int32", "nullable": true }, "systemName": { "type": "string", "nullable": true }, "financialCompanyId": { "type": "integer", "format": "int32", "nullable": true }, "financialCompanyName": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "expiresDate": { "type": "string", "format": "date-time" }, "createdById": { "type": "string", "nullable": true }, "createdByName": { "type": "string", "nullable": true }, "redirectUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AuthSessionResultIListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/AuthSessionResult" }, "nullable": true } }, "additionalProperties": false }, "AuthSessionType": { "enum": [ "Connect", "Update" ], "type": "string" }, "AuthenticateAPIUser": { "required": [ "password", "username" ], "type": "object", "properties": { "username": { "minLength": 1, "type": "string" }, "password": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "AuthenticateUserResponse": { "type": "object", "properties": { "accessToken": { "type": "string", "nullable": true }, "idToken": { "type": "string", "nullable": true }, "refreshToken": { "type": "string", "nullable": true }, "expiresIn": { "type": "integer", "format": "int32" }, "isPasswordChangeRequired": { "type": "boolean" } }, "additionalProperties": false }, "AuthenticateUserResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/AuthenticateUserResponse" } ], "nullable": true } }, "additionalProperties": false }, "ChangedValue": { "type": "object", "properties": { "oldValue": { "type": "string", "nullable": true }, "propertyName": { "type": "string", "nullable": true }, "newValue": { "type": "string", "nullable": true }, "isSecret": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CompanyActivateRequest": { "required": [ "code", "customerId" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string" }, "companyName": { "maxLength": 150, "minLength": 0, "type": "string", "nullable": true }, "customerId": { "minLength": 1, "type": "string" }, "nexusOrganizationId": { "type": "integer", "format": "int32", "nullable": true }, "redirectUris": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isHosted": { "type": "boolean", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/ErpProperties" }, "nullable": true } }, "additionalProperties": false }, "CompanyActivateResponse": { "type": "object", "properties": { "companyId": { "type": "integer", "format": "int32" }, "secret": { "type": "string", "nullable": true }, "clientId": { "type": "string", "format": "uuid" }, "nexusOrganizationId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CompanyActivateResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/CompanyActivateResponse" } ], "nullable": true } }, "additionalProperties": false }, "CompanyErpSettings": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The setting name that is displayed to a user when configuring the integration.", "nullable": true }, "isRequired": { "type": "boolean", "description": "Indicates if the setting is required" }, "isSecret": { "type": "boolean", "description": "Indicates if the setting is secret" }, "isConnectionSpecific": { "type": "boolean", "description": "Indicates if the setting is connection specific" }, "keyId": { "type": "integer", "description": "The unique identifier of the setting.", "format": "int32" }, "key": { "type": "string", "description": "The setting name that is used by the integration.", "nullable": true }, "keyName": { "type": "string", "nullable": true, "deprecated": true }, "eciIntegrationId": { "type": "integer", "description": "The Integration the setting belongs to.", "format": "int32" }, "displayOrdinal": { "type": "integer", "description": "The display ordinal of the setting.", "format": "int32" }, "keyValues": { "type": "array", "items": { "$ref": "#/components/schemas/MasterKeyProperty" }, "description": "A collection of values that are saved for the setting.", "nullable": true } }, "additionalProperties": false }, "CompanyErpSettingsListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyErpSettings" }, "nullable": true } }, "additionalProperties": false }, "CompanyIntegrationDetailResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "isHosted": { "type": "boolean" }, "allowTestConnection": { "type": "boolean" }, "externalConnectionCount": { "type": "integer", "format": "int32" }, "systems": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationSystemSummary" }, "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/ErpApiSettings" }, "nullable": true } }, "additionalProperties": false }, "CompanyIntegrationDetailResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/CompanyIntegrationDetailResponse" } ], "nullable": true } }, "additionalProperties": false }, "CompanyMyobFile": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "CompanyMyobFileIListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyMyobFile" }, "nullable": true } }, "additionalProperties": false }, "CompanyProfileInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "companyName": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "nexusId": { "type": "integer", "format": "int32", "nullable": true }, "isActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "lastActivityDateTime": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CompanyResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customerId": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "nexusId": { "type": "integer", "format": "int32", "nullable": true }, "productName": { "type": "string", "nullable": true }, "integrationName": { "type": "string", "nullable": true }, "lastActivityOn": { "type": "string", "format": "date-time", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "productId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CompanyResponseIListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyResponse" }, "nullable": true } }, "additionalProperties": false }, "CompanySummaryResponse": { "type": "object", "properties": { "companyId": { "type": "integer", "format": "int32" }, "companyName": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "nexusId": { "type": "integer", "format": "int32", "nullable": true }, "isActive": { "type": "boolean" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastActivityDateTime": { "type": "string", "format": "date-time", "nullable": true }, "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationSummary" }, "nullable": true } }, "additionalProperties": false }, "CompanySummaryResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/CompanySummaryResponse" } ], "nullable": true } }, "additionalProperties": false }, "CompleteConnectionRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CompleteConnectionResponse": { "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "apiUserId": { "type": "string", "format": "uuid", "nullable": true }, "companyId": { "type": "integer", "format": "int32" }, "systemId": { "type": "integer", "format": "int32", "nullable": true }, "systemName": { "type": "string", "nullable": true }, "integrationId": { "type": "integer", "format": "int32", "nullable": true }, "integrationName": { "type": "string", "nullable": true }, "productId": { "type": "integer", "format": "int32", "nullable": true }, "productName": { "type": "string", "nullable": true }, "externalName": { "type": "string", "nullable": true }, "externalConnectionId": { "type": "integer", "format": "int32" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CompleteConnectionResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/CompleteConnectionResponse" } ], "nullable": true } }, "additionalProperties": false }, "ConnectionBrandModel": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "longDescription": { "type": "string", "nullable": true }, "vendorName": { "type": "string", "nullable": true }, "vendorUrl": { "type": "string", "nullable": true }, "vendorLogoUrl": { "type": "string", "nullable": true }, "vendorLogoThumbmailUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConnectionChallengeItem": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique id of the challenge. This information is only used for the connection manager to identify the challenge.", "nullable": true }, "type": { "type": "string", "description": "The type of the challenge", "nullable": true, "readOnly": true }, "redirectUrl": { "type": "string", "description": "The redirectUrl for a redirection challenge.", "nullable": true } }, "additionalProperties": false }, "ConnectionMasterKeyModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "displayName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "displayOrdinal": { "type": "integer", "format": "int32" }, "key": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "isRequired": { "type": "boolean" }, "isUpdateable": { "type": "boolean" }, "defaultValue": { "type": "string", "nullable": true }, "minLength": { "type": "integer", "format": "int32", "nullable": true }, "maxLength": { "type": "integer", "format": "int32", "nullable": true }, "isSecret": { "type": "boolean" }, "validationPattern": { "type": "string", "nullable": true }, "validationPatternMessage": { "type": "string", "nullable": true }, "dropdownValues": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ConnectionPartnerBrandModel": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "logoUrl": { "type": "string", "nullable": true }, "terms": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConnectionResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "financialProductCompanyName": { "type": "string", "nullable": true }, "companyId": { "type": "integer", "format": "int32" }, "companyName": { "type": "string", "nullable": true }, "systemId": { "type": "integer", "format": "int32", "nullable": true }, "systemName": { "type": "string", "nullable": true }, "useEciKey": { "type": "boolean" }, "environment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConnectionResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ConnectionResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "ConnectionSessionModel": { "type": "object", "properties": { "sessionId": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "systemId": { "type": "integer", "format": "int32", "nullable": true }, "redirectUrl": { "type": "string", "nullable": true }, "cancelUrl": { "type": "string", "nullable": true }, "validationResults": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionValidationItem" }, "nullable": true }, "challenge": { "allOf": [ { "$ref": "#/components/schemas/ConnectionChallengeItem" } ], "nullable": true }, "isValid": { "type": "boolean", "description": "Whether the session is valid and ready for finalization." }, "authorizationCode": { "type": "string", "description": "This will only be included when the request is to finalize the session.", "nullable": true }, "authorizationUrl": { "type": "string", "description": "This will only be included when the request is to finalize the session.", "nullable": true }, "sessionType": { "allOf": [ { "$ref": "#/components/schemas/AuthSessionType" } ] }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The properties for the integration. This is only returned\r\nwhen the session type is Update, and only non-secret values\r\nare returned.", "nullable": true }, "masterKeys": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionMasterKeyModel" }, "description": "Master keys defines the properties that need to be set for\r\nthis connection.", "nullable": true }, "brand": { "allOf": [ { "$ref": "#/components/schemas/ConnectionBrandModel" } ], "description": "The connection system brand information. Only returned on get parameters calls.", "nullable": true }, "partnerBrand": { "allOf": [ { "$ref": "#/components/schemas/ConnectionPartnerBrandModel" } ], "description": "The partner application brand information.", "nullable": true } }, "additionalProperties": false }, "ConnectionSessionModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ConnectionSessionModel" } ], "nullable": true } }, "additionalProperties": false }, "ConnectionValidationItem": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatedApplicationResponse": { "type": "object", "properties": { "clientId": { "type": "string", "format": "uuid" }, "clientSecret": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatedApplicationResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/CreatedApplicationResponse" } ], "nullable": true } }, "additionalProperties": false }, "CustomReportLogViewModel": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "headers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": { } }, "nullable": true } }, "additionalProperties": false }, "DeviceAuthorizationModel": { "required": [ "code" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "The activation code displayed on the device." }, "companyId": { "type": "string", "description": "The Company ID of the Customer that the device is being activated for, or a string in the format 'PREFIX:VALUE' where prefix\r\nis CustomerID, NexusID, or a customer alias value available in Nexus by which the company can be \r\nidentified.", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Application specific to provide the device on activation", "nullable": true }, "credential": { "allOf": [ { "$ref": "#/components/schemas/DeviceCredentialModel" } ], "description": "If set, this credential will be provided to the device\r\non activation.", "nullable": true } }, "additionalProperties": false }, "DeviceCredentialModel": { "type": "object", "properties": { "secret": { "type": "string", "description": "If requested, this will contain the secret that can be used\r\nto obtain tokens from the token_url using a resource-owner-password\r\ngrant.", "nullable": true }, "tokenEndpoint": { "type": "string", "description": "When a token is provided, this URL can be used with a refresh_token OAuth2 grant\r\nto obtain a new set of tokens.", "nullable": true }, "tokenIssuer": { "type": "string", "nullable": true }, "tokenType": { "type": "string", "nullable": true }, "accessToken": { "type": "string", "nullable": true }, "idToken": { "type": "string", "nullable": true }, "clientId": { "type": "string", "nullable": true }, "expiresAt": { "type": "integer", "description": "The expiration date in unix epoch seconds.", "format": "int64", "nullable": true }, "refreshToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceCredentialType": { "enum": [ "None", "Token", "Secret", "TokenAndSecret" ], "type": "string" }, "DeviceModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "ipAddress": { "type": "string", "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "deviceType": { "type": "string", "nullable": true }, "requestedCredentialType": { "allOf": [ { "$ref": "#/components/schemas/DeviceCredentialType" } ] } }, "additionalProperties": false }, "DeviceModelCountResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceModel" }, "nullable": true } }, "additionalProperties": false }, "DropdownList": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ERPUser": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "emailConfirmed": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "companyIsActive": { "type": "boolean" }, "lastLoginDateTime": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ERPUserListResponse": { "type": "object", "properties": { "erpUserList": { "type": "array", "items": { "$ref": "#/components/schemas/ERPUser" }, "nullable": true } }, "additionalProperties": false }, "ERPUserListResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ERPUserListResponse" } ], "nullable": true } }, "additionalProperties": false }, "ERPUserResponseModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "companyId": { "type": "integer", "format": "int32", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string", "nullable": true }, "emailConfirmed": { "type": "string", "nullable": true }, "lastLoginDateTime": { "type": "string", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean" }, "companyIsActive": { "type": "boolean", "nullable": true }, "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/EciIntegrationResponse" }, "nullable": true }, "products": { "type": "string", "nullable": true }, "productIds": { "type": "string", "nullable": true }, "roleName": { "type": "string", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "providerName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ERPUserResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ERPUserResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "ERPUserResponseModelIListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/ERPUserResponseModel" }, "nullable": true } }, "additionalProperties": false }, "EciIntegrationList": { "type": "object", "properties": { "eciIntegrations": { "type": "array", "items": { "$ref": "#/components/schemas/EciIntegrationResponse" }, "nullable": true } }, "additionalProperties": false }, "EciIntegrationProductResponseModel": { "type": "object", "properties": { "integrationId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "integrationName": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "longDescription": { "type": "string", "nullable": true }, "isPublic": { "type": "boolean" } }, "additionalProperties": false }, "EciIntegrationProductResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/EciIntegrationProductResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "EciIntegrationResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "integrationName": { "type": "string", "nullable": true }, "allowHostedConfigurations": { "type": "boolean", "nullable": true }, "allowOnPremisesConfigurations": { "type": "boolean" }, "enableCompanyManagerDashboard": { "type": "boolean" }, "testConnectionUrl": { "type": "string", "nullable": true }, "allowsTestConnection": { "type": "boolean" }, "isHosted": { "type": "boolean", "nullable": true }, "introductionText": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "isPublished": { "type": "boolean", "nullable": true }, "ipRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "ipRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true }, "companyRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "companyRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true }, "userRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "userRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "EciIntegrationResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/EciIntegrationResponse" } ], "nullable": true } }, "additionalProperties": false }, "EciIntegrationResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "integrationName": { "type": "string", "nullable": true }, "introductionText": { "type": "string", "nullable": true }, "allowHostedConfigurations": { "type": "boolean" }, "isPublished": { "type": "boolean" }, "masterKeys": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationMasterKey" }, "nullable": true }, "system": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationSystem" }, "nullable": true } }, "additionalProperties": false }, "EciProduct": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "productName": { "type": "string", "nullable": true }, "displayname": { "type": "string", "nullable": true }, "defaultNexusAlias": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EciProductList": { "type": "object", "properties": { "allProducts": { "type": "array", "items": { "$ref": "#/components/schemas/EciProduct" }, "nullable": true }, "eciProducts": { "type": "array", "items": { "$ref": "#/components/schemas/EciProduct" }, "nullable": true } }, "additionalProperties": false }, "EciProductListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/EciProductList" } ], "nullable": true } }, "additionalProperties": false }, "EciProductsResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "productName": { "type": "string", "nullable": true }, "displayname": { "type": "string", "nullable": true }, "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/EciIntegrationResponseModel" }, "nullable": true } }, "additionalProperties": false }, "EciProductsResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/EciProductsResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "ErpApiSettings": { "type": "object", "properties": { "keyId": { "type": "integer", "format": "int32", "nullable": true }, "keyName": { "type": "string", "nullable": true }, "isMultiple": { "type": "boolean", "nullable": true }, "isRequired": { "type": "boolean", "nullable": true }, "isCompanyHosted": { "type": "boolean", "nullable": true }, "isCompanyOnPremises": { "type": "boolean", "nullable": true }, "isConnectionSpecific": { "type": "boolean" }, "minLength": { "type": "integer", "format": "int32", "nullable": true }, "maxLength": { "type": "integer", "format": "int32", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "eciIntegrationId": { "type": "integer", "format": "int32", "nullable": true }, "isSecret": { "type": "boolean", "nullable": true }, "maskType": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "validationPattern": { "type": "string", "nullable": true }, "validationPatternMessage": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "dropdownValues": { "type": "string", "nullable": true }, "displayOrdinal": { "type": "integer", "format": "int32" }, "listDropdownValues": { "type": "array", "items": { "type": "string" }, "nullable": true }, "keyValues": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationProperty" }, "nullable": true } }, "additionalProperties": false }, "ErpApiUser": { "required": [ "companyId", "eciIntegrationId", "enablePasswordReset", "expireType", "firstName", "isAdmin", "systemId", "userType" ], "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "email": { "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "type": "string", "nullable": true }, "firstName": { "maxLength": 50, "minLength": 2, "type": "string" }, "lastName": { "type": "string", "nullable": true }, "eciIntegrationId": { "type": "integer", "format": "int32" }, "systemName": { "type": "string", "nullable": true }, "userType": { "type": "integer", "description": "1 = Person, 2 = System (default)", "format": "int32" }, "keyIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "systemId": { "type": "integer", "format": "int32" }, "companyId": { "type": "integer", "format": "int32" }, "isAdmin": { "type": "boolean" }, "enablePasswordReset": { "type": "boolean" }, "expireType": { "type": "integer", "format": "int32" }, "days": { "type": "integer", "format": "int32", "nullable": true }, "expireDateTime": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ErpProperties": { "type": "object", "properties": { "keyId": { "type": "integer", "format": "int32", "nullable": true }, "keyName": { "type": "string", "nullable": true }, "keyValues": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationProperties" }, "nullable": true } }, "additionalProperties": false }, "ExternalCompanyResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "companyId": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "systemName": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "systemId": { "type": "integer", "format": "int32", "nullable": true }, "credentialCount": { "type": "integer", "format": "int32" }, "createDateTime": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ExternalCompanyResponseIListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalCompanyResponse" }, "nullable": true } }, "additionalProperties": false }, "FinancialAPIUser": { "required": [ "eciIntegrationId", "erpApiProductId", "expireType", "financialCompanyId", "firstName", "userType" ], "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "email": { "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "type": "string", "nullable": true }, "firstName": { "maxLength": 50, "minLength": 2, "type": "string" }, "lastName": { "type": "string", "nullable": true }, "eciIntegrationId": { "type": "integer", "format": "int32" }, "systemName": { "type": "string", "nullable": true }, "userType": { "type": "integer", "description": "1 = Person, 2 = System (default)", "format": "int32" }, "financialProduct": { "type": "string", "nullable": true }, "financialCompanyId": { "type": "integer", "format": "int32" }, "erpApiProductId": { "type": "integer", "format": "int32" }, "expireType": { "type": "integer", "format": "int32" }, "days": { "type": "integer", "format": "int32", "nullable": true }, "expireDateTime": { "type": "string", "nullable": true }, "companyId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FinancialAuthRequest": { "required": [ "code", "financialProductId", "isEciKeyRequired", "redirectUri" ], "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "financialProductId": { "type": "integer", "format": "int32" }, "redirectUri": { "minLength": 1, "type": "string" }, "isEciKeyRequired": { "type": "boolean" }, "environment": { "type": "string", "nullable": true }, "systemBaseUrl": { "type": "string", "nullable": true }, "code": { "minLength": 1, "type": "string" }, "realmId": { "type": "string", "nullable": true }, "companyId": { "type": "integer", "format": "int32" }, "sessionId": { "type": "string", "nullable": true }, "codeVerifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FinancialCompanyResponseModel": { "type": "object", "properties": { "financialCompanyProductName": { "type": "string", "nullable": true }, "systemName": { "type": "string", "nullable": true }, "apiUsername": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "modifiedDate": { "type": "string", "format": "date-time", "nullable": true }, "tokenExpiresDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FinancialCompanyResponseModelListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialCompanyResponseModel" }, "nullable": true } }, "additionalProperties": false }, "FinancialIntegrationApiUserProperties": { "type": "object", "properties": { "financialCompanyId": { "type": "integer", "format": "int32", "nullable": true }, "financialCompanyName": { "type": "string", "nullable": true }, "financialCompanyExternalId": { "type": "string", "nullable": true }, "financialSystemBaseUrl": { "type": "string", "nullable": true }, "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GenerateActivationCodeRequestModel": { "required": [ "count", "integrationId", "productId" ], "type": "object", "properties": { "integrationId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "count": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" }, "codeLength": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetApiUserResponseModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "companyId": { "type": "integer", "format": "int32" }, "companyNexusId": { "type": "string", "nullable": true }, "financialCompanyId": { "type": "integer", "format": "int32", "nullable": true }, "financialCompanyName": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "companyCustomerId": { "type": "string", "nullable": true }, "eciProductName": { "type": "string", "nullable": true }, "productId": { "type": "integer", "format": "int32" }, "eciIntegrationId": { "type": "integer", "format": "int32" }, "eciIntegrationName": { "type": "string", "nullable": true }, "isEmailVerified": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "systemId": { "type": "integer", "format": "int32" }, "systemName": { "type": "string", "nullable": true }, "accountVerifiedStatus": { "type": "string", "nullable": true }, "enablePasswordReset": { "type": "boolean" }, "accountStatus": { "type": "string", "nullable": true }, "enableResendVerification": { "type": "boolean" }, "enableConfirmUser": { "type": "boolean" }, "userType": { "type": "integer", "format": "int32" }, "expireType": { "type": "integer", "format": "int32", "nullable": true }, "expireDateUtc": { "type": "string", "format": "date-time", "nullable": true }, "integrationIsActive": { "type": "boolean" }, "integrationIsHosted": { "type": "boolean" }, "companyIsActive": { "type": "boolean" }, "rateLimits": { "allOf": [ { "$ref": "#/components/schemas/RateLimits" } ], "nullable": true }, "apiIntegrationApiUserProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ApiIntegrationApiUserProperty" }, "nullable": true } }, "additionalProperties": false }, "GetApiUserResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/GetApiUserResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "GetMyobCompanyRequestModel": { "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "financialCompanyId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "InitiateConnectionRequest": { "required": [ "redirectUri", "state" ], "type": "object", "properties": { "companyId": { "type": "integer", "description": "Optional value if NexusOrganizationId or NexusApplicationDeploymentId is provided.\r\nNot used on the Nexus user_token path (Company is resolved from the token).", "format": "int32", "nullable": true }, "nexusOrganizationId": { "type": "integer", "description": "Optional value if CompanyId or NexusApplicationDeploymentId is provided.\r\nNot used on the Nexus user_token path (Company is resolved from the token).", "format": "int32", "nullable": true }, "nexusApplicationDeploymentId": { "type": "integer", "description": "Optional value if CompanyId or NexusOrganizationId is provided.\r\nNot used on the Nexus user_token path (Company is resolved from the token).", "format": "int32", "nullable": true }, "state": { "minLength": 10, "type": "string", "description": "Caller-supplied opaque string stored in the auth session and echoed back as the\r\n`state` query parameter on every final redirect to UserManagement.Models.RequestModel.InitiateConnectionRequest.RedirectUri\r\n— success (`?code=…&state=…`) and error (`?error=…&state=…`).\r\nProvides CSRF protection; must be at least 10 characters." }, "integrationId": { "type": "integer", "format": "int32", "nullable": true }, "systemId": { "type": "integer", "format": "int32", "nullable": true }, "redirectUri": { "minLength": 1, "type": "string", "description": "Callback URL the browser is redirected to after the OAuth flow completes.\r\nSuccess redirects append `?code={authCode}&state={state}`;\r\nerror/cancellation redirects append `?error={reason}&state={state}`.\r\nValidated against the application's registered redirect URIs." }, "userToken": { "type": "string", "description": "A Nexus STS access token. When provided, the connection is initiated as a Nexus User\r\nconnection: Company/Product are resolved from the token's claims, no Application API key\r\nis required, and no Cognito account or secret is created.", "nullable": true }, "environment": { "type": "string", "nullable": true }, "partnerApplicationId": { "type": "string", "description": "Optional Partner Application ID for connections that will be completed by a partner application.", "format": "uuid", "nullable": true }, "propertyIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Integration Property IDs that will be used for this connection.\r\nAll required properties for the integration must be included.", "nullable": true } }, "additionalProperties": false }, "InitiateConnectionResponse": { "type": "object", "properties": { "sessionId": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "companyId": { "type": "integer", "format": "int32" }, "clientId": { "type": "string", "description": "Pre-provisioned API credential client ID (username).\r\nPopulated for partner-initiated connections. Null for standard direct connections\r\n(credentials generated at completion) and for the Nexus user_token flow.", "nullable": true } }, "additionalProperties": false }, "InitiateConnectionResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/InitiateConnectionResponse" } ], "nullable": true } }, "additionalProperties": false }, "InitiateUpdateConnectionRequest": { "required": [ "clientId", "redirectUri", "state" ], "type": "object", "properties": { "clientId": { "minLength": 1, "type": "string" }, "redirectUri": { "minLength": 1, "type": "string" }, "state": { "minLength": 10, "type": "string" } }, "additionalProperties": false }, "InsertOtelLogsResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "logsProcessed": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InsertOtelLogsResultAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/InsertOtelLogsResult" } ], "nullable": true } }, "additionalProperties": false }, "InstrumentationScope": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/KeyValuePair" }, "nullable": true }, "droppedAttributesCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "InstrumentationScope (e.g., logger name/version)" }, "IntegrationMasterKey": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "key": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "isSecret": { "type": "boolean" }, "maxLength": { "type": "integer", "format": "int32", "nullable": true }, "minLength": { "type": "integer", "format": "int32", "nullable": true }, "isMultiple": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "defaultValue": { "nullable": true }, "modifiedDate": { "type": "string", "format": "date-time" }, "isCompanyHosted": { "type": "boolean" }, "eciIntegrationId": { "type": "integer", "format": "int32" }, "isCompanyOnPremises": { "type": "boolean", "nullable": true }, "maskType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationMasterKeyDetail": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "key": { "type": "string", "nullable": true }, "isRequired": { "type": "boolean" }, "defaultValue": { "type": "string", "nullable": true }, "isMultiple": { "type": "boolean" }, "eciIntegrationId": { "type": "integer", "format": "int32" }, "isCompanyHosted": { "type": "boolean", "nullable": true }, "isCompanyOnPremises": { "type": "boolean", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" }, "minLength": { "type": "integer", "format": "int32", "nullable": true }, "maxLength": { "type": "integer", "format": "int32", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "isSecret": { "type": "boolean" }, "maskType": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "hostingEnvironment": { "type": "integer", "format": "int32" }, "validationPattern": { "type": "string", "nullable": true }, "validationPatternMessage": { "type": "string", "nullable": true }, "dropdownValues": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isUpdateableOnConnection": { "type": "boolean" }, "displayOrdinal": { "type": "integer", "format": "int32" }, "validationExpression": { "type": "string", "nullable": true }, "isVisibleOnConnection": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "isConnectionSpecific": { "type": "boolean" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/MasterKeyProductsResponseModel" }, "nullable": true }, "systemId": { "type": "integer", "format": "int32", "nullable": true }, "systemName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationProductRequestModel": { "type": "object", "properties": { "productId": { "type": "integer", "format": "int32" }, "shortDescription": { "maxLength": 150, "minLength": 0, "type": "string", "nullable": true }, "longDescription": { "type": "string", "nullable": true }, "ispublic": { "type": "boolean" } }, "additionalProperties": false }, "IntegrationProperties": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "keyValue": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationProperty": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "keyValue": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "integrationName": { "type": "string", "nullable": true }, "introductionText": { "type": "string", "nullable": true }, "allowHostedConfigurations": { "type": "boolean", "nullable": true }, "allowOnPremisesConfigurations": { "type": "boolean" }, "enableCompanyManagerDashboard": { "type": "boolean" }, "testConnectionUrl": { "type": "string", "nullable": true }, "isPublished": { "type": "boolean", "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductsResponseModel" }, "nullable": true }, "systems": { "type": "array", "items": { "$ref": "#/components/schemas/SystemResponseModel" }, "nullable": true } }, "additionalProperties": false }, "IntegrationResponseModelListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationResponseModel" }, "nullable": true } }, "additionalProperties": false }, "IntegrationSettingsRequestModel": { "required": [ "dataType", "displayName", "integrationId", "key", "products" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "integrationId": { "type": "integer", "format": "int32" }, "systemId": { "type": "integer", "format": "int32", "nullable": true }, "key": { "maxLength": 25, "minLength": 1, "type": "string" }, "dataType": { "minLength": 1, "type": "string" }, "maskType": { "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "minLength": 1, "type": "string" }, "products": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isRequired": { "type": "boolean" }, "defaultValue": { "type": "string", "nullable": true }, "isMultiple": { "type": "boolean" }, "environment": { "type": "integer", "format": "int32", "nullable": true }, "minLength": { "type": "integer", "format": "int32", "nullable": true }, "maxLength": { "type": "integer", "format": "int32", "nullable": true }, "isSecret": { "type": "boolean" }, "validationPattern": { "maxLength": 250, "type": "string", "nullable": true }, "validationPatternMessage": { "maxLength": 250, "type": "string", "nullable": true }, "dropdownValues": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isConnectionSpecific": { "type": "boolean" }, "isUpdateableOnConnection": { "type": "boolean" }, "displayOrdinal": { "type": "integer", "format": "int32" }, "validationExpression": { "type": "string", "nullable": true }, "isVisibleOnConnection": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "description": { "maxLength": 100, "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationSettingsRequestModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/IntegrationSettingsRequestModel" } ], "nullable": true } }, "additionalProperties": false }, "IntegrationSettingsResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "key": { "type": "string", "nullable": true }, "isRequired": { "type": "boolean" }, "defaultValue": { "type": "string", "nullable": true }, "eciIntegrationId": { "type": "integer", "format": "int32" }, "isMultiple": { "type": "boolean" }, "dataType": { "type": "string", "nullable": true }, "maxLength": { "type": "integer", "format": "int32", "nullable": true }, "minLength": { "type": "integer", "format": "int32", "nullable": true }, "isSecret": { "type": "boolean" }, "maskType": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "environment": { "type": "integer", "format": "int32" }, "validationPattern": { "type": "string", "nullable": true }, "validationPatternMessage": { "type": "string", "nullable": true }, "dropdownValues": { "type": "array", "items": { "type": "string" }, "nullable": true }, "masterKeyProducts": { "type": "array", "items": { "$ref": "#/components/schemas/MasterKeyProducts" }, "nullable": true }, "isConnectionSpecific": { "type": "boolean" }, "isUpdateableOnConnection": { "type": "boolean" }, "displayOrdinal": { "type": "integer", "format": "int32" }, "validationExpression": { "type": "string", "nullable": true }, "isVisibleOnConnection": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "systemId": { "type": "integer", "format": "int32", "nullable": true }, "systemName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationSettingsResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/IntegrationSettingsResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "IntegrationSummary": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "integrationName": { "type": "string", "nullable": true }, "allowHostedConfigurations": { "type": "boolean" }, "allowOnPremisesConfigurations": { "type": "boolean" }, "enableCompanyManagerDashboard": { "type": "boolean" }, "introductionText": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "isHosted": { "type": "boolean" }, "isPublished": { "type": "boolean" } }, "additionalProperties": false }, "IntegrationSystem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "productName": { "type": "string", "nullable": true }, "eciIntegrationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IntegrationSystemSummary": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "IntegrationsDetailsResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "integrationName": { "type": "string", "nullable": true }, "allowHostedConfigurations": { "type": "boolean" }, "introductionText": { "type": "string", "nullable": true }, "isPublished": { "type": "boolean" }, "ipRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "ipRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true }, "companyRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "companyRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true }, "userRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "userRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true }, "allowOnPremisesConfigurations": { "type": "boolean" }, "enableCompanyManagerDashboard": { "type": "boolean" }, "testConnectionUrl": { "type": "string", "nullable": true }, "masterKeys": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationMasterKeyDetail" }, "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/EciIntegrationProductResponseModel" }, "nullable": true }, "systems": { "type": "array", "items": { "$ref": "#/components/schemas/SystemsDataModel" }, "nullable": true }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationDataModel" }, "nullable": true }, "authSessions": { "type": "array", "items": { "$ref": "#/components/schemas/AuthSessionDataModel" }, "nullable": true } }, "additionalProperties": false }, "IntegrationsDetailsResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/IntegrationsDetailsResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "KeyValueList": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/KeyValuePair" }, "nullable": true } }, "additionalProperties": false, "description": "List of key-value pairs" }, "KeyValuePair": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/AnyValue" } ], "description": "AnyValue - can hold different types\r\nSpec: https://opentelemetry.io/docs/specs/otel/logs/data-model/#type-any", "nullable": true } }, "additionalProperties": false, "description": "Key-Value pair for attributes" }, "ListCompanySystemResult": { "type": "object", "properties": { "systemId": { "type": "integer", "format": "int32" }, "systemName": { "type": "string", "nullable": true }, "integrationId": { "type": "integer", "format": "int32" }, "integrationName": { "type": "string", "nullable": true }, "isPublished": { "type": "boolean" } }, "additionalProperties": false }, "ListCompanySystemResultIEnumerableAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/ListCompanySystemResult" }, "nullable": true } }, "additionalProperties": false }, "ListCompanySystemResultIListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/ListCompanySystemResult" }, "nullable": true } }, "additionalProperties": false }, "LoginProviderResponse": { "type": "object", "properties": { "provider": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LoginProviderResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/LoginProviderResponse" } ], "nullable": true } }, "additionalProperties": false }, "MasterKeyProducts": { "type": "object", "properties": { "productId": { "type": "integer", "format": "int32" }, "isUsed": { "type": "boolean" } }, "additionalProperties": false }, "MasterKeyProductsResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "productName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MasterKeyProperty": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MasterKeysImportRequestModel": { "required": [ "dataType", "displayName", "environment", "key", "products" ], "type": "object", "properties": { "key": { "maxLength": 25, "minLength": 1, "type": "string" }, "systemId": { "type": "integer", "format": "int32", "nullable": true }, "dataType": { "minLength": 1, "type": "string" }, "maskType": { "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "minLength": 1, "type": "string" }, "products": { "type": "array", "items": { "type": "string" } }, "isRequired": { "type": "boolean" }, "defaultValue": { "type": "string", "nullable": true }, "isMultiple": { "type": "boolean" }, "environment": { "minLength": 1, "type": "string" }, "minLength": { "type": "integer", "format": "int32", "nullable": true }, "maxLength": { "type": "integer", "format": "int32", "nullable": true }, "isSecret": { "type": "boolean" }, "validationPattern": { "maxLength": 250, "type": "string", "nullable": true }, "validationPatternMessage": { "type": "string", "nullable": true }, "dropdownValues": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isConnectionSpecific": { "type": "boolean" }, "isUpdateableOnConnection": { "type": "boolean" }, "displayOrdinal": { "type": "integer", "format": "int32" }, "validationExpression": { "type": "string", "nullable": true }, "isVisibleOnConnection": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "description": { "maxLength": 100, "type": "string", "nullable": true } }, "additionalProperties": false }, "NexusAliasCompaniesResponseModel": { "type": "object", "properties": { "nexusId": { "type": "integer", "format": "int32", "nullable": true }, "companyDisplayName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "levenshteinDistance": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "NexusAliasCompaniesResponseModelIReadOnlyListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/NexusAliasCompaniesResponseModel" }, "nullable": true } }, "additionalProperties": false }, "NexusCompaniesResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "displayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NexusCompaniesResponseModelListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/NexusCompaniesResponseModel" }, "nullable": true } }, "additionalProperties": false }, "NexusCompanyRequestModel": { "required": [ "companyName", "customerId", "nexusId", "productId" ], "type": "object", "properties": { "productId": { "type": "integer", "format": "int32" }, "companyName": { "maxLength": 150, "minLength": 0, "type": "string" }, "customerId": { "minLength": 1, "type": "string" }, "nexusId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "NexusCompanyResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "displayName": { "type": "string", "nullable": true }, "defaultCustomerId": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "aliases": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "NexusCompanyResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/NexusCompanyResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "OtelLogRecord": { "type": "object", "properties": { "timeUnixNano": { "type": "string", "description": "Time when the event occurred (Unix nanoseconds)", "nullable": true }, "observedTimeUnixNano": { "type": "string", "description": "Time when the event was observed (Unix nanoseconds)", "nullable": true }, "severityNumber": { "type": "integer", "description": "Severity number (1-24, TRACE to FATAL4)", "format": "int32" }, "severityText": { "type": "string", "description": "Severity text (e.g., \"INFO\", \"ERROR\")", "nullable": true }, "body": { "allOf": [ { "$ref": "#/components/schemas/AnyValue" } ], "description": "Log message body", "nullable": true }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/KeyValuePair" }, "description": "Additional attributes", "nullable": true }, "droppedAttributesCount": { "type": "integer", "description": "Dropped attributes count", "format": "int32" }, "traceId": { "type": "string", "description": "Trace ID (hex string, 32 chars)", "nullable": true }, "spanId": { "type": "string", "description": "Span ID (hex string, 16 chars)", "nullable": true }, "flags": { "type": "integer", "description": "Trace flags", "format": "int32" } }, "additionalProperties": false, "description": "Individual log record following OTLP spec" }, "OtelLogRequest": { "type": "object", "properties": { "resourceLogs": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLog" }, "nullable": true } }, "additionalProperties": false, "description": "OTLP Log Export Request (HTTP JSON format)\r\nSpec: https://opentelemetry.io/docs/specs/otlp/#otlphttp-request" }, "OtelResource": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/KeyValuePair" }, "nullable": true }, "droppedAttributesCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Resource attributes (e.g., service.name, service.version)" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProductEnum": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "type": "integer", "format": "int32" }, "ProductInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "productName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProductsResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "productName": { "type": "string", "nullable": true }, "displayname": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "longDescription": { "type": "string", "nullable": true }, "maxConnectionCount": { "type": "integer", "format": "int32", "nullable": true }, "isPublic": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "RateLimits": { "type": "object", "properties": { "ip": { "type": "integer", "format": "int32", "nullable": true }, "ipPeriod": { "type": "integer", "format": "int32", "nullable": true }, "company": { "type": "integer", "format": "int32", "nullable": true }, "companyPeriod": { "type": "integer", "format": "int32", "nullable": true }, "user": { "type": "integer", "format": "int32", "nullable": true }, "userPeriod": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "RegisterUser": { "required": [ "email", "roleId" ], "type": "object", "properties": { "email": { "minLength": 1, "pattern": ".*@.*", "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "companyId": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "products": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "providerName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportListResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string", "nullable": true }, "queryType": { "type": "string", "nullable": true }, "integrationId": { "type": "integer", "format": "int32", "nullable": true }, "integrationName": { "type": "string", "nullable": true }, "roles": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "isActive": { "type": "boolean" }, "useDateRange": { "type": "boolean" } }, "additionalProperties": false }, "ReportListResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ReportListResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "ReportParameterListResponseModel": { "type": "object", "properties": { "reportParameters": { "type": "array", "items": { "$ref": "#/components/schemas/ReportParameterResModel" }, "nullable": true } }, "additionalProperties": false }, "ReportParameterListResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ReportParameterListResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "ReportParameterRequestModel": { "required": [ "displayName", "parameterName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "parameterName": { "maxLength": 30, "minLength": 1, "pattern": "^[A-Za-z0-9_]*$", "type": "string" }, "displayName": { "maxLength": 50, "minLength": 1, "type": "string" }, "dataType": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true }, "validationPattern": { "type": "string", "nullable": true }, "validationPatternMessage": { "type": "string", "nullable": true }, "dropdownType": { "type": "integer", "format": "int32", "nullable": true }, "dropdownValues": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isRequired": { "type": "boolean" } }, "additionalProperties": false }, "ReportParameterResModel": { "type": "object", "properties": { "reportParameterId": { "type": "integer", "format": "int32" }, "displayName": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "validationPattern": { "type": "string", "nullable": true }, "validationPatternMessage": { "type": "string", "nullable": true }, "dropDownValue": { "type": "array", "items": { "$ref": "#/components/schemas/DropdownList" }, "nullable": true }, "dropdownType": { "type": "integer", "format": "int32", "nullable": true }, "parameterName": { "type": "string", "nullable": true }, "isRequired": { "type": "boolean" } }, "additionalProperties": false }, "ReportParameterResponseModel": { "type": "object", "properties": { "reportParameterId": { "type": "integer", "format": "int32" }, "displayName": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "validationPattern": { "type": "string", "nullable": true }, "validationPatternMessage": { "type": "string", "nullable": true }, "dropDownValue": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dropdownType": { "type": "integer", "format": "int32", "nullable": true }, "parameterName": { "type": "string", "nullable": true }, "isRequired": { "type": "boolean" } }, "additionalProperties": false }, "ReportParameterResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ReportParameterResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "ReportPostData": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string", "nullable": true }, "sourceName": { "type": "string", "nullable": true }, "integrationId": { "type": "integer", "format": "int32", "nullable": true }, "queryType": { "type": "string", "nullable": true }, "queryText": { "type": "string", "nullable": true }, "roles": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "isActive": { "type": "boolean" }, "useDateRange": { "type": "boolean" } }, "additionalProperties": false }, "ReportRequestModel": { "type": "object", "properties": { "sourceId": { "type": "integer", "format": "int32" }, "data": { "allOf": [ { "$ref": "#/components/schemas/ReportPostData" } ], "nullable": true } }, "additionalProperties": false }, "ReportResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string", "nullable": true }, "queryType": { "type": "string", "nullable": true }, "integrationId": { "type": "integer", "format": "int32", "nullable": true }, "integrationName": { "type": "string", "nullable": true }, "roles": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "isActive": { "type": "boolean" }, "useDateRange": { "type": "boolean" }, "sourceName": { "type": "string", "nullable": true }, "queryText": { "type": "string", "nullable": true }, "reportParameters": { "type": "array", "items": { "$ref": "#/components/schemas/ReportParameterResponseModel" }, "nullable": true } }, "additionalProperties": false }, "ReportResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ReportResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "ResourceLog": { "type": "object", "properties": { "resource": { "allOf": [ { "$ref": "#/components/schemas/OtelResource" } ], "description": "Resource attributes (e.g., service.name, service.version)", "nullable": true }, "scopeLogs": { "type": "array", "items": { "$ref": "#/components/schemas/ScopeLog" }, "nullable": true }, "schemaUrl": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "A collection of logs from a Resource" }, "Role": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "roleName": { "type": "string", "nullable": true }, "displayname": { "type": "string", "nullable": true }, "editRequiresRole": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "RoleIEnumerableAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Role" }, "nullable": true } }, "additionalProperties": false }, "ScopeLog": { "type": "object", "properties": { "scope": { "allOf": [ { "$ref": "#/components/schemas/InstrumentationScope" } ], "description": "InstrumentationScope (e.g., logger name/version)", "nullable": true }, "logRecords": { "type": "array", "items": { "$ref": "#/components/schemas/OtelLogRecord" }, "nullable": true }, "schemaUrl": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "A collection of logs from an InstrumentationScope" }, "SsoProvider": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "identifiers": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "StringAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringIListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "StringObjectDictionaryAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "SyncProductsResult": { "type": "object", "properties": { "added": { "type": "integer", "format": "int32" }, "updated": { "type": "integer", "format": "int32" }, "skipped": { "type": "integer", "format": "int32" }, "newProductNames": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SyncProductsResultAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/SyncProductsResult" } ], "nullable": true } }, "additionalProperties": false }, "SystemDetailResponseModel": { "type": "object", "properties": { "integrationName": { "type": "string", "nullable": true }, "systemName": { "maxLength": 25, "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "canBeCreatedByAdmin": { "type": "boolean", "nullable": true }, "vendorName": { "type": "string", "nullable": true }, "vendorUrl": { "type": "string", "nullable": true }, "vendorLogoUrl": { "type": "string", "nullable": true }, "vendorLogoThumbmailUrl": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "longDescription": { "type": "string", "nullable": true }, "isPublic": { "type": "boolean", "nullable": true }, "maxConnectionCount": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "eciIntegrationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SystemDetailResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/SystemDetailResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "SystemDetailResponseModelIListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/SystemDetailResponseModel" }, "nullable": true } }, "additionalProperties": false }, "SystemImportRequestModel": { "required": [ "systemName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "systemName": { "maxLength": 25, "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "canBeCreatedByAdmin": { "type": "boolean" }, "vendorName": { "type": "string", "nullable": true }, "vendorUrl": { "type": "string", "nullable": true }, "vendorLogoUrl": { "type": "string", "nullable": true }, "vendorLogoThumbmailUrl": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "longDescription": { "type": "string", "nullable": true }, "isPublic": { "type": "boolean" }, "maxConnectionCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SystemMeResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "roleName": { "type": "string", "nullable": true }, "company": { "allOf": [ { "$ref": "#/components/schemas/CompanyProfileInfo" } ], "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductInfo" }, "nullable": true }, "redirectUris": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SystemMeResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/SystemMeResponse" } ], "nullable": true } }, "additionalProperties": false }, "SystemRequestModel": { "type": "object", "properties": { "integrationName": { "type": "string", "nullable": true }, "systemName": { "maxLength": 25, "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "canBeCreatedByAdmin": { "type": "boolean", "nullable": true }, "vendorName": { "type": "string", "nullable": true }, "vendorUrl": { "type": "string", "nullable": true }, "vendorLogoUrl": { "type": "string", "nullable": true }, "vendorLogoThumbmailUrl": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "longDescription": { "type": "string", "nullable": true }, "isPublic": { "type": "boolean", "nullable": true }, "maxConnectionCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SystemResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "productName": { "type": "string", "nullable": true }, "eciIntegrationId": { "type": "integer", "format": "int32", "nullable": true }, "vendorName": { "type": "string", "nullable": true }, "vendorUrl": { "type": "string", "nullable": true }, "vendorLogoUrl": { "type": "string", "nullable": true }, "vendorLogoThumbmailUrl": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "longDescription": { "type": "string", "nullable": true }, "maxConnectionCount": { "type": "integer", "format": "int32", "nullable": true }, "isPublic": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "SystemsDataModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "systemName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "canBeCreatedByAdmin": { "type": "boolean" }, "vendorName": { "type": "string", "nullable": true }, "vendorUrl": { "type": "string", "nullable": true }, "vendorLogoUrl": { "type": "string", "nullable": true }, "vendorLogoThumbmailUrl": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "longDescription": { "type": "string", "nullable": true }, "isPublic": { "type": "boolean" }, "maxConnectionCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TestConnectionRequestModel": { "type": "object", "properties": { "financialCompanyId": { "type": "integer", "format": "int32", "nullable": true }, "erpApiSettingId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "TestConnectionResponseDetail": { "type": "object", "properties": { "step": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "passed": { "type": "boolean" }, "failureReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TestConnectionResponseModel": { "type": "object", "properties": { "passed": { "type": "boolean" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/TestConnectionResponseDetail" }, "nullable": true } }, "additionalProperties": false }, "TestConnectionResponseModelAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/TestConnectionResponseModel" } ], "nullable": true } }, "additionalProperties": false }, "ToggleEntityModel": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "additionalProperties": false }, "TraceMessageResponse": { "type": "object", "properties": { "traceIdentifier": { "type": "string", "nullable": true }, "xRayTraceId": { "type": "string", "nullable": true }, "traceId": { "type": "string", "nullable": true }, "timeStamp": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "httpMethod": { "type": "string", "nullable": true }, "responseCode": { "type": "string", "nullable": true }, "requestHost": { "type": "string", "nullable": true }, "requestScheme": { "type": "string", "nullable": true }, "requestQuery": { "type": "string", "nullable": true }, "sourceAddress": { "type": "string", "nullable": true }, "apiUserName": { "type": "string", "nullable": true }, "requestId": { "type": "string", "nullable": true }, "apiGwRequestId": { "type": "string", "nullable": true }, "responseRequestId": { "type": "string", "nullable": true }, "duration": { "type": "string", "nullable": true }, "requestPath": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "companyId": { "type": "string", "nullable": true }, "responseError": { "type": "string", "nullable": true }, "system": { "type": "string", "nullable": true }, "messageText": { "type": "string", "nullable": true }, "logLevel": { "type": "string", "nullable": true }, "spanId": { "type": "string", "nullable": true }, "application": { "type": "string", "nullable": true }, "eventId": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "elapsedMilliseconds": { "type": "string", "nullable": true }, "statusCode": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "exceptionType": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "nullable": true }, "applicationVersion": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TraceMessageResponseListAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/TraceMessageResponse" }, "nullable": true } }, "additionalProperties": false }, "UpdateAdmins": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "products": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "providerName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateApiUserRequestModel": { "required": [ "firstName", "username" ], "type": "object", "properties": { "username": { "minLength": 1, "type": "string" }, "firstName": { "minLength": 1, "type": "string" }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "keyIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "isPasswordChanged": { "type": "boolean" }, "companyId": { "type": "integer", "format": "int32" }, "financialCompanyId": { "type": "integer", "format": "int32" }, "userType": { "type": "integer", "format": "int32" }, "expireType": { "type": "integer", "format": "int32" }, "days": { "type": "integer", "format": "int32", "nullable": true }, "expireDateTime": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateApplicationRequestModel": { "type": "object", "properties": { "roleId": { "type": "integer", "format": "int32", "nullable": true }, "productId": { "type": "integer", "format": "int32", "nullable": true }, "companyId": { "type": "integer", "format": "int32", "nullable": true }, "integrationId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "nullable": true }, "redirectUris": { "type": "string", "description": "A list of possible redirect URIs for authentication flows. \r\nMultiple values should be separated with line feeds (\\n).", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "displayName": { "type": "string", "description": "Display name for the partner shown during connection flow.\r\nOnly applicable when RoleId = Partner (6).", "nullable": true }, "logoUrl": { "type": "string", "description": "URL to the partner's logo for branding purposes.\r\nOnly applicable when RoleId = Partner (6).", "nullable": true }, "terms": { "type": "string", "description": "Terms and conditions text (supports HTML) shown during authorization.\r\nOnly applicable when RoleId = Partner (6).", "nullable": true } }, "additionalProperties": false }, "UpdateChallengeRequest": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UpdateCompany": { "type": "object", "properties": { "companyName": { "maxLength": 150, "minLength": 0, "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "nexusId": { "type": "integer", "format": "int32", "nullable": true }, "maxCompanyManagers": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UpdateCompanyIntegrationModel": { "type": "object", "properties": { "isActive": { "type": "boolean", "nullable": true }, "erpProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ErpProperties" }, "nullable": true } }, "additionalProperties": false }, "UpdateConnectionModel": { "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The properties that are being updated. This payload varies by the type of integration/system." } }, "additionalProperties": false }, "UpdateConnectionSystemRequest": { "required": [ "systemId" ], "type": "object", "properties": { "systemId": { "type": "integer", "format": "int32" }, "environment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateFinancialDetailRequestModel": { "type": "object", "properties": { "financialCompanyId": { "type": "integer", "format": "int32" }, "myobCompanyName": { "type": "string", "nullable": true }, "myobCompanyId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateIntegration": { "type": "object", "properties": { "integrationName": { "maxLength": 50, "type": "string", "nullable": true }, "allowHostedConfigurations": { "type": "boolean", "nullable": true }, "allowOnPremisesConfigurations": { "type": "boolean", "nullable": true }, "enableCompanyManagerDashboard": { "type": "boolean", "nullable": true }, "introductionText": { "type": "string", "nullable": true }, "testConnectionUrl": { "type": "string", "nullable": true }, "isPublished": { "type": "boolean", "nullable": true }, "ipRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "ipRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true }, "companyRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "companyRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true }, "userRateLimitDefault": { "type": "integer", "format": "int32", "nullable": true }, "userRateLimitDefaultPeriod": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UpdateIntegrationProductsDetail": { "type": "object", "properties": { "shortDescription": { "type": "string", "nullable": true }, "longDescription": { "type": "string", "nullable": true }, "isPublic": { "type": "boolean" } }, "additionalProperties": false }, "UpdateSessionModel": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The properties that are being updated. This payload varies by the type of integration/system.", "nullable": true }, "finalize": { "type": "boolean", "description": "If the session is being requested to be finalized or not.\r\nFinallized sessions can no longer be modified. An authorization code will be generated\r\nand returned in the response this one time. It will not be stored or available to return again.", "nullable": true } }, "additionalProperties": false }, "UpdateUserProfile": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateUserProfileAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/UpdateUserProfile" } ], "nullable": true } }, "additionalProperties": false }, "UserCompany": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "companyName": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "nexusId": { "type": "integer", "format": "int32", "nullable": true }, "isActive": { "type": "boolean" }, "companyProduct": { "allOf": [ { "$ref": "#/components/schemas/EciProduct" } ], "nullable": true }, "connectedIntegrations": { "allOf": [ { "$ref": "#/components/schemas/EciIntegrationList" } ], "nullable": true }, "unconnectedIntegrations": { "allOf": [ { "$ref": "#/components/schemas/EciIntegrationList" } ], "nullable": true }, "erpApiProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ErpApiSettings" }, "nullable": true }, "system": { "type": "array", "items": { "$ref": "#/components/schemas/UserCompanySystem" }, "nullable": true }, "systemResponse": { "type": "array", "items": { "$ref": "#/components/schemas/UserCompanySystemResponseModel" }, "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "lastActivityDateTime": { "type": "string", "format": "date-time", "nullable": true }, "canCreateApiUser": { "type": "boolean" }, "maxCompanyManagers": { "type": "integer", "format": "int32" }, "currentCompanyManagers": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UserCompanyAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/UserCompany" } ], "nullable": true } }, "additionalProperties": false }, "UserCompanySystem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "productName": { "type": "string", "nullable": true }, "eciIntegrationId": { "type": "integer", "format": "int32", "nullable": true }, "integrationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserCompanySystemResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "systemName": { "type": "string", "nullable": true }, "integrationId": { "type": "integer", "format": "int32", "nullable": true }, "integrationName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserMeResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "roleId": { "type": "integer", "format": "int32", "nullable": true }, "email": { "type": "string", "nullable": true }, "sub": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidateConnectionRequest": { "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidateFinancialKeys": { "required": [ "financialProductId", "isEciKeyRequired", "redirectUri" ], "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "financialProductId": { "type": "integer", "format": "int32" }, "redirectUri": { "minLength": 1, "type": "string" }, "isEciKeyRequired": { "type": "boolean" }, "environment": { "type": "string", "nullable": true }, "systemBaseUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidateFinancialKeysResponse": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "sessionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidateFinancialKeysResponseAPIResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "responseException": { "allOf": [ { "$ref": "#/components/schemas/ApiError" } ], "nullable": true }, "result": { "allOf": [ { "$ref": "#/components/schemas/ValidateFinancialKeysResponse" } ], "nullable": true } }, "additionalProperties": false }, "ValidateIntegrationRequestModel": { "required": [ "additionalProperties", "systemId" ], "type": "object", "properties": { "systemId": { "type": "integer", "format": "int32" }, "additionalProperties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } } }, "additionalProperties": false }, "ValidationError": { "type": "object", "properties": { "field": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "oidc": { "type": "openIdConnect", "description": "Use id_token obtained from OpenID Connect flow.", "openIdConnectUrl": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_9IYBf4TpD/.well-known/openid-configuration", "x-tokenName": "id_token" }, "Basic": { "type": "http", "description": "Username is ClientID, Password is Client Secret.", "scheme": "Basic" } } }, "security": [ { "oidc": [ "openid" ] }, { "Basic": [ ] } ] }