Mais pesquisados:Customização, Tutorial, Documentação

gfi_painelfinancas

85 views 0 22/10/2018 Atualizado em 07/10/2021 integrador

2.0info: 12.2.0 gfi_painelfinancas description: Serviço para gerenciamento dos painéis financeiros x-senior-domain: erp_fin x-senior-domain-path: erp_fin x-senior-service-path: gfi_painelfinancas 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_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /gfi_painelfinancas/queries/pesquisarEmpresa: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: texto: type: string description: Texto livre para busca de empresa offset: type: integer format: int64 description: Offset a ser usado na paginação limit: type: integer format: int64 description: Número máximo de registros responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Listagem de empresa default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: texto description: Texto livre para busca de empresa in: query type: string – name: offset description: Offset a ser usado na paginação in: query type: integer format: int64 – name: limit description: Número máximo de registros in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Listagem de empresa default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/pesquisarFilial: post: description: Realiza a pesquisa de filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: texto: type: string description: Texto livre para busca empresaId: type: array items: type: integer format: int64 description: Filtro de empresa offset: type: integer format: int64 description: Offset a ser usado na paginação limit: type: integer format: int64 description: Número máximo de registros responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Lista das filiais default: description: Error response schema: #/definitions/genericError get: description: Realiza a pesquisa de filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: texto description: Texto livre para busca in: query type: string – name: empresaId description: Filtro de empresa in: query type: array items: type: integer format: int64 – name: offset description: Offset a ser usado na paginação in: query type: integer format: int64 – name: limit description: Número máximo de registros in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Lista das filiais default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/getResources: post: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – resources properties: resources: type: string description: Recursos fornecidos por este serviço no formato JSON. default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – resources properties: resources: type: string description: Recursos fornecidos por este serviço no formato JSON. default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterSaldoContasInternas: post: description: Retornar o Saldo das Contas Internas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrosPainel properties: parametrosPainel: type: object allOf: – #/definitions/recParametrosPainel description: Parametros Painel atualizarRegistros: type: boolean description: Atualizar registros dataAtualizacaoRegistros: type: string format: date-time description: Última data de atualização dos registros responses: 200: description: Ok schema: type: object required: – saldoContas – consolidadoSaldo – consolidadoDisponivel – dataHora – qtdeRegistros – moeda – atualizando properties: saldoContas: type: array items: type: object allOf: – #/definitions/recSaldoContas minimum: 1 description: Saldo Contas Internas consolidadoSaldo: type: number format: double description: Valor total contas internas consolidadoDisponivel: type: number format: double description: Valor Disponivel dataHora: type: string format: date-time description: Atualização dos dados qtdeRegistros: type: integer format: int64 description: Quantidade de registros moeda: type: string description: Sigla moeda atualizando: type: boolean description: Atualizando os registros default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterSaldoContasInternasAnalytics: post: description: Retornar o Saldo das Contas Internas do painel Analytics tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaAnalytics description: Empresas responses: 200: description: Ok schema: type: object required: – saldoContas – saldoDisponivel properties: saldoContas: type: array items: type: object allOf: – #/definitions/recSaldoContasAnalytics minimum: 1 description: Saldo Contas Internas saldoDisponivel: type: number format: double description: Saldo total contas internas default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterTitulosPorVencimentoReceber: post: description: Retornar os Titulos a receber por vencimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrosPainel properties: parametrosPainel: type: object allOf: – #/definitions/recParametrosPainel description: Parametros Painel parametrosAlterados: type: boolean description: Parametros alterados responses: 200: description: Ok schema: type: object required: – totalTitulos – dataHora – qtdeRegistros – moeda – atualizando properties: totalTitulos: type: array items: type: object allOf: – #/definitions/recTotalTitulos minimum: 1 description: Totalizador de Titulos por vencimento dataHora: type: string format: date-time description: Atualização dos dados qtdeRegistros: type: integer format: int64 description: Quantidade de registros moeda: type: string description: Sigla moeda atualizando: type: boolean description: Atualizando os registros default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterCRTitulosAVencerAnalytics: post: description: Retornar os títulos a vencer das contas a receber tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaAnalytics description: Empresas responses: 200: description: Ok schema: type: object required: – qtdeAVencer – vlrAVencer properties: qtdeAVencer: type: number format: double description: Quantidade de títulos a vencer vlrAVencer: type: number format: double description: Valor total dos títulos a vencer default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterCPTitulosAVencerAnalytics: post: description: Retornar os títulos a vencer das contas a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaAnalytics description: Empresas responses: 200: description: Ok schema: type: object required: – qtdeAVencer – vlrAVencer properties: qtdeAVencer: type: number format: double description: Quantidade de títulos a vencer vlrAVencer: type: number format: double description: Valor total dos títulos a vencer default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterCRTitulosVencidosAnalytics: post: description: Retornar os títulos vencidos das contas a receber tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaAnalytics description: Empresas responses: 200: description: Ok schema: type: object required: – qtdeVencidos – vlrOriginalVencidos – vlrCorrigidoVencidos properties: qtdeVencidos: type: number format: double description: Quantidade de títulos vencidos vlrOriginalVencidos: type: number format: double description: Valor original dos títulos vencidos vlrCorrigidoVencidos: type: number format: double description: Valor corrigido dos títulos vencidos default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterCPTitulosVencidosAnalytics: post: description: Retornar os títulos vencidos das contas a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaAnalytics description: Empresas responses: 200: description: Ok schema: type: object required: – qtdeVencidos – vlrOriginalVencidos – vlrCorrigidoVencidos properties: qtdeVencidos: type: number format: double description: Quantidade de títulos a vencer vlrOriginalVencidos: type: number format: double description: Valor total dos títulos a vencer vlrCorrigidoVencidos: type: number format: double description: Valor corrigido dos títulos vencidos default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterCalculoEficacia: post: description: Retornar calculo de Recuperação de títulos a receber em atraso (Eficacia) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrosPainel properties: parametrosPainel: type: object allOf: – #/definitions/recParametrosPainel description: Parametros Painel responses: 200: description: Ok schema: type: object required: – recuperacaoTitulos – dataHora – qtdeRegistros – atualizando properties: recuperacaoTitulos: type: array items: type: object allOf: – #/definitions/recRecuperacaoTitulos minimum: 1 description: Indices – Recuperação de titulos em atraso dataHora: type: string format: date-time description: Atualização dos dados qtdeRegistros: type: integer format: int64 description: Quantidade de registros atualizando: type: boolean description: Atualizando os registros default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterCalculoIrt: post: description: Calculo IRT – Indice de recebimento de títulos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrosPainel properties: parametrosPainel: type: object allOf: – #/definitions/recParametrosPainel description: Parametros Painel responses: 200: description: Ok schema: type: object required: – calcIRT – dataHora – qtdeRegistros – atualizando properties: calcIRT: type: array items: type: object allOf: – #/definitions/recCalcIRT minimum: 1 description: Calculo IRT dataHora: type: string format: date-time description: Atualização dos dados qtdeRegistros: type: integer format: int64 description: Quantidade de registros atualizando: type: boolean description: Atualizando os registros default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterRecebimentoClientes: post: description: Retorna realização de recebimento de clientes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrosPainel – atualizarRegistros properties: parametrosPainel: type: object allOf: – #/definitions/recParametrosPainel description: Parametros Painel atualizarRegistros: type: boolean description: Atualizar registros dataAtualizacaoRegistros: type: string format: date-time description: Última data de atualização dos registros responses: 200: description: Ok schema: type: object required: – totalPrevRealiz – dataHora – qtdeRegistros – moeda – atualizando properties: totalPrevRealiz: type: array items: type: object allOf: – #/definitions/recTotalPrevRealiz minimum: 1 description: Recebimento Previsto x Realizado dataHora: type: string format: date-time description: Atualização dos dados qtdeRegistros: type: integer format: int64 description: Quantidade de registros moeda: type: string description: Sigla da moeda atualizando: type: boolean description: Atualizando os registros default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterTitulosPorVencimentoPagar: post: description: Retornar titulos a pagar por vencimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrosPainel properties: parametrosPainel: type: object allOf: – #/definitions/recParametrosPainel description: Parametros Painel parametrosAlterados: type: boolean description: Parametros alterados responses: 200: description: Ok schema: type: object required: – totalTitulos – dataHora – qtdeRegistros – moeda – atualizando properties: totalTitulos: type: array items: type: object allOf: – #/definitions/recTotalTitulos minimum: 1 description: Totalizador de Titulos por vencimento dataHora: type: string format: date-time description: Atualização dos dados qtdeRegistros: type: integer format: int64 description: Quantidade de registros moeda: type: string description: Sigla moeda atualizando: type: boolean description: Atualizando os registros default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterPagamentoFornecedores: post: description: Retornar Pagamento de Fornecedores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrosPainel – atualizarRegistros properties: parametrosPainel: type: object allOf: – #/definitions/recParametrosPainel description: Parametros Painel atualizarRegistros: type: boolean description: Atualizar registros dataAtualizacaoRegistros: type: string format: date-time description: Última data de atualização dos registros responses: 200: description: Ok schema: type: object required: – totalPrevRealiz – dataHora – qtdeRegistros – moeda – atualizando properties: totalPrevRealiz: type: array items: type: object allOf: – #/definitions/recTotalPrevRealiz minimum: 1 description: Pagamento Previsto x Realizado dataHora: type: string format: date-time description: Atualização dos dados qtdeRegistros: type: integer format: int64 description: Quantidade de registros moeda: type: string description: Sigla moeda atualizando: type: boolean description: Atualizando os registros default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterRecebimentoClientesAnalytics: post: description: Retorna o recebimento dos clientes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresaId: type: array items: type: integer format: int64 description: ID da empresa filialId: type: array items: type: integer format: int64 description: ID da filial responses: 200: description: Ok schema: type: object required: – recebimentoClientes properties: recebimentoClientes: type: object allOf: – #/definitions/recRecebimentoClientesAnalytics description: Recebimento de clientes default: description: Error response schema: #/definitions/genericError get: description: Retorna o recebimento dos clientes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: ID da empresa in: query type: array items: type: integer format: int64 – name: filialId description: ID da filial in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – recebimentoClientes properties: recebimentoClientes: type: object allOf: – #/definitions/recRecebimentoClientesAnalytics description: Recebimento de clientes default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterAgrupamentosFilial: post: description: Retornar os agrupamentos cadastros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigoEmpresa: type: array items: type: integer format: int64 description: Recebe os códigos das empresas selecionadas responses: 200: description: Ok schema: type: object required: – agrupamentosFilial – totalRegistros properties: agrupamentosFilial: type: array items: type: object allOf: – #/definitions/recAgrupamentoFilial minimum: 1 description: Retornar uma lista de agrupamentos. Deverá retornar ordenados por:\n agrupamentofilial.empresa_id, agrupamentofilial.agrupamento totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError get: description: Retornar os agrupamentos cadastros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa description: Recebe os códigos das empresas selecionadas in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – agrupamentosFilial – totalRegistros properties: agrupamentosFilial: type: array items: type: object allOf: – #/definitions/recAgrupamentoFilial minimum: 1 description: Retornar uma lista de agrupamentos. Deverá retornar ordenados por:\n agrupamentofilial.empresa_id, agrupamentofilial.agrupamento totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterFiliaisAgrupamento: post: description: Retornar as filias por agrupamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigoAgrupamento: type: array items: type: integer format: int64 description: Recebe os códigos dos agrupamentos selecionados responses: 200: description: Ok schema: type: object required: – filial – totalRegistros properties: filial: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Retornar uma lista de filiais. Deverá retornar ordenados por:\n filial.empresa_id, filial.filial totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError get: description: Retornar as filias por agrupamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoAgrupamento description: Recebe os códigos dos agrupamentos selecionados in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – filial – totalRegistros properties: filial: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Retornar uma lista de filiais. Deverá retornar ordenados por:\n filial.empresa_id, filial.filial totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterFiliaisEmpresa: post: description: Retornar as filias por empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigoEmpresa: type: array items: type: integer format: int64 description: Recebe os códigos das empresas selecionadas responses: 200: description: Ok schema: type: object required: – filial – totalRegistros properties: filial: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Retornar uma lista de filiais.Deverá retornar ordenados por:\n filial.empresa_id, filial.filial totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError get: description: Retornar as filias por empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa description: Recebe os códigos das empresas selecionadas in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – filial – totalRegistros properties: filial: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Retornar uma lista de filiais.Deverá retornar ordenados por:\n filial.empresa_id, filial.filial totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterEmpresas: post: description: Retorna as empresas. Se os parâmetros não forem informados serão retornadas até 10 empresas a partir da primeira\n (ordenada pelo id). tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – listaEmpresas – totalRegistros properties: listaEmpresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Retorna uma lista de empresas. Deverá retornar ordenados por:\n empresa.id totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError get: description: Retorna as empresas. Se os parâmetros não forem informados serão retornadas até 10 empresas a partir da primeira\n (ordenada pelo id). tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – listaEmpresas – totalRegistros properties: listaEmpresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Retorna uma lista de empresas. Deverá retornar ordenados por:\n empresa.id totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterPermissoesParametros: post: description: Obter as regras de parâmetros do usuário para utilizar a tela de parâmetros tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – geral – outros properties: geral: type: boolean description: Permissão para acessar todos os campos outros: type: boolean description: Permissão para acessar apenas a empresa, agrupamento e filial default: description: Error response schema: #/definitions/genericError get: description: Obter as regras de parâmetros do usuário para utilizar a tela de parâmetros tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – geral – outros properties: geral: type: boolean description: Permissão para acessar todos os campos outros: type: boolean description: Permissão para acessar apenas a empresa, agrupamento e filial default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterPermissoesCards: post: description: Obter as regras de parâmetros do usuário para utilizar os cards tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – saldoContas – indiceRecebimento – titulosReceber – recebimentoClientes – pagamentoFornecedores – titulosPagar – recuperacaoTitulos properties: saldoContas: type: boolean description: indiceRecebimento: type: boolean description: titulosReceber: type: boolean description: recebimentoClientes: type: boolean description: pagamentoFornecedores: type: boolean description: titulosPagar: type: boolean description: recuperacaoTitulos: type: boolean description: default: description: Error response schema: #/definitions/genericError get: description: Obter as regras de parâmetros do usuário para utilizar os cards tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – saldoContas – indiceRecebimento – titulosReceber – recebimentoClientes – pagamentoFornecedores – titulosPagar – recuperacaoTitulos properties: saldoContas: type: boolean description: indiceRecebimento: type: boolean description: titulosReceber: type: boolean description: recebimentoClientes: type: boolean description: pagamentoFornecedores: type: boolean description: titulosPagar: type: boolean description: recuperacaoTitulos: type: boolean description: default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterDiaUtilDataBase: post: description: Obter o próximo dia útil data base tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataBase properties: dataBase: type: string format: date description: filialId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – dataBase properties: dataBase: type: string format: date description: default: description: Error response schema: #/definitions/genericError get: description: Obter o próximo dia útil data base tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dataBase description: in: query required: true type: string format: date – name: filialId description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – dataBase properties: dataBase: type: string format: date description: default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/obterSeMoedasDiferentes: post: description: Obter se há empresas com diferentes moedas selecionadas 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: responses: 200: description: Ok schema: type: object required: – diferente properties: diferente: type: boolean description: default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE 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 default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE 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 default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/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 description: 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 /gfi_painelfinancas/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 /gfi_painelfinancas/actions/montarPagamentoFornecedores: post: description: Monta os pagamentos de fornecedores conforme payload passado.\n As datas de pagamento deverão estar entre os primeiros 15 dias anteriores a data atual e até os 14 dias posteriores a data atual\n Ex.: Data atual: 05/06/2018\n Deverão ser passadas as seguintes datas no payload:\n 21/05/2018\n 22/05/2018\n 23/05/2018\n 24/05/2018\n 25/05/2018\n 26/05/2018\n 27/05/2018\n 28/05/2018\n 29/05/2018\n 30/05/2018\n 31/05/2018\n 01/06/2018\n 02/06/2018\n 03/06/2018\n 04/06/2018\n 05/06/2018\n 06/06/2018\n 07/06/2018\n 08/06/2018\n 09/06/2018\n 10/06/2018\n 11/06/2018\n 12/06/2018\n 13/06/2018\n 14/06/2018\n 15/06/2018\n 16/06/2018\n 17/06/2018\n 18/06/2018\n 19/06/2018\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagamentos properties: pagamentos: type: array items: type: object allOf: – #/definitions/recPagamentosRecebimentos minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/actions/montarRecebimentoClientes: post: description: Monta os recebimentos de clientes conforme payload passado.\n As datas de recebimento deverão estar entre os primeiros 15 dias anteriores a data atual e até os 14 dias posteriores a data atual\n Ex.: Data atual: 05/06/2018\n Deverão ser passadas as seguintes datas no payload:\n 21/05/2018\n 22/05/2018\n 23/05/2018\n 24/05/2018\n 25/05/2018\n 26/05/2018\n 27/05/2018\n 28/05/2018\n 29/05/2018\n 30/05/2018\n 31/05/2018\n 01/06/2018\n 02/06/2018\n 03/06/2018\n 04/06/2018\n 05/06/2018\n 06/06/2018\n 07/06/2018\n 08/06/2018\n 09/06/2018\n 10/06/2018\n 11/06/2018\n 12/06/2018\n 13/06/2018\n 14/06/2018\n 15/06/2018\n 16/06/2018\n 17/06/2018\n 18/06/2018\n 19/06/2018\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – recebimentos properties: recebimentos: type: array items: type: object allOf: – #/definitions/recPagamentosRecebimentos minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/actions/montarRecebimentoClientesAnalytics: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – recebimentos properties: recebimentos: type: array items: type: object allOf: – #/definitions/recPagamentosRecebimentos minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/actions/montarSaldosContasInternas: post: description: Monta os saldos das contas internas conforme payload passado. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – saldos properties: saldos: type: array items: type: object allOf: – #/definitions/recSaldoContaInterna minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/actions/montarIndiceRecebimentoTitulos: post: description: Monta os índices de recebimentos conforme payload passado. Deverá ser passado os valores dos 12 meses anteriores ao mês atual tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – indices properties: indices: type: array items: type: object allOf: – #/definitions/recIndiceRecebimentoTitulos minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/actions/montarVencimentosTitulosReceber: post: description: Monta os valores de títulos a receber por vencimento conforme payload passado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vencimentos properties: vencimentos: type: array items: type: object allOf: – #/definitions/recVencimentosTitulos minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/actions/montarVencimentosTitulosPagar: post: description: Monta os valores de títulos a pagar por vencimento conforme payload passado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vencimentos properties: vencimentos: type: array items: type: object allOf: – #/definitions/recVencimentosTitulos minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/actions/montarRecuperacaoTitulosAtraso: post: description: Monta os valores de títulos em atraso por indice conforme payload passado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – valoresAtraso properties: valoresAtraso: type: array items: type: object allOf: – #/definitions/recRecuperacaoTitulosAtraso minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/signals/atualizarCardSaldoContaInterna: post: description: Gerar a atualização do card de saldo de contas internas.\n Esse signal deverá ser invocado manualmente ou via agendador tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: forcarAtualizacao: type: boolean description: Caso já exista uma atualização em andamento e esse parâmetro receber o valor igual a true,\n será forçado uma nova atualização imediatamente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/signals/atualizarCardPagamentoFornecedores: post: description: Gerar a atualização do card de pagamento de fornecedores.\n Esse signal deverá ser invocado manualmente ou via agendador tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: forcarAtualizacao: type: boolean description: Caso já exista uma atualização em andamento e esse parâmetro receber o valor igual a true,\n será forçado uma nova atualização imediatamente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/signals/atualizarCardRecebimentoClientes: post: description: Gerar a atualização do card de recebimento de clientes.\n Esse signal deverá ser invocado manualmente ou via agendador tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: forcarAtualizacao: type: boolean description: Caso já exista uma atualização em andamento e esse parâmetro receber o valor igual a true,\n será forçado uma nova atualização imediatamente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/signals/atualizarCardIndiceRecebimentoClientes: post: description: Gerar a atualização do card de índice de recebimento de clientes.\n Esse signal deverá ser invocado manualmente ou via agendador tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: forcarAtualizacao: type: boolean description: Caso já exista uma atualização em andamento e esse parâmetro receber o valor igual a true,\n será forçado uma nova atualização imediatamente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/signals/atualizarCardIndicesTitulosEmAtraso: post: description: Gerar a atualização do card de índice de títulos em atraso.\n Esse signal deverá ser invocado manualmente ou via agendador tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: forcarAtualizacao: type: boolean description: Caso já exista uma atualização em andamento e esse parâmetro receber o valor igual a true,\n será forçado uma nova atualização imediatamente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/signals/atualizarCardFinanceiroContasPagar: post: description: Gerar a atualização do card de títulos a pagar (volumes por vencimento).\n Esse signal deverá ser invocado manualmente ou via agendador tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: forcarAtualizacao: type: boolean description: Caso já exista uma atualização em andamento e esse parâmetro receber o valor igual a true,\n será forçado uma nova atualização imediatamente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/signals/atualizarCardFinanceiroContasReceber: post: description: Gerar a atualização do card de títulos a receber (volumes por vencimento).\n Esse signal deverá ser invocado manualmente ou via agendador tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: forcarAtualizacao: type: boolean description: Caso já exista uma atualização em andamento e esse parâmetro receber o valor igual a true,\n será forçado uma nova atualização imediatamente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/signals/atualizarCards: post: description: Gerar a atualização dos cards:\n * Pagamento de fornecedores;\n * Recebimento de clientes;\n * Índice de recebimento de clientes;\n * Índice de títulos em atraso;\n * Índice de títulos a vencer;\n * Índice de títulos vencidos;\n * Títulos a pagar (volumes por vencimento);\n * Títulos a receber (volumes por vencimento); tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: forcarAtualizacao: type: boolean description: Caso já exista uma atualização em andamento e esse parâmetro receber o valor igual a true,\n será forçado uma nova atualização imediatamente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/entities/entParametros: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entParametros responses: 200: description: The created resource schema: #/definitions/entParametros default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entParametros responses: 200: description: The created resource schema: #/definitions/entParametros default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entParametros default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/entities/entParametros/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entParametros responses: 200: description: Ok schema: #/definitions/entParametros default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entParametros responses: 200: description: Ok schema: #/definitions/entParametros default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entParametros default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gfi_painelfinancas/entities/entParametros/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entParametros responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN 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 recPagina: description: type: object recAgrupamentoFilial: description: type: object properties: codigoAgrupamento: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/recEmpresa description: codigo: type: integer format: int64 description: descricao: type: string description: recFilial: description: type: object required: – id – codigoEmpresa properties: id: type: integer format: int64 description: codigoEmpresa: type: object allOf: – #/definitions/recEmpresa description: codigoFilial: type: integer format: int64 description: agrupamento: type: object allOf: – #/definitions/recAgrupamentoFilial description: nome: type: string description: cidade: type: string description: estado: type: string description: recEmpresa: description: type: object required: – id properties: id: type: integer format: int64 description: nomeFantasia: type: string description: siglaMoeda: type: string description: recRecuperacaoTitulos: description: type: object required: – descricao – meta – percentual – cor properties: descricao: type: string description: IAG – IAP – IC meta: type: number format: double description: Meta informada na tela de parametros percentual: type: number format: double description: Percentual calculado cor: type: string description: Cor do indice para mostrar no card de acordo com a meta Verde – #0C9348 | Amarelo – #FCBF10 | Vermelho – #C13018 recParametros: description: type: object required: – rotina – visao – dados properties: rotina: type: string description: Identificador da rotina (painel finanças) visao: type: string description: Nome da visão (por enquanto em branco) dados: type: string description: JSON com as informações da tela dadosUsuario: type: string description: usarDadosUsuario: type: boolean description: dataGeracao: type: string format: date-time description: usuarioGeracao: type: string description: dataAlteracao: type: string format: date-time description: usuarioAlteracao: type: string description: usuario: type: array items: type: object allOf: – #/definitions/recUsuario description: atualizarRegistros: type: boolean description: dataAtualizacaoRegistros: type: string format: date-time description: recUsuario: description: type: object required: – paramRotinaId – usuario properties: paramRotinaId: type: integer format: int64 description: Id da tabela financas_param_rotina usuario: type: string description: Identificação do usuario dataGeracao: type: string format: date-time description: usuarioGeracao: type: string description: dataAlteracao: type: string format: date-time description: usuarioAlteracao: type: string description: recParametrosPainel: description: type: object required: – empresa – filial – disponivel properties: usuario: type: string description: Identificação do usuario empresa: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Empresa filial: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Filial agrupamento: type: array items: type: object allOf: – #/definitions/recAgrupamentoFilial description: Agrupamento exibirIag: type: boolean description: Exibir indice IAG – indice de atraso geral metaIag: type: number format: double description: Percentual da Meta IAG (%) exibirIap: type: boolean description: Exibir indice IAP – indice de atraso parcial metaIap: type: number format: double description: Percentual da Meta IAP (%) periodoCalcIap: type: integer format: int64 description: Periodo de Calculo de dias 30, 60 ou 90 dias exibirIc: type: boolean description: Exibir indice IC – indice contencioso metaIc: type: number format: double description: Percentual da Meta IC (%) disponivel: type: boolean description: Disponivel dataBase: type: string format: date description: Data base para inserir e buscar registros atualizar: type: boolean description: atualizar recSaldoContas: description: type: object required: – descConta – descTipConta – numeroConta – empresaId – descricao – codMoeda – vlrSdoConta – vlrLimConta – mostrar – contaDisponivel properties: descConta: type: string description: Descrição da Conta descTipConta: type: string description: Descrição do Tipo da Conta numeroConta: type: string description: Número conta empresaId: type: integer format: int64 description: Empresa descricao: type: string description: Descrição codMoeda: type: string description: Moeda da Conta vlrSdoConta: type: number format: double description: Saldo da Conta vlrLimConta: type: number format: double description: Limite da Conta mostrar: type: boolean description: Mostra asterisco do lado da conta contaDisponivel: type: boolean description: Conta do tipo Conta Corrente, Poupança e Aplicação recTotalTitulos: description: type: object required: – descricao – qtdeVencidos – vlrTitulosVencidos – vlrTitulosVencidosCor – qtdeTitulosAVencer – vlrTitulosAVencer – vlrTitulosAVencerCor properties: descricao: type: string description: Descrição – 1 a 30 dias | 31 a 60 dias | 61 a 90 dias | mais que 90 dias qtdeVencidos: type: integer format: int64 description: Quantidade de titulos vencidos vlrTitulosVencidos: type: number format: double description: Valor total de titulos vencidos vlrTitulosVencidosCor: type: number format: double description: Valor total de titulos vencidos corrigidos qtdeTitulosAVencer: type: integer format: int64 description: Quantidade de titulos a vencer vlrTitulosAVencer: type: number format: double description: Valor Total de titulos a vencer vlrTitulosAVencerCor: type: number format: double description: Valor Total de titulos a vencer corrigidos recSaldoContasAnalytics: description: type: object required: – descConta – descTipConta – numeroConta – empresaId – nomeEmpresa – codMoeda – vlrSdoConta – vlrLimConta – vlrConciliado – vlrPendenteConciliacao – saldoDisponivel – moeda properties: descConta: type: string description: Descrição da Conta descTipConta: type: string description: Descrição do Tipo da Conta numeroConta: type: string description: Número conta empresaId: type: integer format: int64 description: Empresa nomeEmpresa: type: string description: Nome Empresa codMoeda: type: string description: Moeda da Conta vlrSdoConta: type: number format: double description: Saldo da Conta vlrLimConta: type: number format: double description: Limite da Conta vlrConciliado: type: number format: double description: Valor Conciliado vlrPendenteConciliacao: type: number format: double description: Valor pendente de conciliação saldoDisponivel: type: number format: double description: Saldo disponível moeda: type: string description: Moeda recRecebimentoClientesAnalytics: description: type: object required: – qtdTitulos30dias – valor30dias – qtdTitulos60dias – valor60dias – qtdTitulos90dias – valor90dias – qtdTitulos120dias – valor120dias properties: qtdTitulos30dias: type: integer format: int64 description: Quantidade de Titulos Realizados de 1 a 30 dias valor30dias: type: number format: double description: Valor Realizado de 1 a 30 dias qtdTitulos60dias: type: integer format: int64 description: Quantidade de Titulos Realizados de 31 a 60 dias valor60dias: type: number format: double description: Valor Realizado de 31 a 60 dias qtdTitulos90dias: type: integer format: int64 description: Quantidade de Titulos Realizados de 61 a 90 dias valor90dias: type: number format: double description: Valor Realizado de 61 a 90 dias qtdTitulos120dias: type: integer format: int64 description: Quantidade de Titulos Realizados de 91 a 120 dias valor120dias: type: number format: double description: Valor Realizado de 91 a 120 dias recTotalPrevRealiz: description: type: object required: – vlrPrevisto – qtdetituloprev – vlrRealizado – qtdetitulorealiz – data properties: vlrPrevisto: type: number format: double description: Valor Previsto qtdetituloprev: type: integer format: int64 description: Quantidade de titulos previstos vlrRealizado: type: number format: double description: Valor Realizado qtdetitulorealiz: type: integer format: int64 description: Quantidade de titulos realizados data: type: string description: Data recCalcIRT: description: type: object required: – percIrt – periodo properties: percIrt: type: number format: double description: Percentual IRT Calculado periodo: type: string description: Mês/Ano de calculo recPagamentosRecebimentos: description: type: object required: – empresaId – filialId – valores properties: empresaId: type: integer format: int64 description: Código da empresa filialId: type: integer format: int64 description: Código da filial valores: type: array items: type: object allOf: – #/definitions/recValoresPagamentoRecebimentos minimum: 1 description: Valores dos respectivos pagamentos recValoresPagamentoRecebimentos: description: type: object required: – dataPagamentoRecebimento – valoresTitulosPrevistos – quantidadeTitulosPrevistos – valoresTitulosRealizados – quantidadeTitulosRealizados properties: dataPagamentoRecebimento: type: string format: date description: Data de pagamento valoresTitulosPrevistos: type: string description: Total de títulos previstos no período quantidadeTitulosPrevistos: type: integer format: int64 description: Quantidade de títulos previstos no período valoresTitulosRealizados: type: string description: Total de títulos pagos no período quantidadeTitulosRealizados: type: integer format: int64 description: Quantidade de títulos pagos no período recSaldoContaInterna: description: type: object required: – empresaId – filialId – contaInternaId – saldoConta – limiteCredito – mostrar – ordenacao – consideraSaldoDisponivel properties: empresaId: type: integer format: int64 description: Código da empresa filialId: type: integer format: int64 description: Código da filial contaInternaId: type: integer format: int64 description: Código da conta interna saldoConta: type: string description: Data do saldo da conta interna limiteCredito: type: string description: Valor do limite de crédito mostrar: type: boolean description: Indicativo se o saldo da conta ordenacao: type: integer format: int64 description: Indicativo da ordem de apresentação da conta interna na listagem consideraSaldoDisponivel: type: boolean description: Indicativo se o saldo da conta interna será considerado nos valores disponíveis recIndiceRecebimentoTitulos: description: type: object required: – empresaId – filialId – valores properties: empresaId: type: integer format: int64 description: Código da empresa filialId: type: integer format: int64 description: Código da filial valores: type: array items: type: object allOf: – #/definitions/recValoresIndiceRecebimentosTitulos minimum: 1 description: Valores para cálculo dos índices recValoresIndiceRecebimentosTitulos: description: type: object required: – dataPeriodo – valorRecebido – valorAbertoPeriodo properties: dataPeriodo: type: string format: date description: Data do período valorRecebido: type: string description: Valor total recebido dos clientes no período valorAbertoPeriodo: type: string description: Valor total em aberto a receber dos clientes no período recVencimentosTitulos: description: type: object required: – empresaId – filialId – periodos properties: empresaId: type: integer format: int64 description: Código da empresa filialId: type: integer format: int64 description: Código da filial periodos: type: object allOf: – #/definitions/recPeriodosVencimentosTitulos description: recPeriodosVencimentosTitulos: description: type: object required: – entreUmETrintaDias – entreTrintaESessentaDias – entreSessentaENovamentaDias – maiorQueNoventaDias properties: entreUmETrintaDias: type: object allOf: – #/definitions/recValoresVencimentosTitulos description: Período de 1 a 30 dias entreTrintaESessentaDias: type: object allOf: – #/definitions/recValoresVencimentosTitulos description: Período de 31 a 60 dias entreSessentaENovamentaDias: type: object allOf: – #/definitions/recValoresVencimentosTitulos description: Período de 61 a 90 dias maiorQueNoventaDias: type: object allOf: – #/definitions/recValoresVencimentosTitulos description: Período maior que 90 dias recValoresVencimentosTitulos: description: type: object required: – quantidadeTitulosAVencer – totalTitulosAVencer – totalTitulosAVencerCorrigidos – quantidadeTitulosVencidos – totalTitulosVencidos – totalTitulosVencidosCorrigidos properties: quantidadeTitulosAVencer: type: integer format: int64 description: Quantidade de títulos a vencer no período totalTitulosAVencer: type: string description: Valor total de títulos a vencer no período totalTitulosAVencerCorrigidos: type: string description: Valor total de títulos a vencer no período corrigidos quantidadeTitulosVencidos: type: integer format: int64 description: Quantidade de títulos vencidos no período totalTitulosVencidos: type: string description: Valor total de títulos vencidos no período totalTitulosVencidosCorrigidos: type: string description: Valor total de títulos vencidos no período corrigidos recRecuperacaoTitulosAtraso: description: type: object required: – empresaId – filialId – IAG – IAP – IC properties: empresaId: type: integer format: int64 description: filialId: type: integer format: int64 description: IAG: type: object allOf: – #/definitions/recValoresRecuperacaoTitulos description: IAP: type: object allOf: – #/definitions/recValoresRecuperacaoTitulos description: IC: type: object allOf: – #/definitions/recValoresRecuperacaoTitulos description: recValoresRecuperacaoTitulos: description: type: object required: – valorAbertoPeriodo – valorTotalEmAberto properties: valorAbertoPeriodo: type: string description: valorTotalEmAberto: type: string description: recEmpresaAnalytics: description: Dados da Empresa com suas Filiais do Analytics type: object required: – codigo properties: codigo: type: string maxLength: 4 description: Código codigosFiliais: type: array items: type: string description: Filiais da emrpesa 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 entParametros: description: Parametros type: object required: – parametros properties: id: type: integer format: int64 description: parametros: type: object allOf: – #/definitions/recParametros description: 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. 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
Mais pesquisados:Customização, Tutorial, Documentação