analytics

2.0info: 2.11.0 analytics description: Serviço do Analytics do ERP XT. x-senior-domain: erpxt x-senior-domain-path: erpxt x-senior-service-path: analytics contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpxtsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /analytics/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/getAnalyticAnalysis: post: description: Retorna a análise do relatório passado por parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – analyticType properties: analyticType: type: string allOf: – #/definitions/enumAnalytics description: Relatório que deverá ser consultado. Atualmente disponível apenas para: Contábil responses: 200: description: Ok schema: type: object required: – analysis properties: analysis: type: object allOf: – #/definitions/analyticAnalysis description: Objeto com a análise do Analytic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a análise do relatório passado por parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: analyticType description: Relatório que deverá ser consultado. Atualmente disponível apenas para: Contábil in: query required: true type: string allOf: – #/definitions/enumAnalytics responses: 200: description: Ok schema: type: object required: – analysis properties: analysis: type: object allOf: – #/definitions/analyticAnalysis description: Objeto com a análise do Analytic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/getUserAnalytics: post: description: Retorna os relatórios disponíveis ao usuário de acordo com os recursos e permissões tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – analytics properties: analytics: type: array items: type: object allOf: – #/definitions/userAnalytic minimum: 1 description: Lista de Analytics disponíveis para o usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os relatórios disponíveis ao usuário de acordo com os recursos e permissões tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – analytics properties: analytics: type: array items: type: object allOf: – #/definitions/userAnalytic minimum: 1 description: Lista de Analytics disponíveis para o usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestCompanyCodeFilter: post: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestBranchCodeFilter: post: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestBranchNameFilter: post: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestAccountFilter: post: description: Filtrar dados nas páginas por contas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Termo de Busca responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados nas páginas por contas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Termo de Busca in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestSupplierGroupFilter: post: description: Filtrar dados nas páginas por grupo de fornecedores tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Termo de Busca responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados nas páginas por grupo de fornecedores tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Termo de Busca in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestReceiptFormFilter: post: description: Filtrar dados nas páginas por forma de recebimento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Termo de Busca responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados nas páginas por forma de recebimento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Termo de Busca in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores possíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestProductFilter: post: description: Filtrar dados nas páginas por produtos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Termo de busca responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores disponíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados nas páginas por produtos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Termo de busca in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores disponíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestTenantFilter: post: description: Filtrar dados nas páginas por tenants tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Termo de busca responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores disponíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados nas páginas por tenants tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Termo de busca in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores disponíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestClientCodeFilter: post: description: Filtrar dados nas páginas por código de cliente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Termo de busca responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores disponíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados nas páginas por código de cliente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Termo de busca in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Valores disponíveis para filtrar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestRevenueCompanyCodeFilter: post: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestRevenueBranchCodeFilter: post: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestRevenueBranchNameFilter: post: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestPurchaseCompanyCodeFilter: post: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestPurchaseBranchCodeFilter: post: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestPurchaseBranchNameFilter: post: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestSalesCompanyCodeFilter: post: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestSalesBranchCodeFilter: post: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestSalesBranchNameFilter: post: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestAccountingCompanyCodeFilter: post: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestAccountingBranchCodeFilter: post: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestAccountingBranchNameFilter: post: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestManagementCompanyCodeFilter: post: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestManagementBranchCodeFilter: post: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestManagementBranchNameFilter: post: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestProductionCompanyCodeFilter: post: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestFiscalCompanyCodeFilter: post: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestFiscalBranchCodeFilter: post: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por código de filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestFiscalBranchNameFilter: post: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por nome da filial tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestCodeFilter: post: description: Endpoints analytics Mega\nFiltrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Endpoints analytics Mega\nFiltrar dados por código de empresa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseIntegerFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/requestEnterpriseIncorpFilter: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Pesquisa responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: search description: Pesquisa in: query type: string responses: 200: description: Ok schema: type: object required: – values properties: values: type: array items: type: object allOf: – #/definitions/baseFilter minimum: 1 description: Filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/getAnalyticsDataEngineer: post: description: Filtrar dados por Orçamento e Nome do Responsável e Usuarios de acesso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: budgetName: type: string description: Pesquisa responsibleName: type: string description: Nome Responsável projectAcessName: type: string description: Usuario plataforma que terá acesso ao projeto responses: 200: description: Ok schema: type: object required: – listAnalytics properties: listAnalytics: type: array items: type: object allOf: – #/definitions/recAnalytics minimum: 1 description: Dados do analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Filtrar dados por Orçamento e Nome do Responsável e Usuarios de acesso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: budgetName description: Pesquisa in: query type: string – name: responsibleName description: Nome Responsável in: query type: string – name: projectAcessName description: Usuario plataforma que terá acesso ao projeto in: query type: string responses: 200: description: Ok schema: type: object required: – listAnalytics properties: listAnalytics: type: array items: type: object allOf: – #/definitions/recAnalytics minimum: 1 description: Dados do analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/getBusinessList: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: businessList: type: array items: type: string description: Lista de empreendimentos a serem exibidos no front 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object properties: businessList: type: array items: type: string description: Lista de empreendimentos a serem exibidos no front 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/getBudgetByCode: post: description: Filtro dataset de api para utilização de queryParans tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: projectCode: type: array items: type: string description: Código do Projeto responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/dataProjectionAnalytics minimum: 1 description: Retorno padrão para analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/getFiltersIncorporation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empreendimento: type: array items: type: string description: Empreendimento dataInicial: type: array items: type: string description: Data Inicial dataFinal: type: array items: type: string description: Data Final tipoContrato: type: array items: type: string description: Tipo de Contrato receita: type: array items: type: string description: Receita tipoParcela: type: array items: type: string description: Tipo de Parcela responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/dataProjectionAnalyticsString minimum: 1 description: Retorno padrão para analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/exportAnalyticAnalysis: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/exportAnalyticUploadControl: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/requestUpload__2: post: description: Solicita o upload de arquivos para o storage do datalake tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/uploadRequestInput__2 responses: 200: description: Ok schema: type: object allOf: – #/definitions/requestUploadResponse__2 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /analytics/actions/commitFile__2: post: description: Confirma o arquivo no storage do datalake tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/uploadRequestInput__2 responses: 200: description: Ok schema: type: object allOf: – #/definitions/commitFileResponse__2 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /analytics/actions/generateAiAnalysis: post: description: Aciona a geração de análise por AI (ChatGPT) do relatório informado por parâmetro. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – analyticType properties: analyticType: type: string allOf: – #/definitions/enumAnalytics description: Relatório que deverá ser analisado. Atualmente disponível apenas para: Contábil responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/createInsight: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – insightGeneratorId properties: insightGeneratorId: type: string description: Id do gerador de insight responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Insight gerado pela Inteligência Artificial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/createSharedDatasets: post: description: Cria os datasets shared do ERP Analytics tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/createSharedAnalytics: post: description: Cria os analytics shared do ERP Analytics tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/createSharedPages: post: description: Cria as páginas shared do ERP Analytics tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/importAnalyticAnalysis: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/importAnalyticUploadControl: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/events/importAnalyticAnalysisEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics/events/exportAnalyticAnalysisEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics/events/importAnalyticUploadControlEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics/events/exportAnalyticUploadControlEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /analytics/entities/analyticAnalysis: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/analyticAnalysis responses: 200: description: The created resource schema: #/definitions/analyticAnalysis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/analyticAnalysis responses: 200: description: The created resource schema: #/definitions/analyticAnalysis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/analyticAnalysis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/analyticAnalysis/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAnalyticAnalysis responses: 200: description: Ok schema: #/definitions/editAnalyticAnalysis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/analyticAnalysis responses: 200: description: Ok schema: #/definitions/analyticAnalysis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/analyticAnalysis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/analyticAnalysis/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/analyticAnalysis responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/analyticUploadControl: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/analyticUploadControl responses: 200: description: The created resource schema: #/definitions/analyticUploadControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/analyticUploadControl responses: 200: description: The created resource schema: #/definitions/analyticUploadControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/analyticUploadControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/analyticUploadControl/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAnalyticUploadControl responses: 200: description: Ok schema: #/definitions/editAnalyticUploadControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/analyticUploadControl responses: 200: description: Ok schema: #/definitions/analyticUploadControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/analyticUploadControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/analyticUploadControl/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/analyticUploadControl responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumAnalytics: type: string enum: – FINANCIAL_DASHBOARD – REVENUE_DASHBOARD – DASHBOARD_CONTROL – PURCHASE_DASHBOARD – SALES_DASHBOARD – ACCOUNTING_DASHBOARD – MANAGEMENT_DASHBOARD – PRODUCTION_DASHBOARD – FISCAL_DASHBOARD – MEGA_ENGENHARIA_DASHBOARD – MEGA_INCORPORACAO_DASHBOARD description: Analytics: * `FINANCIAL_DASHBOARD` – Financial * `REVENUE_DASHBOARD` – Faturamento * `DASHBOARD_CONTROL` – Dashboard Control – Uso Interno * `PURCHASE_DASHBOARD` – Compras * `SALES_DASHBOARD` – Vendas * `ACCOUNTING_DASHBOARD` – Contábil * `MANAGEMENT_DASHBOARD` – Gerencial * `PRODUCTION_DASHBOARD` – Produção * `FISCAL_DASHBOARD` – Fiscal * `MEGA_ENGENHARIA_DASHBOARD` – Mega Engenahria * `MEGA_INCORPORACAO_DASHBOARD` – MEGA INCORPORACAO analyticAnalysisStatus: type: string enum: – NOT_INITIALIZED – IN_PROGRESS – DONE – ERROR description: Status da análise por IA: * `NOT_INITIALIZED` – Não solicitado * `IN_PROGRESS` – Em andamento * `DONE` – Pronto, Finalizado * `ERROR` – Erro enumCost: type: string enum: – PREVISTO – ESTOURO – ECONOMIA enumDeadline: type: string enum: – ATRASADO – ADIANTADO – EM_DIA description: ENUM para Prazo: * `ATRASADO` – PRAZO ACIMA DO ESTABELECIDO * `ADIANTADO` – PRAZO ABAIXO DO ESTABELECIDO * `EM_DIA` – PRAZO DENTRO DO ESTABELECIDO userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error analyticAnalysis: description: Entidade que armazena a análise gerada por IA (ChatGPT) para um relatório type: object required: – name – type – status properties: id: type: string format: uuid description: ID do registro name: type: string description: Nome do relatório type: type: string allOf: – #/definitions/enumAnalytics description: Tipo do relatório status: type: string allOf: – #/definitions/analyticAnalysisStatus description: Status da análise por IA analysisResult: type: string maxLength: 4000 description: Resultado da análise gerada por IA analysisResultDateTime: type: string format: date-time description: Data do resultado da análise gerada por IA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAnalyticAnalysis: type: object required: – id allOf: – #/definitions/analyticAnalysis analyticUploadControl: description: Entidade que faz o controle dos uploads realizados pelos clientes type: object required: – fileName – lastUpload – uploadAmount properties: id: type: string format: uuid description: ID do registro fileName: type: string description: Nome do arquivo lastUpload: type: string format: date-time description: Data do último upload uploadAmount: type: integer format: int64 description: Quantidade de uploads realizados no período createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAnalyticUploadControl: type: object required: – id allOf: – #/definitions/analyticUploadControl checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck uploadRequestInput__2: description: Requisição de upload de arquivo para o datalake type: object required: – codeCli – baseName – fileName properties: codeCli: type: string description: Código do cliente perante a base de clientes da Senior baseName: type: string description: Nome da base que o arquivo deve ser enviado fileName: type: string description: Nome do arquivo completo com diretório conforme documentação do datalake uploadResponse__2: description: Resposta da requisição de upload/complete de arquivo para o datalake discriminator: _discriminator type: object required: – statusCode – success – _discriminator properties: statusCode: type: integer format: int64 description: Código da resposta HTTP do serviço AWS success: type: boolean description: Tudo ocorreu com sucesso _discriminator: type: string description: requestUploadResponse__2: description: Resposta da requisição de upload de arquivo para o datalake allOf: – #/definitions/uploadResponse__2 – type: object required: – url properties: url: type: string description: Mensagem do serviço AWS commitFileResponse__2: description: Resposta da requisição de complete de arquivo para o datalake allOf: – #/definitions/uploadResponse__2 – type: object required: – message properties: message: type: string description: Mensagem do serviço AWS userAnalytic: description: User Analytic type: object required: – name – description – type – pageId – hasAiAnalysis – hasInfoDatalake properties: name: type: string description: Nome do Relatório description: type: string description: Descrição do Relatório type: type: string allOf: – #/definitions/enumAnalytics description: Tipo do Analytic (identificador) pageId: type: string description: ID da página utilizado pelo CMS hasAiAnalysis: type: boolean description: Indica se existe uma análise de IA para o relatório hasInfoDatalake: type: boolean description: Indica se existe dados carregados para cada analytic baseFilter: description: Record para filtros que possuem apenas um campo de resposta type: object required: – value properties: value: type: string description: Resultado da busca baseIntegerFilter: description: Filtros numéricos com apenas um campo type: object required: – value properties: value: type: integer format: int64 description: Valores recAnalytics: description: Dados retornados no filtro type: object properties: budgetName: type: string description: Nome do orçamento responsibleName: type: string description: Nome do Responsável costStatus: type: string allOf: – #/definitions/enumCost description: ENUM de custo deadline: type: string allOf: – #/definitions/enumDeadline description: ENUM de prazo projection: type: string description: Projeção updatedData: type: string format: date description: Data de atualização projectCode: type: string description: Código do projeto dataProjectionAnalytics: description: Retorno dos datasets de API, padrão para o analytics type: object required: – column – series properties: column: type: string description: valores da coluna series: type: number format: double description: valores da série dataProjectionAnalyticsString: description: type: object required: – column – series properties: column: type: string description: valores da coluna series: type: string description: valores da série notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage