erp_cge

gct_painelcontroladoria

41 views 22/10/2018 07/11/2018 integrador 0

2.0info: 0.1.1 gct_painelcontroladoria x-senior-domain: erp_cge x-senior-domain-path: erp_cge x-senior-service-path: gct_painelcontroladoria contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_cgesecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /gct_painelcontroladoria/queries/buscarValoresFiliaisPendentesFiscal: post: description: Buscar quantidade e percentual de filiais pendentes de fechamento fiscal tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competencia – empresas properties: competencia: type: string format: date description: Competência do fechamento empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Lista de empresas filiais: type: array items: type: object allOf: – #/definitions/recFilial description: Lista de filiais responses: 200: description: Ok schema: type: object required: – quantidade – percentual properties: quantidade: type: integer format: int64 description: Quantidade de filiais pendentes percentual: type: number format: double description: Percentual de filiais pendentes default: description: Error response schema: #/definitions/genericError get: description: Buscar quantidade e percentual de filiais pendentes de fechamento fiscal tags: – Queries x-senior-visibility: PRIVATE parameters: – name: competencia in: query required: true type: string format: date – name: empresas in: query required: true type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 – name: filiais in: query type: array items: type: object allOf: – #/definitions/recFilial responses: 200: description: Ok schema: type: object required: – quantidade – percentual properties: quantidade: type: integer format: int64 description: Quantidade de filiais pendentes percentual: type: number format: double description: Percentual de filiais pendentes default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/queries/buscarValoresFiliaisPendentesContabil: post: description: Buscar quantidade e percentual de filiais pendentes de fechamento contábil tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competencia properties: competencia: type: string format: date description: Competência do fechamento empresas: type: array items: type: object allOf: – #/definitions/recEmpresa description: Lista de empresas filiais: type: array items: type: object allOf: – #/definitions/recFilial description: Lista de filiais responses: 200: description: Ok schema: type: object required: – quantidade – percentual properties: quantidade: type: integer format: int64 description: Quantidade de filiais pendentes percentual: type: number format: double description: Percentual de filiais pendentes default: description: Error response schema: #/definitions/genericError get: description: Buscar quantidade e percentual de filiais pendentes de fechamento contábil tags: – Queries x-senior-visibility: PRIVATE parameters: – name: competencia in: query required: true type: string format: date – name: empresas in: query type: array items: type: object allOf: – #/definitions/recEmpresa – name: filiais in: query type: array items: type: object allOf: – #/definitions/recFilial responses: 200: description: Ok schema: type: object required: – quantidade – percentual properties: quantidade: type: integer format: int64 description: Quantidade de filiais pendentes percentual: type: number format: double description: Percentual de filiais pendentes default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/queries/buscarEmpresasFechamento: post: description: Buscar empresas e sua situação de fechamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competencia properties: competencia: type: string format: date description: Competência do fechamento empresas: type: array items: type: object allOf: – #/definitions/recEmpresa description: Lista de empresas filiais: type: array items: type: object allOf: – #/definitions/recFilial description: Lista de filiais situacao: type: string allOf: – #/definitions/enumSituacao description: Situação de fechamento responses: 200: description: Ok schema: type: object required: – empresasFechamento properties: empresasFechamento: type: array items: type: object allOf: – #/definitions/recEmpresaFechamento minimum: 1 description: Retorna as empresas e sua situação de fechamento default: description: Error response schema: #/definitions/genericError get: description: Buscar empresas e sua situação de fechamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: competencia in: query required: true type: string format: date – name: empresas in: query type: array items: type: object allOf: – #/definitions/recEmpresa – name: filiais in: query type: array items: type: object allOf: – #/definitions/recFilial – name: situacao in: query type: string allOf: – #/definitions/enumSituacao responses: 200: description: Ok schema: type: object required: – empresasFechamento properties: empresasFechamento: type: array items: type: object allOf: – #/definitions/recEmpresaFechamento minimum: 1 description: Retorna as empresas e sua situação de fechamento default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/queries/buscarFiliaisFechamento: post: description: Buscar filiais e sua situação de fechamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competencia – empresa properties: competencia: type: string format: date description: Competência do fechamento empresa: type: object allOf: – #/definitions/recEmpresaFechamento description: Código de uma empresa filiais: type: array items: type: object allOf: – #/definitions/recFilial description: Lista de filiais situacao: type: string allOf: – #/definitions/enumSituacao description: Situação de fechamento responses: 200: description: Ok schema: type: object required: – filiaisFechamento properties: filiaisFechamento: type: array items: type: object allOf: – #/definitions/recFilialFechamento minimum: 1 description: Retorna as empresas e sua situação de fechamento default: description: Error response schema: #/definitions/genericError get: description: Buscar filiais e sua situação de fechamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: competencia in: query required: true type: string format: date – name: empresa in: query required: true type: object allOf: – #/definitions/recEmpresaFechamento – name: filiais in: query type: array items: type: object allOf: – #/definitions/recFilial – name: situacao in: query type: string allOf: – #/definitions/enumSituacao responses: 200: description: Ok schema: type: object required: – filiaisFechamento properties: filiaisFechamento: type: array items: type: object allOf: – #/definitions/recFilialFechamento minimum: 1 description: Retorna as empresas e sua situação de fechamento default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/queries/buscarProcessosFechamentoFiscal: post: description: Buscar processos de fechamento fiscal tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competencia – empresa – filial properties: competencia: type: string format: date description: Competência do fechamento empresa: type: object allOf: – #/definitions/recEmpresaFechamento description: Código de uma empresa filial: type: object allOf: – #/definitions/recFilial description: Código de uma filial responses: 200: description: Ok schema: type: object required: – processosFechamentoFiscal properties: processosFechamentoFiscal: type: array items: type: object allOf: – #/definitions/recProcessosFechamentoFiscal minimum: 1 description: Retorna os processos de fechamento fiscal com situação default: description: Error response schema: #/definitions/genericError get: description: Buscar processos de fechamento fiscal tags: – Queries x-senior-visibility: PRIVATE parameters: – name: competencia in: query required: true type: string format: date – name: empresa in: query required: true type: object allOf: – #/definitions/recEmpresaFechamento – name: filial in: query required: true type: object allOf: – #/definitions/recFilial responses: 200: description: Ok schema: type: object required: – processosFechamentoFiscal properties: processosFechamentoFiscal: type: array items: type: object allOf: – #/definitions/recProcessosFechamentoFiscal minimum: 1 description: Retorna os processos de fechamento fiscal com situação default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/queries/buscarProcessosFechamentoContabil: post: description: Buscar processos de fechamento contábil tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competencia – empresa – filial properties: competencia: type: string format: date description: Competência do fechamento empresa: type: object allOf: – #/definitions/recEmpresaFechamento description: Código de uma empresa filial: type: object allOf: – #/definitions/recFilial description: Código de uma filial responses: 200: description: Ok schema: type: object required: – processosFechamentoContabil properties: processosFechamentoContabil: type: array items: type: object allOf: – #/definitions/recProcessosFechamentoContabil minimum: 1 description: Retorna processos de fechamento contábil com situação default: description: Error response schema: #/definitions/genericError get: description: Buscar processos de fechamento contábil tags: – Queries x-senior-visibility: PRIVATE parameters: – name: competencia in: query required: true type: string format: date – name: empresa in: query required: true type: object allOf: – #/definitions/recEmpresaFechamento – name: filial in: query required: true type: object allOf: – #/definitions/recFilial responses: 200: description: Ok schema: type: object required: – processosFechamentoContabil properties: processosFechamentoContabil: type: array items: type: object allOf: – #/definitions/recProcessosFechamentoContabil minimum: 1 description: Retorna processos de fechamento contábil com situação default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/queries/buscarProcessosFiscal: post: description: Buscar processos de fechamento fiscal tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – processosFiscais properties: processosFiscais: type: array items: type: object allOf: – #/definitions/recProcessoFiscal minimum: 1 description: Retorna processos fiscais default: description: Error response schema: #/definitions/genericError get: description: Buscar processos de fechamento fiscal tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – processosFiscais properties: processosFiscais: type: array items: type: object allOf: – #/definitions/recProcessoFiscal minimum: 1 description: Retorna processos fiscais default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/queries/buscarProcessosContabil: post: description: Buscar processos de fechamento contábil tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – processosContabeis properties: processosContabeis: type: array items: type: object allOf: – #/definitions/recProcessoContabil minimum: 1 description: Retorna processos contábeis default: description: Error response schema: #/definitions/genericError get: description: Buscar processos de fechamento contábil tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – processosContabeis properties: processosContabeis: type: array items: type: object allOf: – #/definitions/recProcessoContabil minimum: 1 description: Retorna processos contábeis default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/queries/pesquisarEmpresa: post: description: Retorna empresas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Retorna uma lista de empresas default: description: Error response schema: #/definitions/genericError get: description: Retorna empresas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Retorna uma lista de empresas default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/queries/pesquisarFilial: post: description: Retorna filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Recebe uma lista de empresas responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Retorna uma lista de filiais default: description: Error response schema: #/definitions/genericError get: description: Retorna filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresas in: query required: true type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Retorna uma lista de filiais default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/queries/buscarParametros: post: description: Retorna os parâmetros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nomeParametro properties: nomeParametro: type: string description: Nome do parâmetro responses: 200: description: Ok schema: type: object required: – idParametro – parametros properties: idParametro: type: integer format: int64 description: Id da parametrização parametros: type: string description: Parâmetros para consulta default: description: Error response schema: #/definitions/genericError get: description: Retorna os parâmetros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nomeParametro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – idParametro – parametros properties: idParametro: type: integer format: int64 description: Id da parametrização parametros: type: string description: Parâmetros para consulta default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/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: 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 in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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 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: PUBLIC 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 default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/actions/incluirParametros: post: description: Incluir parâmetros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nomeParametro – parametros properties: nomeParametro: type: string description: Nome do parâmetro nomeVisao: type: string description: Nome da visão do parâmetro parametros: type: string description: Parâmetros de consulta responses: 200: description: Ok schema: type: object required: – idParametro – dummy properties: idParametro: type: integer format: int64 description: Id da parametrização incluída dummy: type: boolean description: (Parâmetro obsoleto) default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/actions/alterarParametros: post: description: Alterar parâmetros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idParametro – parametros properties: idParametro: type: integer format: int64 description: Id da parametrização nomeParametro: type: string description: Nome do parâmetro nomeVisao: type: string description: Nome da visão do parâmetro parametros: type: string description: Parâmetros de consulta responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: (Parâmetro obsoleto) default: description: Error response schema: #/definitions/genericError /gct_painelcontroladoria/actions/excluirParametros: post: description: Excluir parâmetros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idParametro properties: idParametro: type: integer format: int64 description: Parâmetros de entrada para consulta responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: (Parâmetro obsoleto) default: description: Error response schema: #/definitions/genericError definitions: enumSituacao: description: Situações para fechamento type: string enum: – Todos – Pendentes – Processando – Concluidos userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT recEmpresa: description: Estrutura de empresas type: object required: – codigoEmpresa – descricaoEmpresa properties: codigoEmpresa: type: integer format: int64 description: descricaoEmpresa: type: string description: recFilial: description: Estrutura de filiais type: object required: – codigoEmpresa – codigoFilial – descricaoFilial – filialMatriz properties: codigoEmpresa: type: integer format: int64 description: codigoFilial: type: integer format: int64 description: descricaoFilial: type: string description: filialMatriz: type: string description: recEmpresaFechamento: description: Estrutura para retornar a situação da empresa type: object required: – codigoEmpresa – nomeEmpresa – situacaoFiscal – situacaoContabil properties: codigoEmpresa: type: integer format: int64 description: nomeEmpresa: type: string description: situacaoFiscal: type: string allOf: – #/definitions/enumSituacao description: situacaoContabil: type: string allOf: – #/definitions/enumSituacao description: recFilialFechamento: description: Estrutura para retornar a situação da filial type: object required: – codigoFilial – nomeFilial – situacaoFiscal – situacaoContabil – filialMatriz properties: codigoFilial: type: integer format: int64 description: nomeFilial: type: string description: situacaoFiscal: type: string allOf: – #/definitions/enumSituacao description: situacaoContabil: type: string allOf: – #/definitions/enumSituacao description: filialMatriz: type: string description: recProcessosFechamentoFiscal: description: Estrutura para retornar a situação dos processos de fechamento fiscal type: object required: – nomeProcesso – situacaoProcesso – inicio – fim properties: nomeProcesso: type: string description: situacaoProcesso: type: string allOf: – #/definitions/enumSituacao description: inicio: type: integer format: int64 description: fim: type: integer format: int64 description: recProcessosFechamentoContabil: description: Estrutura para retornar a situação dos processos de fechamento contábil type: object required: – nomeProcesso – situacaoProcesso – inicio – fim properties: nomeProcesso: type: string description: situacaoProcesso: type: string allOf: – #/definitions/enumSituacao description: inicio: type: integer format: int64 description: fim: type: integer format: int64 description: recProcessoFiscal: description: Estrutura para retornar processo fiscal type: object required: – id – nome – descricao properties: id: type: integer format: int64 description: nome: type: string description: descricao: type: string description: recProcessoContabil: description: Estrutura para retornar processo contábil type: object required: – id – nome – descricao properties: id: type: integer format: int64 description: nome: type: string description: descricao: type: string description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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 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 description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment